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

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the animation. More...

#include <InlineQueryResultGif.h>

Inheritance diagram for TgBot::InlineQueryResultGif:
TgBot::InlineQueryResult

Public Types

typedef std::shared_ptr< InlineQueryResultGifPtr
 
- Public Types inherited from TgBot::InlineQueryResult
typedef std::shared_ptr< InlineQueryResultPtr
 

Public Member Functions

 InlineQueryResultGif ()
 
- Public Member Functions inherited from TgBot::InlineQueryResult
 InlineQueryResult ()
 
virtual ~InlineQueryResult ()
 

Public Attributes

std::string gifUrl
 A valid URL for the GIF file. File size must not exceed 1MB.
 
std::int32_t gifWidth
 Optional. Width of the GIF.
 
std::int32_t gifHeight
 Optional. Height of the GIF.
 
std::int32_t gifDuration
 Optional. Duration of the GIF.
 
std::string thumbUrl
 URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result.
 
std::string thumbMimeType
 Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
 
std::string title
 Optional. Title for the result.
 
std::string caption
 Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing.
 
std::string parseMode
 Optional. Mode for parsing entities in the caption. See https://core.telegram.org/bots/api#formatting-options for more details.
 
std::vector< MessageEntity::PtrcaptionEntities
 Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.
 
InputMessageContent::Ptr inputMessageContent
 Optional. Content of the message to be sent instead of the GIF animation.
 
- Public Attributes inherited from TgBot::InlineQueryResult
std::string type
 Type of the result.
 
std::string id
 Unique identifier for this result, 1-64 bytes.
 
InlineKeyboardMarkup::Ptr replyMarkup
 Optional. Inline keyboard attached to the message.
 

Static Public Attributes

static const std::string TYPE
 

Detailed Description

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the animation.

Definition at line 22 of file InlineQueryResultGif.h.

Member Typedef Documentation

◆ Ptr

Definition at line 26 of file InlineQueryResultGif.h.

Constructor & Destructor Documentation

◆ InlineQueryResultGif()

TgBot::InlineQueryResultGif::InlineQueryResultGif ( )
inline

Definition at line 28 of file InlineQueryResultGif.h.

Member Data Documentation

◆ caption

std::string TgBot::InlineQueryResultGif::caption

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

Definition at line 72 of file InlineQueryResultGif.h.

◆ captionEntities

std::vector<MessageEntity::Ptr> TgBot::InlineQueryResultGif::captionEntities

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

Definition at line 83 of file InlineQueryResultGif.h.

◆ gifDuration

std::int32_t TgBot::InlineQueryResultGif::gifDuration

Optional. Duration of the GIF.

Definition at line 51 of file InlineQueryResultGif.h.

◆ gifHeight

std::int32_t TgBot::InlineQueryResultGif::gifHeight

Optional. Height of the GIF.

Definition at line 46 of file InlineQueryResultGif.h.

◆ gifUrl

std::string TgBot::InlineQueryResultGif::gifUrl

A valid URL for the GIF file. File size must not exceed 1MB.

Definition at line 36 of file InlineQueryResultGif.h.

◆ gifWidth

std::int32_t TgBot::InlineQueryResultGif::gifWidth

Optional. Width of the GIF.

Definition at line 41 of file InlineQueryResultGif.h.

◆ inputMessageContent

InputMessageContent::Ptr TgBot::InlineQueryResultGif::inputMessageContent

Optional. Content of the message to be sent instead of the GIF animation.

Definition at line 88 of file InlineQueryResultGif.h.

◆ parseMode

std::string TgBot::InlineQueryResultGif::parseMode

Optional. Mode for parsing entities in the caption. See https://core.telegram.org/bots/api#formatting-options for more details.

Definition at line 78 of file InlineQueryResultGif.h.

◆ thumbMimeType

std::string TgBot::InlineQueryResultGif::thumbMimeType

Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”

Definition at line 62 of file InlineQueryResultGif.h.

◆ thumbUrl

std::string TgBot::InlineQueryResultGif::thumbUrl

URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result.

Definition at line 56 of file InlineQueryResultGif.h.

◆ title

std::string TgBot::InlineQueryResultGif::title

Optional. Title for the result.

Definition at line 67 of file InlineQueryResultGif.h.

◆ TYPE

const std::string TgBot::InlineQueryResultGif::TYPE
static

Definition at line 24 of file InlineQueryResultGif.h.


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