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

#include <Types.h>

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

Public Attributes
std::string	type { TYPE }
	Type of the result, must be video.
std::string	id { }
	Unique identifier for this result, 1-64 bytes.
std::string	videoUrl { }
	A valid URL for the embedded video player or video file.
std::string	mimeType { }
	MIME type of the content of the video URL, “text/html” or “video/mp4”
std::string	thumbnailUrl { }
	URL of the thumbnail (JPEG only) for the video.
std::string	title { }
	Title for the result.
std::optional< std::string >	caption { }
	Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.
std::optional< std::string >	parseMode { }
	Optional. Mode for parsing entities in the video 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::optional< bool >	showCaptionAboveMedia { }
	Optional. Pass True if the caption must be shown above the message media.
std::optional< std::int32_t >	videoWidth { }
	Optional. Video width.
std::optional< std::int32_t >	videoHeight { }
	Optional. Video height.
std::optional< std::int32_t >	videoDuration { }
	Optional. Video duration in seconds.
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 video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).

Static Public Attributes
static TGBOT_API const std::string	TYPE

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

Definition at line 5300 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 5301 of file Types.h.

Member Data Documentation

◆ caption

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

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

Definition at line 5332 of file Types.h.

◆ captionEntities

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

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

Definition at line 5342 of file Types.h.

◆ description

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

Optional. Short description of the result.

Definition at line 5362 of file Types.h.

◆ id

std::string TgBot::InlineQueryResultVideo::id { }

Unique identifier for this result, 1-64 bytes.

Definition at line 5312 of file Types.h.

◆ inputMessageContent

std::shared_ptr<InputMessageContent> TgBot::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 5372 of file Types.h.

◆ mimeType

std::string TgBot::InlineQueryResultVideo::mimeType { }

MIME type of the content of the video URL, “text/html” or “video/mp4”

Definition at line 5320 of file Types.h.

◆ parseMode

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

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

Definition at line 5337 of file Types.h.

◆ replyMarkup

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

Optional. Inline keyboard attached to the message.

Definition at line 5366 of file Types.h.

◆ showCaptionAboveMedia

std::optional<bool> TgBot::InlineQueryResultVideo::showCaptionAboveMedia { }

Optional. Pass True if the caption must be shown above the message media.

Definition at line 5346 of file Types.h.

◆ thumbnailUrl

std::string TgBot::InlineQueryResultVideo::thumbnailUrl { }

URL of the thumbnail (JPEG only) for the video.

Definition at line 5324 of file Types.h.

◆ title

std::string TgBot::InlineQueryResultVideo::title { }

Title for the result.

Definition at line 5328 of file Types.h.

◆ TYPE

TGBOT_API const std::string TgBot::InlineQueryResultVideo::TYPE

static

Definition at line 5303 of file Types.h.

◆ type

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

Type of the result, must be video.

Definition at line 5308 of file Types.h.

◆ videoDuration

std::optional<std::int32_t> TgBot::InlineQueryResultVideo::videoDuration { }

Optional. Video duration in seconds.

Definition at line 5358 of file Types.h.

◆ videoHeight

std::optional<std::int32_t> TgBot::InlineQueryResultVideo::videoHeight { }

Optional. Video height.

Definition at line 5354 of file Types.h.

◆ videoUrl

std::string TgBot::InlineQueryResultVideo::videoUrl { }

A valid URL for the embedded video player or video file.

Definition at line 5316 of file Types.h.

◆ videoWidth

std::optional<std::int32_t> TgBot::InlineQueryResultVideo::videoWidth { }

Optional. Video width.

Definition at line 5350 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes

Static Public Attributes