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

Arguments for Api::sendRichMessageDraft. 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::shared_ptr< InputRichMessage > richMessage { }
 The partial message to be streamed. Direct upload of new files and explicit upload of files by a URL isn't supported.
std::int32_t messageThreadId = 0
 Unique identifier for the target message thread.
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::sendRichMessageDraft.

Definition at line 19578 of file Types.h.

Member Data Documentation

◆ canStop

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

◆ chatId

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

Unique identifier for the target private chat.

Definition at line 19582 of file Types.h.

◆ draftId

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

◆ keepOnStop

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

◆ messageThreadId

std::int32_t TgBot::SendRichMessageDraftArgs::messageThreadId = 0

Unique identifier for the target message thread.

Definition at line 19600 of file Types.h.

◆ richMessage

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

The partial message to be streamed. Direct upload of new files and explicit upload of files by a URL isn't supported.

Definition at line 19595 of file Types.h.


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