class InputMediaAnimation implements InputMediaInterface

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

Methods

__construct(string $type, string $media, InputFileInterface|string|null $thumb = null, string|null $caption = null, string|null $parse_mode = null, MessageEntity[]|null $caption_entities = null, int|null $width = null, int|null $height = null, int|null $duration = null)

No description

string
getType()

Type of the result, must be animation.

string
getMedia()

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».

InputFileInterface|string|null
getThumb()

Optional. 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://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files ».

string|null
getCaption()

Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing.

string|null
getParseMode()

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

array|null
getCaptionEntities()

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

int|null
getWidth()

Optional. Animation width.

int|null
getHeight()

Optional. Animation height.

int|null
getDuration()

Optional. Animation duration in seconds.

Details

at line 21
__construct(string $type, string $media, InputFileInterface|string|null $thumb = null, string|null $caption = null, string|null $parse_mode = null, MessageEntity[]|null $caption_entities = null, int|null $width = null, int|null $height = null, int|null $duration = null)

No description

Parameters

string $type
string $media
InputFileInterface|string|null $thumb
string|null $caption
string|null $parse_mode
MessageEntity[]|null $caption_entities
int|null $width
int|null $height
int|null $duration

at line 37
string getType()

Type of the result, must be animation.

Return Value

string

at line 45
string getMedia()

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».

Return Value

string

at line 55
InputFileInterface|string|null getThumb()

Optional. 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://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files ».

Return Value

InputFileInterface|string|null

at line 63
string|null getCaption()

Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing.

Return Value

string|null

at line 71
string|null getParseMode()

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

Return Value

string|null

at line 81
array|null getCaptionEntities()

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

Return Value

array|null

at line 89
int|null getWidth()

Optional. Animation width.

Return Value

int|null

at line 97
int|null getHeight()

Optional. Animation height.

Return Value

int|null

at line 105
int|null getDuration()

Optional. Animation duration in seconds.

Return Value

int|null