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

Arguments for Api::copyMessage. 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::int64_t, std::string > fromChatId { }
 Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username).
std::int32_t messageId { }
 Message identifier in the chat specified in from_chat_id.
std::string caption = ""
 New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.
std::string parseMode = ""
 Mode for parsing entities in the new 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 new caption, which can be specified instead of parse_mode.
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
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.
bool protectContent = false
 Protects the contents of the sent message from forwarding and saving.
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 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::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; only available when copying to private chats.
bool showCaptionAboveMedia = false
 Pass True if the caption must be shown above the message media. Ignored if a new caption isn't specified.
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::int32_t videoStartTimestamp = 0
 New start timestamp for the copied video in the message.

Detailed Description

Arguments for Api::copyMessage.

Definition at line 14739 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

bool TgBot::CopyMessageArgs::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 14813 of file Types.h.

◆ caption

std::string TgBot::CopyMessageArgs::caption = ""

New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.

Definition at line 14762 of file Types.h.

◆ captionEntities

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

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

Definition at line 14774 of file Types.h.

◆ chatId

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

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

Definition at line 14744 of file Types.h.

◆ directMessagesTopicId

std::int64_t TgBot::CopyMessageArgs::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 14819 of file Types.h.

◆ disableNotification

bool TgBot::CopyMessageArgs::disableNotification = false

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

Definition at line 14780 of file Types.h.

◆ fromChatId

std::variant<std::int64_t, std::string> TgBot::CopyMessageArgs::fromChatId { }

Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username).

Definition at line 14751 of file Types.h.

◆ messageEffectId

std::string TgBot::CopyMessageArgs::messageEffectId = ""

Unique identifier of the message effect to be added to the message; only available when copying to private chats.

Definition at line 14825 of file Types.h.

◆ messageId

std::int32_t TgBot::CopyMessageArgs::messageId { }

Message identifier in the chat specified in from_chat_id.

Definition at line 14756 of file Types.h.

◆ messageThreadId

std::int32_t TgBot::CopyMessageArgs::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 14806 of file Types.h.

◆ parseMode

std::string TgBot::CopyMessageArgs::parseMode = ""

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

Definition at line 14768 of file Types.h.

◆ protectContent

bool TgBot::CopyMessageArgs::protectContent = false

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

Definition at line 14799 of file Types.h.

◆ replyMarkup

std::variant<std::shared_ptr<InlineKeyboardMarkup>, std::shared_ptr<ReplyKeyboardMarkup>, std::shared_ptr<ReplyKeyboardRemove>, std::shared_ptr<ForceReply> > TgBot::CopyMessageArgs::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 14794 of file Types.h.

◆ replyParameters

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

Description of the message to reply to.

Definition at line 14785 of file Types.h.

◆ showCaptionAboveMedia

bool TgBot::CopyMessageArgs::showCaptionAboveMedia = false

Pass True if the caption must be shown above the message media. Ignored if a new caption isn't specified.

Definition at line 14831 of file Types.h.

◆ suggestedPostParameters

std::shared_ptr<SuggestedPostParameters> TgBot::CopyMessageArgs::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 14839 of file Types.h.

◆ videoStartTimestamp

std::int32_t TgBot::CopyMessageArgs::videoStartTimestamp = 0

New start timestamp for the copied video in the message.

Definition at line 14844 of file Types.h.


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