Represents a link to a page containing an embedded video player or a video file. By default, this video 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 video. https://core.telegram.org/bots/api#inlinequeryresultvideo. More...
#include <InlineQueryResult.hpp>
Public Member Functions | |
| InlineQueryResultVideo () | |
| InlineQueryResultVideo (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) | |
Public Attributes | |
| std::string | videoUrl |
| A valid URL for the embedded video player or video file. More... | |
| std::string | mimeType |
| MIME type of the content of the video URL, “text/html” or “video/mp4” More... | |
| std::string | title |
| Optional. Title for the result. More... | |
| std::string | thumbnailUrl |
| URL of the thumbnail (JPEG only) for the video. More... | |
| std::string | caption |
| Optional. Caption of the video to be sent, 0-1024 characters after entities parsing. More... | |
| std::string | parseMode |
| Optional. Mode for parsing entities in the video caption. See formatting options for more details. More... | |
| std::vector< Ptr< MessageEntity > > | captionEntities |
| Optional. List of special entities that appear in the caption, which can be specified instead of parseMode. More... | |
| std::int32_t | videoWidth {} |
| Optional. Video width. More... | |
| std::int32_t | videoHeight {} |
| Optional. Video height. More... | |
| std::int32_t | videoDuration {} |
| Optional. Video duration in seconds. More... | |
| std::string | description |
| Optional. Short description of the result. More... | |
| Ptr< InputMessageContent > | inputMessageContent |
| Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video). More... | |
| Public Attributes inherited from tgbotxx::InlineQueryResult | |
| std::string | type |
| Type of the result. More... | |
| std::string | id |
| Unique identifier for this result, 1-64 bytes. More... | |
| Ptr< InlineKeyboardMarkup > | replyMarkup |
| Optional. Inline keyboard attached to the message. More... | |
Detailed Description
Represents a link to a page containing an embedded video player or a video file. By default, this video 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 video. https://core.telegram.org/bots/api#inlinequeryresultvideo.
- Note
- If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using inputMessageContent.
Definition at line 358 of file InlineQueryResult.hpp.
Constructor & Destructor Documentation
◆ InlineQueryResultVideo() [1/2]
|
inline |
Definition at line 359 of file InlineQueryResult.hpp.
◆ InlineQueryResultVideo() [2/2]
|
inlineexplicit |
Definition at line 362 of file InlineQueryResult.hpp.
Member Function Documentation
◆ fromJson()
|
inlineoverridevirtual |
Reimplemented from tgbotxx::InlineQueryResult.
Definition at line 420 of file InlineQueryResult.hpp.
◆ toJson()
|
inlineoverridevirtual |
Reimplemented from tgbotxx::InlineQueryResult.
Definition at line 403 of file InlineQueryResult.hpp.
Member Data Documentation
◆ caption
| std::string tgbotxx::InlineQueryResultVideo::caption |
Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.
Definition at line 379 of file InlineQueryResult.hpp.
◆ captionEntities
| std::vector<Ptr<MessageEntity> > tgbotxx::InlineQueryResultVideo::captionEntities |
Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.
Definition at line 385 of file InlineQueryResult.hpp.
◆ description
| std::string tgbotxx::InlineQueryResultVideo::description |
Optional. Short description of the result.
Definition at line 397 of file InlineQueryResult.hpp.
◆ inputMessageContent
| Ptr<InputMessageContent> tgbotxx::InlineQueryResultVideo::inputMessageContent |
Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
Definition at line 401 of file InlineQueryResult.hpp.
◆ mimeType
| std::string tgbotxx::InlineQueryResultVideo::mimeType |
MIME type of the content of the video URL, “text/html” or “video/mp4”
Definition at line 370 of file InlineQueryResult.hpp.
◆ parseMode
| std::string tgbotxx::InlineQueryResultVideo::parseMode |
Optional. Mode for parsing entities in the video caption. See formatting options for more details.
Definition at line 382 of file InlineQueryResult.hpp.
◆ thumbnailUrl
| std::string tgbotxx::InlineQueryResultVideo::thumbnailUrl |
URL of the thumbnail (JPEG only) for the video.
Definition at line 376 of file InlineQueryResult.hpp.
◆ title
| std::string tgbotxx::InlineQueryResultVideo::title |
Optional. Title for the result.
Definition at line 373 of file InlineQueryResult.hpp.
◆ videoDuration
| std::int32_t tgbotxx::InlineQueryResultVideo::videoDuration {} |
Optional. Video duration in seconds.
Definition at line 394 of file InlineQueryResult.hpp.
◆ videoHeight
| std::int32_t tgbotxx::InlineQueryResultVideo::videoHeight {} |
Optional. Video height.
Definition at line 391 of file InlineQueryResult.hpp.
◆ videoUrl
| std::string tgbotxx::InlineQueryResultVideo::videoUrl |
A valid URL for the embedded video player or video file.
Definition at line 367 of file InlineQueryResult.hpp.
◆ videoWidth
| std::int32_t tgbotxx::InlineQueryResultVideo::videoWidth {} |
Optional. Video width.
Definition at line 388 of file InlineQueryResult.hpp.
The documentation for this struct was generated from the following file:
- include/tgbotxx/objects/InlineQueryResult.hpp
