tgbot-cpp
Loading...
Searching...
No Matches
TgBot::InlineQueryResultGif Struct 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 input_message_content to send a message with the specified content instead of the animation. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<InlineQueryResultGif>

Public Attributes

std::string type { TYPE }
 Type of the result, must be gif.
std::string id { }
 Unique identifier for this result, 1-64 bytes.
std::string gifUrl { }
 A valid URL for the GIF file.
std::optional< std::int32_t > gifWidth { }
 Optional. Width of the GIF.
std::optional< std::int32_t > gifHeight { }
 Optional. Height of the GIF.
std::optional< std::int32_t > gifDuration { }
 Optional. Duration of the GIF in seconds.
std::string thumbnailUrl { }
 URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result.
std::optional< std::string > thumbnailMimeType { }
 Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
std::optional< std::string > title { }
 Optional. Title for the result.
std::optional< std::string > caption { }
 Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing.
std::optional< std::string > parseMode { }
 Optional. Mode for parsing entities in the 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::shared_ptr< InlineKeyboardMarkupreplyMarkup { }
 Optional. Inline keyboard attached to the message.
std::shared_ptr< InputMessageContentinputMessageContent { }
 Optional. Content of the message to be sent instead of the GIF animation.

Static Public Attributes

static TGBOT_API 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 input_message_content to send a message with the specified content instead of the animation.

Definition at line 5354 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 5355 of file Types.h.

Member Data Documentation

◆ caption

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

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

Definition at line 5408 of file Types.h.

◆ captionEntities

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

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

Definition at line 5420 of file Types.h.

◆ gifDuration

std::optional<std::int32_t> TgBot::InlineQueryResultGif::gifDuration { }

Optional. Duration of the GIF in seconds.

Definition at line 5387 of file Types.h.

◆ gifHeight

std::optional<std::int32_t> TgBot::InlineQueryResultGif::gifHeight { }

Optional. Height of the GIF.

Definition at line 5382 of file Types.h.

◆ gifUrl

std::string TgBot::InlineQueryResultGif::gifUrl { }

A valid URL for the GIF file.

Definition at line 5372 of file Types.h.

◆ gifWidth

std::optional<std::int32_t> TgBot::InlineQueryResultGif::gifWidth { }

Optional. Width of the GIF.

Definition at line 5377 of file Types.h.

◆ id

std::string TgBot::InlineQueryResultGif::id { }

Unique identifier for this result, 1-64 bytes.

Definition at line 5367 of file Types.h.

◆ inputMessageContent

std::shared_ptr<InputMessageContent> TgBot::InlineQueryResultGif::inputMessageContent { }

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

Definition at line 5435 of file Types.h.

◆ parseMode

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

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

Definition at line 5414 of file Types.h.

◆ replyMarkup

std::shared_ptr<InlineKeyboardMarkup> TgBot::InlineQueryResultGif::replyMarkup { }

Optional. Inline keyboard attached to the message.

Definition at line 5430 of file Types.h.

◆ showCaptionAboveMedia

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

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

Definition at line 5425 of file Types.h.

◆ thumbnailMimeType

std::optional<std::string> TgBot::InlineQueryResultGif::thumbnailMimeType { }

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

Definition at line 5398 of file Types.h.

◆ thumbnailUrl

std::string TgBot::InlineQueryResultGif::thumbnailUrl { }

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

Definition at line 5392 of file Types.h.

◆ title

std::optional<std::string> TgBot::InlineQueryResultGif::title { }

Optional. Title for the result.

Definition at line 5403 of file Types.h.

◆ TYPE

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

Definition at line 5357 of file Types.h.

◆ type

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

Type of the result, must be gif.

Definition at line 5362 of file Types.h.


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