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

Arguments for Api::sendRichMessage. 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::shared_ptr< InputRichMessage > richMessage { }
 The message to 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 businessConnectionId = ""
 Unique identifier of the business connection on behalf of which the message will be sent. Bot can send rich messages on behalf of a business account only if the corresponding user can send rich messages.
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.
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
std::string messageEffectId = ""
 Unique identifier of the message effect to be added to the message; for private chats only.
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.
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::shared_ptr< ReplyParameters > replyParameters = nullptr
 Description of the message to reply to.
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::vector< InputFileAttachment > attachments = { }
 Files uploaded as named multipart parts. Reference each file from a composite Telegram API argument as attach://<name> and use the same name in InputFileAttachment.
std::shared_ptr< EphemeralMessageParameters > ephemeralMessageParameters = nullptr
 A JSON-serialized object containing the parameters of the ephemeral message to send.

Detailed Description

Arguments for Api::sendRichMessage.

Definition at line 19482 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

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

◆ attachments

std::vector<InputFileAttachment> TgBot::SendRichMessageArgs::attachments = { }

Files uploaded as named multipart parts. Reference each file from a composite Telegram API argument as attach://<name> and use the same name in InputFileAttachment.

Definition at line 19565 of file Types.h.

◆ businessConnectionId

std::string TgBot::SendRichMessageArgs::businessConnectionId = ""

Unique identifier of the business connection on behalf of which the message will be sent. Bot can send rich messages on behalf of a business account only if the corresponding user can send rich messages.

Definition at line 19506 of file Types.h.

◆ chatId

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

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

Definition at line 19487 of file Types.h.

◆ directMessagesTopicId

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

◆ disableNotification

bool TgBot::SendRichMessageArgs::disableNotification = false

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

Definition at line 19518 of file Types.h.

◆ ephemeralMessageParameters

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

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

Definition at line 19571 of file Types.h.

◆ messageEffectId

std::string TgBot::SendRichMessageArgs::messageEffectId = ""

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

Definition at line 19524 of file Types.h.

◆ messageThreadId

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

◆ protectContent

bool TgBot::SendRichMessageArgs::protectContent = false

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

Definition at line 19536 of file Types.h.

◆ replyMarkup

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

◆ replyParameters

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

Description of the message to reply to.

Definition at line 19550 of file Types.h.

◆ richMessage

std::shared_ptr<InputRichMessage> TgBot::SendRichMessageArgs::richMessage { }

The message to be sent.

Definition at line 19492 of file Types.h.

◆ suggestedPostParameters

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


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