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

Arguments for Api::sendPhoto. More...

#include <Types.h>

Public Attributes

std::variant< std::int64_t, std::string > chatId { }
 Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
std::variant< std::shared_ptr< InputFile >, std::string > photo { }
 Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »
std::string caption = ""
 Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing.
std::shared_ptr< ReplyParameters > replyParameters = nullptr
 Description of the message to reply to.
std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup = { }
 Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
std::string parseMode = ""
 Mode for parsing entities in the photo caption. See formatting options for more details.
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
std::vector< std::shared_ptr< MessageEntity > > captionEntities = { }
 A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.
std::int32_t messageThreadId = 0
 Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.
bool protectContent = false
 Protects the contents of the sent message from forwarding and saving.
bool hasSpoiler = false
 Pass True if the photo needs to be covered with a spoiler animation.
std::string businessConnectionId = ""
 Unique identifier of the business connection on behalf of which the message will be sent.
bool allowPaidBroadcast = false
 Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
std::string callbackQueryId = ""
 Identifier of the callback query which triggered the ephemeral message.
std::int64_t directMessagesTopicId = 0
 Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat.
std::string messageEffectId = ""
 Unique identifier of the message effect to be added to the message; for private chats only.
std::int64_t receiverUserId = 0
 Identifier of the user who will receive the ephemeral message.
bool showCaptionAboveMedia = false
 Pass True if the caption must be shown above the message media.
std::shared_ptr< SuggestedPostParameters > suggestedPostParameters = nullptr
 A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
std::shared_ptr< EphemeralMessageParameters > ephemeralMessageParameters = nullptr
 A JSON-serialized object containing the parameters of the ephemeral message to send.

Detailed Description

Arguments for Api::sendPhoto.

Definition at line 19140 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

bool TgBot::SendPhotoArgs::allowPaidBroadcast = false

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.

Definition at line 19223 of file Types.h.

◆ businessConnectionId

std::string TgBot::SendPhotoArgs::businessConnectionId = ""

Unique identifier of the business connection on behalf of which the message will be sent.

Definition at line 19216 of file Types.h.

◆ callbackQueryId

std::string TgBot::SendPhotoArgs::callbackQueryId = ""

Identifier of the callback query which triggered the ephemeral message.

Definition at line 19228 of file Types.h.

◆ caption

std::string TgBot::SendPhotoArgs::caption = ""

Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing.

Definition at line 19161 of file Types.h.

◆ captionEntities

std::vector<std::shared_ptr<MessageEntity> > TgBot::SendPhotoArgs::captionEntities = { }

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.

Definition at line 19193 of file Types.h.

◆ chatId

std::variant<std::int64_t, std::string> TgBot::SendPhotoArgs::chatId { }

Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.

Definition at line 19145 of file Types.h.

◆ directMessagesTopicId

std::int64_t TgBot::SendPhotoArgs::directMessagesTopicId = 0

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat.

Definition at line 19234 of file Types.h.

◆ disableNotification

bool TgBot::SendPhotoArgs::disableNotification = false

Sends the message silently. Users will receive a notification with no sound.

Definition at line 19187 of file Types.h.

◆ ephemeralMessageParameters

std::shared_ptr<EphemeralMessageParameters> TgBot::SendPhotoArgs::ephemeralMessageParameters = nullptr

A JSON-serialized object containing the parameters of the ephemeral message to send.

Definition at line 19264 of file Types.h.

◆ hasSpoiler

bool TgBot::SendPhotoArgs::hasSpoiler = false

Pass True if the photo needs to be covered with a spoiler animation.

Definition at line 19210 of file Types.h.

◆ messageEffectId

std::string TgBot::SendPhotoArgs::messageEffectId = ""

Unique identifier of the message effect to be added to the message; for private chats only.

Definition at line 19240 of file Types.h.

◆ messageThreadId

std::int32_t TgBot::SendPhotoArgs::messageThreadId = 0

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.

Definition at line 19200 of file Types.h.

◆ parseMode

std::string TgBot::SendPhotoArgs::parseMode = ""

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

Definition at line 19181 of file Types.h.

◆ photo

std::variant<std::shared_ptr<InputFile>, std::string> TgBot::SendPhotoArgs::photo { }

Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »

Definition at line 19155 of file Types.h.

◆ protectContent

bool TgBot::SendPhotoArgs::protectContent = false

Protects the contents of the sent message from forwarding and saving.

Definition at line 19205 of file Types.h.

◆ receiverUserId

std::int64_t TgBot::SendPhotoArgs::receiverUserId = 0

Identifier of the user who will receive the ephemeral message.

Definition at line 19245 of file Types.h.

◆ replyMarkup

std::variant<std::shared_ptr<InlineKeyboardMarkup>, std::shared_ptr<ReplyKeyboardMarkup>, std::shared_ptr<ReplyKeyboardRemove>, std::shared_ptr<ForceReply> > TgBot::SendPhotoArgs::replyMarkup = { }

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.

Definition at line 19175 of file Types.h.

◆ replyParameters

std::shared_ptr<ReplyParameters> TgBot::SendPhotoArgs::replyParameters = nullptr

Description of the message to reply to.

Definition at line 19166 of file Types.h.

◆ showCaptionAboveMedia

bool TgBot::SendPhotoArgs::showCaptionAboveMedia = false

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

Definition at line 19250 of file Types.h.

◆ suggestedPostParameters

std::shared_ptr<SuggestedPostParameters> TgBot::SendPhotoArgs::suggestedPostParameters = nullptr

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Definition at line 19258 of file Types.h.


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