TgBot::InputMediaAnimation Struct Reference

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

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<InputMediaAnimation>

Public Attributes
std::string	type { TYPE }
	Type of the media, must be animation.
std::string	media { }
	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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
std::optional< std::string >	thumbnail { }
	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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
std::optional< std::string >	caption { }
	Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing.
std::optional< std::string >	parseMode { }
	Optional. Mode for parsing entities in the animation caption. See formatting options for more details.
std::optional< std::vector< std::shared_ptr< MessageEntity > > >	captionEntities { }
	Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
std::optional< bool >	showCaptionAboveMedia { }
	Optional. Pass True if the caption must be shown above the message media.
std::optional< std::int32_t >	width { }
	Optional. Animation width.
std::optional< std::int32_t >	height { }
	Optional. Animation height.
std::optional< std::int32_t >	duration { }
	Optional. Animation duration in seconds.
std::optional< bool >	hasSpoiler { }
	Optional. Pass True if the animation needs to be covered with a spoiler animation.

Static Public Attributes
static TGBOT_API const std::string	TYPE

Detailed Description

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

Definition at line 6314 of file Types.h.

Member Typedef Documentation

Ptr

using TgBot::InputMediaAnimation::Ptr = std::shared_ptr<InputMediaAnimation>

Definition at line 6315 of file Types.h.

Member Data Documentation

caption

std::optional<std::string> TgBot::InputMediaAnimation::caption { }

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

Definition at line 6346 of file Types.h.

captionEntities

std::optional<std::vector<std::shared_ptr<MessageEntity> > > TgBot::InputMediaAnimation::captionEntities { }

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

Definition at line 6358 of file Types.h.

duration

std::optional<std::int32_t> TgBot::InputMediaAnimation::duration { }

Optional. Animation duration in seconds.

Definition at line 6378 of file Types.h.

hasSpoiler

std::optional<bool> TgBot::InputMediaAnimation::hasSpoiler { }

Optional. Pass True if the animation needs to be covered with a spoiler animation.

Definition at line 6383 of file Types.h.

height

std::optional<std::int32_t> TgBot::InputMediaAnimation::height { }

Optional. Animation height.

Definition at line 6373 of file Types.h.

media

std::string TgBot::InputMediaAnimation::media { }

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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

Definition at line 6330 of file Types.h.

parseMode

std::optional<std::string> TgBot::InputMediaAnimation::parseMode { }

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

Definition at line 6352 of file Types.h.

showCaptionAboveMedia

std::optional<bool> TgBot::InputMediaAnimation::showCaptionAboveMedia { }

Optional. Pass True if the caption must be shown above the message media.

Definition at line 6363 of file Types.h.

thumbnail

std::optional<std::string> TgBot::InputMediaAnimation::thumbnail { }

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

Definition at line 6341 of file Types.h.

TYPE

TGBOT_API const std::string TgBot::InputMediaAnimation::TYPE

static

Definition at line 6317 of file Types.h.

type

std::string TgBot::InputMediaAnimation::type { TYPE }

Type of the media, must be animation.

Definition at line 6322 of file Types.h.

width

std::optional<std::int32_t> TgBot::InputMediaAnimation::width { }

Optional. Animation width.

Definition at line 6368 of file Types.h.

---

The documentation for this struct was generated from the following file:

• include/tgbot/Types.h