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

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

#include <InlineQueryResultPhoto.h>

Inheritance diagram for TgBot::InlineQueryResultPhoto:
TgBot::InlineQueryResult

Public Types

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

Public Member Functions

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

Public Attributes

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::int32_t photoWidth
 Optional. Width of the photo.
 
std::int32_t photoHeight
 Optional. Height of the photo.
 
std::string title
 Optional. Title for the result.
 
std::string description
 Optional. Short description of the result.
 
std::string caption
 Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing.
 
std::string parseMode
 Optional. Mode for parsing entities in the photo 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 photo.
 
- 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 a photo. By default, this photo 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 photo.

Definition at line 22 of file InlineQueryResultPhoto.h.

Member Typedef Documentation

◆ Ptr

Definition at line 26 of file InlineQueryResultPhoto.h.

Constructor & Destructor Documentation

◆ InlineQueryResultPhoto()

TgBot::InlineQueryResultPhoto::InlineQueryResultPhoto ( )
inline

Definition at line 28 of file InlineQueryResultPhoto.h.

Member Data Documentation

◆ caption

std::string TgBot::InlineQueryResultPhoto::caption

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

Definition at line 67 of file InlineQueryResultPhoto.h.

◆ captionEntities

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

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

Definition at line 78 of file InlineQueryResultPhoto.h.

◆ description

std::string TgBot::InlineQueryResultPhoto::description

Optional. Short description of the result.

Definition at line 62 of file InlineQueryResultPhoto.h.

◆ inputMessageContent

InputMessageContent::Ptr TgBot::InlineQueryResultPhoto::inputMessageContent

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

Definition at line 83 of file InlineQueryResultPhoto.h.

◆ parseMode

std::string TgBot::InlineQueryResultPhoto::parseMode

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

Definition at line 73 of file InlineQueryResultPhoto.h.

◆ photoHeight

std::int32_t TgBot::InlineQueryResultPhoto::photoHeight

Optional. Height of the photo.

Definition at line 52 of file InlineQueryResultPhoto.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 37 of file InlineQueryResultPhoto.h.

◆ photoWidth

std::int32_t TgBot::InlineQueryResultPhoto::photoWidth

Optional. Width of the photo.

Definition at line 47 of file InlineQueryResultPhoto.h.

◆ thumbnailUrl

std::string TgBot::InlineQueryResultPhoto::thumbnailUrl

URL of the thumbnail for the photo.

Definition at line 42 of file InlineQueryResultPhoto.h.

◆ title

std::string TgBot::InlineQueryResultPhoto::title

Optional. Title for the result.

Definition at line 57 of file InlineQueryResultPhoto.h.

◆ TYPE

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

Definition at line 24 of file InlineQueryResultPhoto.h.


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