tgbot-cpp
Loading...
Searching...
No Matches
TgBot::InlineQueryResultPhoto Struct Reference

Represents a link to a photo. By default, this photo 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 photo. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<InlineQueryResultPhoto>

Public Attributes

std::string type { TYPE }
 Type of the result, must be photo.
std::string id { }
 Unique identifier for this result, 1-64 bytes.
std::string photoUrl { }
 A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB.
std::string thumbnailUrl { }
 URL of the thumbnail for the photo.
std::optional< std::int32_t > photoWidth { }
 Optional. Width of the photo.
std::optional< std::int32_t > photoHeight { }
 Optional. Height of the photo.
std::optional< std::string > title { }
 Optional. Title for the result.
std::optional< std::string > description { }
 Optional. Short description of the result.
std::optional< std::string > caption { }
 Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing.
std::optional< std::string > parseMode { }
 Optional. Mode for parsing entities in the photo 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 photo.

Static Public Attributes

static TGBOT_API const std::string TYPE

Detailed Description

Represents a link to a photo. By default, this photo 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 photo.

Definition at line 5630 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 5631 of file Types.h.

Member Data Documentation

◆ caption

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

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

Definition at line 5678 of file Types.h.

◆ captionEntities

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

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

Definition at line 5690 of file Types.h.

◆ description

std::optional<std::string> TgBot::InlineQueryResultPhoto::description { }

Optional. Short description of the result.

Definition at line 5673 of file Types.h.

◆ id

std::string TgBot::InlineQueryResultPhoto::id { }

Unique identifier for this result, 1-64 bytes.

Definition at line 5643 of file Types.h.

◆ inputMessageContent

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

Optional. Content of the message to be sent instead of the photo.

Definition at line 5705 of file Types.h.

◆ parseMode

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

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

Definition at line 5684 of file Types.h.

◆ photoHeight

std::optional<std::int32_t> TgBot::InlineQueryResultPhoto::photoHeight { }

Optional. Height of the photo.

Definition at line 5663 of file Types.h.

◆ photoUrl

std::string TgBot::InlineQueryResultPhoto::photoUrl { }

A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB.

Definition at line 5648 of file Types.h.

◆ photoWidth

std::optional<std::int32_t> TgBot::InlineQueryResultPhoto::photoWidth { }

Optional. Width of the photo.

Definition at line 5658 of file Types.h.

◆ replyMarkup

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

Optional. Inline keyboard attached to the message.

Definition at line 5700 of file Types.h.

◆ showCaptionAboveMedia

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

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

Definition at line 5695 of file Types.h.

◆ thumbnailUrl

std::string TgBot::InlineQueryResultPhoto::thumbnailUrl { }

URL of the thumbnail for the photo.

Definition at line 5653 of file Types.h.

◆ title

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

Optional. Title for the result.

Definition at line 5668 of file Types.h.

◆ TYPE

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

Definition at line 5633 of file Types.h.

◆ type

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

Type of the result, must be photo.

Definition at line 5638 of file Types.h.


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