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

Arguments for Api::sendDocument. 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::shared_ptr< InputFile >, std::string > document { }
 File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »
std::variant< std::shared_ptr< InputFile >, std::string > thumbnail = { }
 Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
std::string caption = ""
 Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing.
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.
std::string parseMode = ""
 Mode for parsing entities in the document caption. See formatting options for more details.
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
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.
bool disableContentTypeDetection = false
 Disables automatic server-side content type detection for files uploaded using multipart/form-data.
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::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::string callbackQueryId = ""
 Identifier of the callback query which triggered the ephemeral message.
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; for private chats only.
std::int64_t receiverUserId = 0
 Identifier of the user who will receive the ephemeral message.
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::shared_ptr< EphemeralMessageParameters > ephemeralMessageParameters = nullptr
 A JSON-serialized object containing the parameters of the ephemeral message to send.

Detailed Description

Arguments for Api::sendDocument.

Definition at line 18048 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

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

◆ businessConnectionId

std::string TgBot::SendDocumentArgs::businessConnectionId = ""

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

Definition at line 18135 of file Types.h.

◆ callbackQueryId

std::string TgBot::SendDocumentArgs::callbackQueryId = ""

Identifier of the callback query which triggered the ephemeral message.

Definition at line 18147 of file Types.h.

◆ caption

std::string TgBot::SendDocumentArgs::caption = ""

Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing.

Definition at line 18079 of file Types.h.

◆ captionEntities

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

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

Definition at line 18111 of file Types.h.

◆ chatId

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

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

Definition at line 18053 of file Types.h.

◆ directMessagesTopicId

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

◆ disableContentTypeDetection

bool TgBot::SendDocumentArgs::disableContentTypeDetection = false

Disables automatic server-side content type detection for files uploaded using multipart/form-data.

Definition at line 18117 of file Types.h.

◆ disableNotification

bool TgBot::SendDocumentArgs::disableNotification = false

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

Definition at line 18105 of file Types.h.

◆ document

std::variant<std::shared_ptr<InputFile>, std::string> TgBot::SendDocumentArgs::document { }

File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »

Definition at line 18061 of file Types.h.

◆ ephemeralMessageParameters

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

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

Definition at line 18178 of file Types.h.

◆ messageEffectId

std::string TgBot::SendDocumentArgs::messageEffectId = ""

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

Definition at line 18159 of file Types.h.

◆ messageThreadId

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

◆ parseMode

std::string TgBot::SendDocumentArgs::parseMode = ""

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

Definition at line 18099 of file Types.h.

◆ protectContent

bool TgBot::SendDocumentArgs::protectContent = false

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

Definition at line 18129 of file Types.h.

◆ receiverUserId

std::int64_t TgBot::SendDocumentArgs::receiverUserId = 0

Identifier of the user who will receive the ephemeral message.

Definition at line 18164 of file Types.h.

◆ replyMarkup

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

◆ replyParameters

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

Description of the message to reply to.

Definition at line 18084 of file Types.h.

◆ suggestedPostParameters

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

◆ thumbnail

std::variant<std::shared_ptr<InputFile>, std::string> TgBot::SendDocumentArgs::thumbnail = { }

Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »

Definition at line 18073 of file Types.h.


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