tgbot-cpp
Loading...
Searching...
No Matches
TgBot::InputMediaAnimation Class Reference

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

#include <InputMediaAnimation.h>

Inheritance diagram for TgBot::InputMediaAnimation:
TgBot::InputMedia

Public Types

typedef std::shared_ptr< InputMediaAnimationPtr
 
- Public Types inherited from TgBot::InputMedia
typedef std::shared_ptr< InputMediaPtr
 

Public Member Functions

 InputMediaAnimation ()
 
- Public Member Functions inherited from TgBot::InputMedia
 InputMedia ()
 
virtual ~InputMedia ()
 

Public Attributes

std::string thumb
 Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
 
std::int32_t width
 Optional. Animation width.
 
std::int32_t height
 Optional. Animation height.
 
std::int32_t duration
 Optional. Animation duration in seconds.
 
bool hasSpoiler
 Optional. Pass True if the animation needs to be covered with a spoiler animation.
 
- Public Attributes inherited from TgBot::InputMedia
std::string type
 Type of the result.
 
std::string media
 File to send.
 
std::string caption
 Optional. Caption of the media to be sent, 0-1024 characters after entities parsing.
 
std::string parseMode
 Optional. Mode for parsing entities in the media caption.
 
std::vector< MessageEntity::PtrcaptionEntities
 Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.
 

Static Public Attributes

static 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 16 of file InputMediaAnimation.h.

Member Typedef Documentation

◆ Ptr

Definition at line 21 of file InputMediaAnimation.h.

Constructor & Destructor Documentation

◆ InputMediaAnimation()

TgBot::InputMediaAnimation::InputMediaAnimation ( )
inline

Definition at line 23 of file InputMediaAnimation.h.

Member Data Documentation

◆ duration

std::int32_t TgBot::InputMediaAnimation::duration

Optional. Animation duration in seconds.

Definition at line 51 of file InputMediaAnimation.h.

◆ hasSpoiler

bool TgBot::InputMediaAnimation::hasSpoiler

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

Definition at line 56 of file InputMediaAnimation.h.

◆ height

std::int32_t TgBot::InputMediaAnimation::height

Optional. Animation height.

Definition at line 46 of file InputMediaAnimation.h.

◆ thumb

std::string TgBot::InputMediaAnimation::thumb

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>. https://core.telegram.org/bots/api#sending-files

Definition at line 36 of file InputMediaAnimation.h.

◆ TYPE

const std::string TgBot::InputMediaAnimation::TYPE
static

Definition at line 19 of file InputMediaAnimation.h.

◆ width

std::int32_t TgBot::InputMediaAnimation::width

Optional. Animation width.

Definition at line 41 of file InputMediaAnimation.h.


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