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

Arguments for Api::sendPaidMedia. 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. If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.
std::vector< std::shared_ptr< InputPaidMedia > > media { }
 A JSON-serialized Array describing the media to be sent; up to 10 items.
std::int32_t starCount { }
 The number of Telegram Stars that must be paid to buy access to the media; 1-25000.
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.
std::string caption = ""
 Media caption, 0-1024 characters after entities parsing.
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::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::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.
std::string parseMode = ""
 Mode for parsing entities in the media caption. See formatting options for more details.
std::string payload = ""
 Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.
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.
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::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.

Detailed Description

Arguments for Api::sendPaidMedia.

Definition at line 19021 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

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

◆ attachments

std::vector<InputFileAttachment> TgBot::SendPaidMediaArgs::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 19133 of file Types.h.

◆ businessConnectionId

std::string TgBot::SendPaidMediaArgs::businessConnectionId = ""

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

Definition at line 19052 of file Types.h.

◆ caption

std::string TgBot::SendPaidMediaArgs::caption = ""

Media caption, 0-1024 characters after entities parsing.

Definition at line 19057 of file Types.h.

◆ captionEntities

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

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

Definition at line 19063 of file Types.h.

◆ chatId

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

Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.

Definition at line 19028 of file Types.h.

◆ directMessagesTopicId

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

◆ disableNotification

bool TgBot::SendPaidMediaArgs::disableNotification = false

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

Definition at line 19075 of file Types.h.

◆ media

std::vector<std::shared_ptr<InputPaidMedia> > TgBot::SendPaidMediaArgs::media { }

A JSON-serialized Array describing the media to be sent; up to 10 items.

Definition at line 19033 of file Types.h.

◆ messageThreadId

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

◆ parseMode

std::string TgBot::SendPaidMediaArgs::parseMode = ""

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

Definition at line 19088 of file Types.h.

◆ payload

std::string TgBot::SendPaidMediaArgs::payload = ""

Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.

Definition at line 19094 of file Types.h.

◆ protectContent

bool TgBot::SendPaidMediaArgs::protectContent = false

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

Definition at line 19099 of file Types.h.

◆ replyMarkup

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

◆ replyParameters

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

Description of the message to reply to.

Definition at line 19113 of file Types.h.

◆ showCaptionAboveMedia

bool TgBot::SendPaidMediaArgs::showCaptionAboveMedia = false

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

Definition at line 19118 of file Types.h.

◆ starCount

std::int32_t TgBot::SendPaidMediaArgs::starCount { }

The number of Telegram Stars that must be paid to buy access to the media; 1-25000.

Definition at line 19039 of file Types.h.

◆ suggestedPostParameters

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


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