Represents a link to a file. More...
#include <InlineQueryResultDocument.h>
Public Types | |
| typedef std::shared_ptr< InlineQueryResultDocument > | Ptr |
| Public Types inherited from TgBot::InlineQueryResult | |
| typedef std::shared_ptr< InlineQueryResult > | Ptr |
Public Member Functions | |
| InlineQueryResultDocument () | |
| Public Member Functions inherited from TgBot::InlineQueryResult | |
| InlineQueryResult () | |
| virtual | ~InlineQueryResult () |
Public Attributes | |
| std::string | title |
| Title for 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. | |
| std::vector< MessageEntity::Ptr > | captionEntities |
| Optional. List of special entities that appear in the caption, which can be specified instead of parseMode. | |
| 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::string | description |
| Optional. Short description of the result. | |
| InputMessageContent::Ptr | inputMessageContent |
| Optional. Content of the message to be sent instead of the file. | |
| std::string | thumbnailUrl |
| Optional. URL of the thumbnail (JPEG only) for the file. | |
| std::int32_t | thumbnailWidth |
| Optional. Thumbnail width. | |
| std::int32_t | thumbnailHeight |
| Optional. Thumbnail height. | |
| Public Attributes inherited from TgBot::InlineQueryResult | |
| std::string | type |
| Type of the result. | |
| std::string | id |
| Unique identifier for this result, 1-64 bytes. | |
| InlineKeyboardMarkup::Ptr | replyMarkup |
| Optional. Inline keyboard attached to the message. | |
Static Public Attributes | |
| static 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 inputMessageContent 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 24 of file InlineQueryResultDocument.h.
Member Typedef Documentation
◆ Ptr
| typedef std::shared_ptr<InlineQueryResultDocument> TgBot::InlineQueryResultDocument::Ptr |
Definition at line 29 of file InlineQueryResultDocument.h.
Constructor & Destructor Documentation
◆ InlineQueryResultDocument()
|
inline |
Definition at line 31 of file InlineQueryResultDocument.h.
Member Data Documentation
◆ caption
| std::string TgBot::InlineQueryResultDocument::caption |
Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.
Definition at line 43 of file InlineQueryResultDocument.h.
◆ captionEntities
| std::vector<MessageEntity::Ptr> TgBot::InlineQueryResultDocument::captionEntities |
Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.
Definition at line 55 of file InlineQueryResultDocument.h.
◆ description
| std::string TgBot::InlineQueryResultDocument::description |
Optional. Short description of the result.
Definition at line 70 of file InlineQueryResultDocument.h.
◆ documentUrl
| std::string TgBot::InlineQueryResultDocument::documentUrl |
A valid URL for the file.
Definition at line 60 of file InlineQueryResultDocument.h.
◆ inputMessageContent
| InputMessageContent::Ptr TgBot::InlineQueryResultDocument::inputMessageContent |
Optional. Content of the message to be sent instead of the file.
Definition at line 75 of file InlineQueryResultDocument.h.
◆ mimeType
| std::string TgBot::InlineQueryResultDocument::mimeType |
MIME type of the content of the file, either “application/pdf” or “application/zip”
Definition at line 65 of file InlineQueryResultDocument.h.
◆ parseMode
| std::string TgBot::InlineQueryResultDocument::parseMode |
Optional. Mode for parsing entities in the document caption.
See formatting options for more details.
Definition at line 50 of file InlineQueryResultDocument.h.
◆ thumbnailHeight
| std::int32_t TgBot::InlineQueryResultDocument::thumbnailHeight |
Optional. Thumbnail height.
Definition at line 90 of file InlineQueryResultDocument.h.
◆ thumbnailUrl
| std::string TgBot::InlineQueryResultDocument::thumbnailUrl |
Optional. URL of the thumbnail (JPEG only) for the file.
Definition at line 80 of file InlineQueryResultDocument.h.
◆ thumbnailWidth
| std::int32_t TgBot::InlineQueryResultDocument::thumbnailWidth |
Optional. Thumbnail width.
Definition at line 85 of file InlineQueryResultDocument.h.
◆ title
| std::string TgBot::InlineQueryResultDocument::title |
Title for the result.
Definition at line 38 of file InlineQueryResultDocument.h.
◆ TYPE
|
static |
Definition at line 27 of file InlineQueryResultDocument.h.
The documentation for this class was generated from the following file:
- include/tgbot/types/InlineQueryResultDocument.h
