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 inputMessageContent to send a message with the specified content instead of the photo. More...

#include <InlineQueryResult.hpp>

Inheritance diagram for tgbotxx::InlineQueryResultCachedDocument:

Public Member Functions
	InlineQueryResultCachedDocument ()

	InlineQueryResultCachedDocument (const nl::json &json)

nl::json	toJson () const override

void	fromJson (const nl::json &json) override

Public Member Functions inherited from tgbotxx::InlineQueryResult
	InlineQueryResult ()=default

	InlineQueryResult (const nl::json &json)

virtual	~InlineQueryResult ()=default

Public Attributes
std::string	title
	Title for the result.

std::string	documentFileId
	A valid file identifier for the file.

std::string	description
	Optional. Short description of the result.

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

std::string	parseMode
	Optional. Mode for parsing entities in the document caption. See formatting options for more details.

std::vector< Ptr< MessageEntity > >	captionEntities
	Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.

Ptr< InputMessageContent >	inputMessageContent
	Optional. Content of the message to be sent instead of the document.

Public Attributes inherited from tgbotxx::InlineQueryResult
std::string	type
	Type of the result.

std::string	id
	Unique identifier for this result, 1-64 bytes.

Ptr< InlineKeyboardMarkup >	replyMarkup
	Optional. Inline keyboard attached to the message.

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 inputMessageContent to send a message with the specified content instead of the photo.

Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.

Definition at line 1088 of file InlineQueryResult.hpp.

Constructor & Destructor Documentation

◆ InlineQueryResultCachedDocument() [1/2]

tgbotxx::InlineQueryResultCachedDocument::InlineQueryResultCachedDocument ( )

inline

Definition at line 1089 of file InlineQueryResult.hpp.

◆ InlineQueryResultCachedDocument() [2/2]

tgbotxx::InlineQueryResultCachedDocument::InlineQueryResultCachedDocument ( const nl::json & json )

inlineexplicit

Definition at line 1092 of file InlineQueryResult.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::InlineQueryResultCachedDocument::fromJson ( const nl::json & json )

inlineoverridevirtual

Reimplemented from tgbotxx::InlineQueryResult.

Definition at line 1130 of file InlineQueryResult.hpp.

◆ toJson()

nl::json tgbotxx::InlineQueryResultCachedDocument::toJson ( ) const

inlineoverridevirtual

Reimplemented from tgbotxx::InlineQueryResult.

Definition at line 1118 of file InlineQueryResult.hpp.

Member Data Documentation

◆ caption

std::string tgbotxx::InlineQueryResultCachedDocument::caption

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

Definition at line 1106 of file InlineQueryResult.hpp.

◆ captionEntities

std::vector<Ptr<MessageEntity> > tgbotxx::InlineQueryResultCachedDocument::captionEntities

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

Definition at line 1112 of file InlineQueryResult.hpp.

◆ description

std::string tgbotxx::InlineQueryResultCachedDocument::description

Optional. Short description of the result.

Definition at line 1103 of file InlineQueryResult.hpp.

◆ documentFileId

std::string tgbotxx::InlineQueryResultCachedDocument::documentFileId

A valid file identifier for the file.

Definition at line 1100 of file InlineQueryResult.hpp.

◆ inputMessageContent

Ptr<InputMessageContent> tgbotxx::InlineQueryResultCachedDocument::inputMessageContent

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

Definition at line 1115 of file InlineQueryResult.hpp.

◆ parseMode

std::string tgbotxx::InlineQueryResultCachedDocument::parseMode

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

Definition at line 1109 of file InlineQueryResult.hpp.

◆ title

std::string tgbotxx::InlineQueryResultCachedDocument::title

Title for the result.

Definition at line 1097 of file InlineQueryResult.hpp.

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

include/tgbotxx/objects/InlineQueryResult.hpp

Public Member Functions

Public Attributes