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

Arguments for Api::sendMediaGroup. 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::vector< std::variant< std::shared_ptr< InputMediaAudio >, std::shared_ptr< InputMediaDocument >, std::shared_ptr< InputMediaLivePhoto >, std::shared_ptr< InputMediaPhoto >, std::shared_ptr< InputMediaVideo > > > media { }
 A JSON-serialized Array describing messages to be sent, must include 2-10 items.
bool disableNotification = false
 Sends messages silently. Users will receive a notification with no sound.
std::shared_ptr< ReplyParameters > replyParameters = nullptr
 Description of the message to reply to.
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 messages from forwarding and saving.
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::int64_t directMessagesTopicId = 0
 Identifier of the direct messages topic to which the messages will be sent; required if the messages are 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::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::sendMediaGroup.

Definition at line 18774 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

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

◆ attachments

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

◆ businessConnectionId

std::string TgBot::SendMediaGroupArgs::businessConnectionId = ""

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

Definition at line 18817 of file Types.h.

◆ chatId

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

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

Definition at line 18779 of file Types.h.

◆ directMessagesTopicId

std::int64_t TgBot::SendMediaGroupArgs::directMessagesTopicId = 0

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

Definition at line 18830 of file Types.h.

◆ disableNotification

bool TgBot::SendMediaGroupArgs::disableNotification = false

Sends messages silently. Users will receive a notification with no sound.

Definition at line 18794 of file Types.h.

◆ media

std::vector<std::variant<std::shared_ptr<InputMediaAudio>, std::shared_ptr<InputMediaDocument>, std::shared_ptr<InputMediaLivePhoto>, std::shared_ptr<InputMediaPhoto>, std::shared_ptr<InputMediaVideo> > > TgBot::SendMediaGroupArgs::media { }

A JSON-serialized Array describing messages to be sent, must include 2-10 items.

Definition at line 18788 of file Types.h.

◆ messageEffectId

std::string TgBot::SendMediaGroupArgs::messageEffectId = ""

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

Definition at line 18836 of file Types.h.

◆ messageThreadId

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

◆ protectContent

bool TgBot::SendMediaGroupArgs::protectContent = false

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

Definition at line 18811 of file Types.h.

◆ replyParameters

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

Description of the message to reply to.

Definition at line 18799 of file Types.h.


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