tgbotxx  1.1.6.9
Telegram Bot C++ Library
tgbotxx::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 inputMessageContent to send a message with the specified content instead of the animation. https://core.telegram.org/bots/api#inlinequeryresultgif. More...

#include <InlineQueryResult.hpp>

Inheritance diagram for tgbotxx::InlineQueryResultGif:
tgbotxx::InlineQueryResult

Public Member Functions

 InlineQueryResultGif ()
 
 InlineQueryResultGif (const nl::json &json)
 
nl::json toJson () const override
 
void fromJson (const nl::json &json) override
 
- Public Member Functions inherited from tgbotxx::InlineQueryResult
 InlineQueryResult ()=default
 
 InlineQueryResult (const nl::json &json)
 

Public Attributes

std::string gifUrl
 A valid URL for the GIF file. File size must not exceed 1MB. More...
 
std::int32_t gifWidth {}
 Optional. Width of the GIF. More...
 
std::int32_t gifHeight {}
 Optional. Height of the GIF. More...
 
std::int32_t gifDuration {}
 Optional. Duration of the GIF in seconds. More...
 
std::string thumbnailUrl
 URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. More...
 
std::string thumbnailMimeType
 Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” More...
 
std::string title
 Optional. Title for the result. More...
 
std::string caption
 Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing. More...
 
std::string parseMode
 Optional. Mode for parsing entities in the caption. See formatting options for more details. More...
 
std::vector< Ptr< MessageEntity > > captionEntities
 Optional. List of special entities that appear in the caption, which can be specified instead of parseMode. More...
 
Ptr< InputMessageContentinputMessageContent
 Optional. Content of the message to be sent instead of the GIF animation. More...
 
- Public Attributes inherited from tgbotxx::InlineQueryResult
std::string type
 Type of the result. More...
 
std::string id
 Unique identifier for this result, 1-64 bytes. More...
 
Ptr< InlineKeyboardMarkupreplyMarkup
 Optional. Inline keyboard attached to the message. More...
 

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

Definition at line 202 of file InlineQueryResult.hpp.

Constructor & Destructor Documentation

◆ InlineQueryResultGif() [1/2]

tgbotxx::InlineQueryResultGif::InlineQueryResultGif ( )
inline

Definition at line 203 of file InlineQueryResult.hpp.

◆ InlineQueryResultGif() [2/2]

tgbotxx::InlineQueryResultGif::InlineQueryResultGif ( const nl::json &  json)
inlineexplicit

Definition at line 206 of file InlineQueryResult.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::InlineQueryResultGif::fromJson ( const nl::json &  json)
inlineoverridevirtual

Reimplemented from tgbotxx::InlineQueryResult.

Definition at line 259 of file InlineQueryResult.hpp.

◆ toJson()

nl::json tgbotxx::InlineQueryResultGif::toJson ( ) const
inlineoverridevirtual

Reimplemented from tgbotxx::InlineQueryResult.

Definition at line 243 of file InlineQueryResult.hpp.

Member Data Documentation

◆ caption

std::string tgbotxx::InlineQueryResultGif::caption

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

Definition at line 232 of file InlineQueryResult.hpp.

◆ captionEntities

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

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

Definition at line 238 of file InlineQueryResult.hpp.

◆ gifDuration

std::int32_t tgbotxx::InlineQueryResultGif::gifDuration {}

Optional. Duration of the GIF in seconds.

Definition at line 220 of file InlineQueryResult.hpp.

◆ gifHeight

std::int32_t tgbotxx::InlineQueryResultGif::gifHeight {}

Optional. Height of the GIF.

Definition at line 217 of file InlineQueryResult.hpp.

◆ gifUrl

std::string tgbotxx::InlineQueryResultGif::gifUrl

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

Definition at line 211 of file InlineQueryResult.hpp.

◆ gifWidth

std::int32_t tgbotxx::InlineQueryResultGif::gifWidth {}

Optional. Width of the GIF.

Definition at line 214 of file InlineQueryResult.hpp.

◆ inputMessageContent

Ptr<InputMessageContent> tgbotxx::InlineQueryResultGif::inputMessageContent

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

Definition at line 241 of file InlineQueryResult.hpp.

◆ parseMode

std::string tgbotxx::InlineQueryResultGif::parseMode

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

Definition at line 235 of file InlineQueryResult.hpp.

◆ thumbnailMimeType

std::string tgbotxx::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 226 of file InlineQueryResult.hpp.

◆ thumbnailUrl

std::string tgbotxx::InlineQueryResultGif::thumbnailUrl

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

Definition at line 223 of file InlineQueryResult.hpp.

◆ title

std::string tgbotxx::InlineQueryResultGif::title

Optional. Title for the result.

Definition at line 229 of file InlineQueryResult.hpp.


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