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

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<InlineQueryResultCachedDocument>

Public Attributes

std::string type { TYPE }
 Type of the result, must be document.
std::string id { }
 Unique identifier for this result, 1-64 bytes.
std::string title { }
 Title for the result.
std::string documentFileId { }
 A valid file identifier for the file.
std::optional< std::string > description { }
 Optional. Short description of the result.
std::optional< std::string > caption { }
 Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.
std::optional< std::string > parseMode { }
 Optional. Mode for parsing entities in the document caption. See formatting options for more details.
std::optional< std::vector< std::shared_ptr< MessageEntity > > > captionEntities { }
 Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
std::shared_ptr< InlineKeyboardMarkupreplyMarkup { }
 Optional. Inline keyboard attached to the message.
std::shared_ptr< InputMessageContentinputMessageContent { }
 Optional. Content of the message to be sent instead of the file.

Static Public Attributes

static TGBOT_API const std::string TYPE

Detailed Description

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.

Definition at line 4714 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 4715 of file Types.h.

Member Data Documentation

◆ caption

std::optional<std::string> TgBot::InlineQueryResultCachedDocument::caption { }

Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.

Definition at line 4747 of file Types.h.

◆ captionEntities

std::optional<std::vector<std::shared_ptr<MessageEntity> > > TgBot::InlineQueryResultCachedDocument::captionEntities { }

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.

Definition at line 4759 of file Types.h.

◆ description

std::optional<std::string> TgBot::InlineQueryResultCachedDocument::description { }

Optional. Short description of the result.

Definition at line 4742 of file Types.h.

◆ documentFileId

std::string TgBot::InlineQueryResultCachedDocument::documentFileId { }

A valid file identifier for the file.

Definition at line 4737 of file Types.h.

◆ id

std::string TgBot::InlineQueryResultCachedDocument::id { }

Unique identifier for this result, 1-64 bytes.

Definition at line 4727 of file Types.h.

◆ inputMessageContent

std::shared_ptr<InputMessageContent> TgBot::InlineQueryResultCachedDocument::inputMessageContent { }

Optional. Content of the message to be sent instead of the file.

Definition at line 4769 of file Types.h.

◆ parseMode

std::optional<std::string> TgBot::InlineQueryResultCachedDocument::parseMode { }

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

Definition at line 4753 of file Types.h.

◆ replyMarkup

std::shared_ptr<InlineKeyboardMarkup> TgBot::InlineQueryResultCachedDocument::replyMarkup { }

Optional. Inline keyboard attached to the message.

Definition at line 4764 of file Types.h.

◆ title

std::string TgBot::InlineQueryResultCachedDocument::title { }

Title for the result.

Definition at line 4732 of file Types.h.

◆ TYPE

TGBOT_API const std::string TgBot::InlineQueryResultCachedDocument::TYPE
static

Definition at line 4717 of file Types.h.

◆ type

std::string TgBot::InlineQueryResultCachedDocument::type { TYPE }

Type of the result, must be document.

Definition at line 4722 of file Types.h.


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