tgbot-cpp
Loading...
Searching...
No Matches
TgBot::ReplyParameters Class Reference

Describes reply parameters for the message that is being sent. More...

#include <ReplyParameters.h>

Public Types

typedef std::shared_ptr< ReplyParametersPtr
 

Public Attributes

std::int32_t messageId
 Identifier of the message that will be replied to in the current chat, or in the chat chatId if it is specified.
 
std::int64_t chatId
 Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername).
 
bool allowSendingWithoutReply
 Optional. Pass True if the message should be sent even if the specified message to be replied to is not found.
 
std::string quote
 Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing.
 
std::string quoteParseMode
 Optional. Mode for parsing entities in the quote.
 
std::vector< MessageEntity::PtrquoteEntities
 Optional. A JSON-serialized list of special entities that appear in the quote.
 
std::int32_t quotePosition
 Optional. Position of the quote in the original message in UTF-16 code units.
 

Detailed Description

Describes reply parameters for the message that is being sent.

Definition at line 18 of file ReplyParameters.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<ReplyParameters> TgBot::ReplyParameters::Ptr

Definition at line 21 of file ReplyParameters.h.

Member Data Documentation

◆ allowSendingWithoutReply

bool TgBot::ReplyParameters::allowSendingWithoutReply

Optional. Pass True if the message should be sent even if the specified message to be replied to is not found.

Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account.

Definition at line 41 of file ReplyParameters.h.

◆ chatId

std::int64_t TgBot::ReplyParameters::chatId

Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername).

Not supported for messages sent on behalf of a business account.

Definition at line 33 of file ReplyParameters.h.

◆ messageId

std::int32_t TgBot::ReplyParameters::messageId

Identifier of the message that will be replied to in the current chat, or in the chat chatId if it is specified.

Definition at line 26 of file ReplyParameters.h.

◆ quote

std::string TgBot::ReplyParameters::quote

Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing.

The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and customEmoji entities. The message will fail to send if the quote isn't found in the original message.

Definition at line 49 of file ReplyParameters.h.

◆ quoteEntities

std::vector<MessageEntity::Ptr> TgBot::ReplyParameters::quoteEntities

Optional. A JSON-serialized list of special entities that appear in the quote.

It can be specified instead of quoteParseMode.

Definition at line 63 of file ReplyParameters.h.

◆ quoteParseMode

std::string TgBot::ReplyParameters::quoteParseMode

Optional. Mode for parsing entities in the quote.

See formatting options for more details.

Definition at line 56 of file ReplyParameters.h.

◆ quotePosition

std::int32_t TgBot::ReplyParameters::quotePosition

Optional. Position of the quote in the original message in UTF-16 code units.

Definition at line 68 of file ReplyParameters.h.


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