SendAnimationRequest

data class SendAnimationRequest(chatId: Int, animation: String, duration: Int?, width: Int?, height: Int?, thumb: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendAnimation

Parameters

chatId

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

animation

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

Duration of sent animation in seconds

width

Animation width

height

Animation height

thumb

Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. 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

Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing

parseMode

Mode for parsing entities in the animation caption. See formatting options for more details.

captionEntities

List of special entities that appear in the caption, which can be specified instead of parse_mode

disableNotification

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

replyToMessageId

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

allowSendingWithoutReply

Pass True, if the message should be sent even if the specified replied-to message is not found

replyMarkup

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.

Constructors

SendAnimationRequest
Link copied to clipboard
common
fun SendAnimationRequest(chatId: Int, animation: String, duration: Int? = null, width: Int? = null, height: Int? = null, thumb: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null)
Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Functions

component1
Link copied to clipboard
common
operator fun component1(): Int
component10
Link copied to clipboard
common
operator fun component10(): Boolean
component11
Link copied to clipboard
common
operator fun component11(): Int?
component12
Link copied to clipboard
common
operator fun component12(): Boolean
component13
Link copied to clipboard
common
operator fun component13(): ReplyMarkup?
component2
Link copied to clipboard
common
operator fun component2(): String
component3
Link copied to clipboard
common
operator fun component3(): Int?
component4
Link copied to clipboard
common
operator fun component4(): Int?
component5
Link copied to clipboard
common
operator fun component5(): Int?
component6
Link copied to clipboard
common
operator fun component6(): String?
component7
Link copied to clipboard
common
operator fun component7(): String?
component8
Link copied to clipboard
common
operator fun component8(): String?
component9
Link copied to clipboard
common
operator fun component9(): List<MessageEntity>
copy
Link copied to clipboard
common
fun copy(chatId: Int, animation: String, duration: Int? = null, width: Int? = null, height: Int? = null, thumb: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): SendAnimationRequest
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

allowSendingWithoutReply
Link copied to clipboard
common
val allowSendingWithoutReply: Boolean = false
Pass True, if the message should be sent even if the specified replied-to message is not found
animation
Link copied to clipboard
common
val animation: String
Animation to send.
caption
Link copied to clipboard
common
val caption: String? = null
Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
captionEntities
Link copied to clipboard
common
val captionEntities: List<MessageEntity>
List of special entities that appear in the caption, which can be specified instead of parse_mode
chatId
Link copied to clipboard
common
val chatId: Int
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification
Link copied to clipboard
common
val disableNotification: Boolean = false
Sends the message silently.
duration
Link copied to clipboard
common
val duration: Int? = null
Duration of sent animation in seconds
height
Link copied to clipboard
common
val height: Int? = null
Animation height
parseMode
Link copied to clipboard
common
val parseMode: String? = null
Mode for parsing entities in the animation caption.
replyMarkup
Link copied to clipboard
common
val replyMarkup: ReplyMarkup? = null
Additional interface options.
replyToMessageId
Link copied to clipboard
common
val replyToMessageId: Int? = null
If the message is a reply, ID of the original message
thumb
Link copied to clipboard
common
val thumb: String? = null
Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
width
Link copied to clipboard
common
val width: Int? = null
Animation width