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

Describes a rich message to be sent. Exactly one of the fields html, markdown, or blocks must be used. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<InputRichMessage>

Public Attributes

std::optional< std::vector< std::shared_ptr< InputRichBlock > > > blocks { }
 Optional. Content of the rich message to send described as a list of blocks.
std::optional< std::string > html { }
 Optional. Content of the rich message to send described using HTML formatting. See rich message formatting options for more details. Use media field to specify the media used in the message.
std::optional< std::string > markdown { }
 Optional. Content of the rich message to send described using Markdown formatting. See rich message formatting options for more details. Use media field to specify the media used in the message.
std::optional< std::vector< std::shared_ptr< InputRichMessageMedia > > > media { }
 Optional. List of media that are specified in the markdown or html fields using tg://photo?id=, tg://video?id=, and tg://audio?id= links.
std::optional< bool > isRtl { }
 Optional. Pass True if the rich message must be shown right-to-left.
std::optional< bool > skipEntityDetection { }
 Optional. Pass True to skip automatic detection of entities (e.g., URLs, email addresses, username mentions, hashtags, cashtags, bot commands, or phone numbers) in the text.

Detailed Description

Describes a rich message to be sent. Exactly one of the fields html, markdown, or blocks must be used.

Definition at line 7889 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 7890 of file Types.h.

Member Data Documentation

◆ blocks

std::optional<std::vector<std::shared_ptr<InputRichBlock> > > TgBot::InputRichMessage::blocks { }

Optional. Content of the rich message to send described as a list of blocks.

Definition at line 7895 of file Types.h.

◆ html

std::optional<std::string> TgBot::InputRichMessage::html { }

Optional. Content of the rich message to send described using HTML formatting. See rich message formatting options for more details. Use media field to specify the media used in the message.

Definition at line 7902 of file Types.h.

◆ isRtl

std::optional<bool> TgBot::InputRichMessage::isRtl { }

Optional. Pass True if the rich message must be shown right-to-left.

Definition at line 7920 of file Types.h.

◆ markdown

std::optional<std::string> TgBot::InputRichMessage::markdown { }

Optional. Content of the rich message to send described using Markdown formatting. See rich message formatting options for more details. Use media field to specify the media used in the message.

Definition at line 7909 of file Types.h.

◆ media

std::optional<std::vector<std::shared_ptr<InputRichMessageMedia> > > TgBot::InputRichMessage::media { }

Optional. List of media that are specified in the markdown or html fields using tg://photo?id=, tg://video?id=, and tg://audio?id= links.

Definition at line 7915 of file Types.h.

◆ skipEntityDetection

std::optional<bool> TgBot::InputRichMessage::skipEntityDetection { }

Optional. Pass True to skip automatic detection of entities (e.g., URLs, email addresses, username mentions, hashtags, cashtags, bot commands, or phone numbers) in the text.

Definition at line 7927 of file Types.h.


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