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

Arguments for Api::editMessageCaption. More...

#include <Types.h>

Public Attributes

std::variant< std::int64_t, std::string > chatId = { }
 Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
std::int32_t messageId = 0
 Required if inline_message_id is not specified. Identifier of the message to edit.
std::string caption = ""
 New caption of the message, 0-1024 characters after entities parsing.
std::string inlineMessageId = ""
 Required if chat_id and message_id are not specified. Identifier of the inline message.
std::shared_ptr< InlineKeyboardMarkup > replyMarkup = nullptr
 A JSON-serialized object for an inline keyboard.
std::string parseMode = ""
 Mode for parsing entities in the message caption. See formatting options for more details.
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::string businessConnectionId = ""
 Unique identifier of the business connection on behalf of which the message to be edited was sent.
bool showCaptionAboveMedia = false
 Pass True if the caption must be shown above the message media. Supported only for animation, photo and video messages.

Detailed Description

Arguments for Api::editMessageCaption.

Definition at line 15753 of file Types.h.

Member Data Documentation

◆ businessConnectionId

std::string TgBot::EditMessageCaptionArgs::businessConnectionId = ""

Unique identifier of the business connection on behalf of which the message to be edited was sent.

Definition at line 15799 of file Types.h.

◆ caption

std::string TgBot::EditMessageCaptionArgs::caption = ""

New caption of the message, 0-1024 characters after entities parsing.

Definition at line 15770 of file Types.h.

◆ captionEntities

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

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

Definition at line 15793 of file Types.h.

◆ chatId

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

Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.

Definition at line 15759 of file Types.h.

◆ inlineMessageId

std::string TgBot::EditMessageCaptionArgs::inlineMessageId = ""

Required if chat_id and message_id are not specified. Identifier of the inline message.

Definition at line 15776 of file Types.h.

◆ messageId

std::int32_t TgBot::EditMessageCaptionArgs::messageId = 0

Required if inline_message_id is not specified. Identifier of the message to edit.

Definition at line 15765 of file Types.h.

◆ parseMode

std::string TgBot::EditMessageCaptionArgs::parseMode = ""

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

Definition at line 15787 of file Types.h.

◆ replyMarkup

std::shared_ptr<InlineKeyboardMarkup> TgBot::EditMessageCaptionArgs::replyMarkup = nullptr

A JSON-serialized object for an inline keyboard.

Definition at line 15781 of file Types.h.

◆ showCaptionAboveMedia

bool TgBot::EditMessageCaptionArgs::showCaptionAboveMedia = false

Pass True if the caption must be shown above the message media. Supported only for animation, photo and video messages.

Definition at line 15805 of file Types.h.


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