Class

com.bot4s.telegram.methods

SendAnimation

Related Doc: package methods

Permalink

case class SendAnimation(chatId: ChatId, animation: InputFile, duration: Option[Int] = None, width: Option[Int] = None, height: Option[Int] = None, thumb: Option[InputFile] = None, caption: Option[String] = None, parseMode: Option[ParseMode] = None, disableNotification: Option[Boolean] = None, replyToMessageId: Option[Int], replyMarkup: Option[ReplyMarkup] = None) extends MultipartRequest[Message] with Product with Serializable

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

chatId

Integer or String Yes Unique identifier for the target chat or username of the target channel (in the format @channelusername)

animation

InputFile or String Yes Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More info on Sending Files »

duration

Integer Optional Duration of sent animation in seconds

width

Integer Optional Animation width

height

Integer Optional Animation height

thumb

InputFile or String Optional Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »

caption

String Optional Animation caption (may also be used when resending animation by file_id), 0-200 characters

parseMode

String Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.

disableNotification

Boolean Optional Sends the message silently. Users will receive a notification with no sound.

replyToMessageId

Integer Optional If the message is a reply, ID of the original message

replyMarkup

InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Optional Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Linear Supertypes
Serializable, Serializable, Product, Equals, MultipartRequest[Message], Request[Message], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SendAnimation
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. MultipartRequest
  7. Request
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SendAnimation(chatId: ChatId, animation: InputFile, duration: Option[Int] = None, width: Option[Int] = None, height: Option[Int] = None, thumb: Option[InputFile] = None, caption: Option[String] = None, parseMode: Option[ParseMode] = None, disableNotification: Option[Boolean] = None, replyToMessageId: Option[Int], replyMarkup: Option[ReplyMarkup] = None)

    Permalink

    chatId

    Integer or String Yes Unique identifier for the target chat or username of the target channel (in the format @channelusername)

    animation

    InputFile or String Yes Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More info on Sending Files »

    duration

    Integer Optional Duration of sent animation in seconds

    width

    Integer Optional Animation width

    height

    Integer Optional Animation height

    thumb

    InputFile or String Optional Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »

    caption

    String Optional Animation caption (may also be used when resending animation by file_id), 0-200 characters

    parseMode

    String Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.

    disableNotification

    Boolean Optional Sends the message silently. Users will receive a notification with no sound.

    replyToMessageId

    Integer Optional If the message is a reply, ID of the original message

    replyMarkup

    InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Optional Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val animation: InputFile

    Permalink

    InputFile or String Yes Animation to send.

    InputFile or String Yes Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More info on Sending Files »

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val caption: Option[String]

    Permalink

    String Optional Animation caption (may also be used when resending animation by file_id), 0-200 characters

  7. val chatId: ChatId

    Permalink

    Integer or String Yes Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val disableNotification: Option[Boolean]

    Permalink

    Boolean Optional Sends the message silently.

    Boolean Optional Sends the message silently. Users will receive a notification with no sound.

  10. val duration: Option[Int]

    Permalink

    Integer Optional Duration of sent animation in seconds

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getFiles: List[(String, InputFile)]

    Permalink
    Definition Classes
    SendAnimationMultipartRequest
  15. val height: Option[Int]

    Permalink

    Integer Optional Animation height

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def methodName: String

    Permalink

    Extract request URL from class name.

    Extract request URL from class name.

    Definition Classes
    Request
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. val parseMode: Option[ParseMode]

    Permalink

    String Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.

  22. val replyMarkup: Option[ReplyMarkup]

    Permalink

    InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Optional Additional interface options.

    InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Optional Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  23. val replyToMessageId: Option[Int]

    Permalink

    Integer Optional If the message is a reply, ID of the original message

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. val thumb: Option[InputFile]

    Permalink

    InputFile or String Optional Thumbnail of the file sent.

    InputFile or String Optional Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. val width: Option[Int]

    Permalink

    Integer Optional Animation width

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from MultipartRequest[Message]

Inherited from Request[Message]

Inherited from AnyRef

Inherited from Any

Ungrouped