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

Arguments for Api::sendMessageDraft. More...

#include <Types.h>

Public Attributes

std::variant< std::int64_t, std::string > chatId { }
 Unique identifier for the target private chat.
std::int32_t draftId { }
 Unique identifier of the message draft; must be non-zero. Changes to drafts with the same identifier are animated. Otherwise, the draft is replaced without animation.
std::vector< std::shared_ptr< MessageEntity > > entities = { }
 A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode.
std::int32_t messageThreadId = 0
 Unique identifier for the target message thread.
std::string parseMode = ""
 Mode for parsing entities in the message text. See formatting options for more details.
std::string text = ""
 Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a “Thinking…” placeholder.
bool canStop = false
 Pass True to show the user a button to stop further drafts. The bot will receive an Update “stopped_message_generation” if the user presses the button.
bool keepOnStop = false
 Pass True to keep the draft in the chat when the button is pressed. The draft will still disappear after a short time or if the bot sends a message. To fully preserve the partial draft, the bot should send it as a new message.

Detailed Description

Arguments for Api::sendMessageDraft.

Definition at line 18965 of file Types.h.

Member Data Documentation

◆ canStop

bool TgBot::SendMessageDraftArgs::canStop = false

Pass True to show the user a button to stop further drafts. The bot will receive an Update “stopped_message_generation” if the user presses the button.

Definition at line 19006 of file Types.h.

◆ chatId

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

Unique identifier for the target private chat.

Definition at line 18969 of file Types.h.

◆ draftId

std::int32_t TgBot::SendMessageDraftArgs::draftId { }

Unique identifier of the message draft; must be non-zero. Changes to drafts with the same identifier are animated. Otherwise, the draft is replaced without animation.

Definition at line 18976 of file Types.h.

◆ entities

std::vector<std::shared_ptr<MessageEntity> > TgBot::SendMessageDraftArgs::entities = { }

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

Definition at line 18982 of file Types.h.

◆ keepOnStop

bool TgBot::SendMessageDraftArgs::keepOnStop = false

Pass True to keep the draft in the chat when the button is pressed. The draft will still disappear after a short time or if the bot sends a message. To fully preserve the partial draft, the bot should send it as a new message.

Definition at line 19014 of file Types.h.

◆ messageThreadId

std::int32_t TgBot::SendMessageDraftArgs::messageThreadId = 0

Unique identifier for the target message thread.

Definition at line 18987 of file Types.h.

◆ parseMode

std::string TgBot::SendMessageDraftArgs::parseMode = ""

Mode for parsing entities in the message text. See formatting options for more details.

Definition at line 18993 of file Types.h.

◆ text

std::string TgBot::SendMessageDraftArgs::text = ""

Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a “Thinking…” placeholder.

Definition at line 18999 of file Types.h.


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