TgBot::InlineQueryResultDocument Struct Reference

Represents a link to a file. 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. Currently, only .PDF and .ZIP files can be sent using this method. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<InlineQueryResultDocument>

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::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::string	documentUrl { }
	A valid URL for the file.
std::string	mimeType { }
	MIME type of the content of the file, either “application/pdf” or “application/zip”
std::optional< std::string >	description { }
	Optional. Short description of the result.
std::shared_ptr< InlineKeyboardMarkup >	replyMarkup { }
	Optional. Inline keyboard attached to the message.
std::shared_ptr< InputMessageContent >	inputMessageContent { }
	Optional. Content of the message to be sent instead of the file.
std::optional< std::string >	thumbnailUrl { }
	Optional. URL of the thumbnail (JPEG only) for the file.
std::optional< std::int32_t >	thumbnailWidth { }
	Optional. Thumbnail width.
std::optional< std::int32_t >	thumbnailHeight { }
	Optional. Thumbnail height.

Static Public Attributes
static TGBOT_API const std::string	TYPE

Detailed Description

Represents a link to a file. 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. Currently, only .PDF and .ZIP files can be sent using this method.

Definition at line 5234 of file Types.h.

Member Typedef Documentation

Ptr

using TgBot::InlineQueryResultDocument::Ptr = std::shared_ptr<InlineQueryResultDocument>

Definition at line 5235 of file Types.h.

Member Data Documentation

caption

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

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

Definition at line 5257 of file Types.h.

captionEntities

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

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

Definition at line 5269 of file Types.h.

description

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

Optional. Short description of the result.

Definition at line 5284 of file Types.h.

documentUrl

std::string TgBot::InlineQueryResultDocument::documentUrl { }

A valid URL for the file.

Definition at line 5274 of file Types.h.

id

std::string TgBot::InlineQueryResultDocument::id { }

Unique identifier for this result, 1-64 bytes.

Definition at line 5247 of file Types.h.

inputMessageContent

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

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

Definition at line 5294 of file Types.h.

mimeType

std::string TgBot::InlineQueryResultDocument::mimeType { }

MIME type of the content of the file, either “application/pdf” or “application/zip”

Definition at line 5279 of file Types.h.

parseMode

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

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

Definition at line 5263 of file Types.h.

replyMarkup

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

Optional. Inline keyboard attached to the message.

Definition at line 5289 of file Types.h.

thumbnailHeight

std::optional<std::int32_t> TgBot::InlineQueryResultDocument::thumbnailHeight { }

Optional. Thumbnail height.

Definition at line 5309 of file Types.h.

thumbnailUrl

std::optional<std::string> TgBot::InlineQueryResultDocument::thumbnailUrl { }

Optional. URL of the thumbnail (JPEG only) for the file.

Definition at line 5299 of file Types.h.

thumbnailWidth

std::optional<std::int32_t> TgBot::InlineQueryResultDocument::thumbnailWidth { }

Optional. Thumbnail width.

Definition at line 5304 of file Types.h.

title

std::string TgBot::InlineQueryResultDocument::title { }

Title for the result.

Definition at line 5252 of file Types.h.

TYPE

TGBOT_API const std::string TgBot::InlineQueryResultDocument::TYPE

static

Definition at line 5237 of file Types.h.

type

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

Type of the result, must be document.

Definition at line 5242 of file Types.h.

---

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

• include/tgbot/Types.h