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. More...

#include <InlineQueryResultVideo.h>

Inheritance diagram for TgBot::InlineQueryResultVideo:

Public Types
typedef std::shared_ptr< InlineQueryResultVideo >	Ptr

Public Types inherited from TgBot::InlineQueryResult
typedef std::shared_ptr< InlineQueryResult >	Ptr

Public Member Functions
	InlineQueryResultVideo ()

Public Member Functions inherited from TgBot::InlineQueryResult
	InlineQueryResult ()

virtual	~InlineQueryResult ()

Public Attributes
std::string	videoUrl
	A valid URL for the embedded video player or video file.

std::string	mimeType
	Mime type of the content of 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::string	caption
	Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.

std::string	parseMode
	Optional. Mode for parsing entities in the video caption. See https://core.telegram.org/bots/api#formatting-options for more details.

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

std::int32_t	videoWidth
	Optional. Video width.

std::int32_t	videoHeight
	Optional. Video height.

std::int32_t	videoDuration
	Optional. Video duration in seconds.

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

InputMessageContent::Ptr	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).

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 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.

If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using inputMessageContent.

Definition at line 24 of file InlineQueryResultVideo.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<InlineQueryResultVideo> TgBot::InlineQueryResultVideo::Ptr

Definition at line 28 of file InlineQueryResultVideo.h.

Constructor & Destructor Documentation

◆ InlineQueryResultVideo()

TgBot::InlineQueryResultVideo::InlineQueryResultVideo ( )

inline

Definition at line 30 of file InlineQueryResultVideo.h.

Member Data Documentation

◆ caption

std::string TgBot::InlineQueryResultVideo::caption

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

Definition at line 57 of file InlineQueryResultVideo.h.

◆ captionEntities

std::vector<MessageEntity::Ptr> TgBot::InlineQueryResultVideo::captionEntities

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

Definition at line 68 of file InlineQueryResultVideo.h.

◆ description

std::string TgBot::InlineQueryResultVideo::description

Optional. Short description of the result.

Definition at line 88 of file InlineQueryResultVideo.h.

◆ inputMessageContent

InputMessageContent::Ptr 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 94 of file InlineQueryResultVideo.h.

◆ mimeType

std::string TgBot::InlineQueryResultVideo::mimeType

Mime type of the content of video url, “text/html” or “video/mp4”

Definition at line 42 of file InlineQueryResultVideo.h.

◆ parseMode

std::string TgBot::InlineQueryResultVideo::parseMode

Optional. Mode for parsing entities in the video caption. See https://core.telegram.org/bots/api#formatting-options for more details.

Definition at line 63 of file InlineQueryResultVideo.h.

◆ thumbnailUrl

std::string TgBot::InlineQueryResultVideo::thumbnailUrl

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

Definition at line 47 of file InlineQueryResultVideo.h.

◆ title

std::string TgBot::InlineQueryResultVideo::title

Title for the result.

Definition at line 52 of file InlineQueryResultVideo.h.

◆ TYPE

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

static

Definition at line 26 of file InlineQueryResultVideo.h.

◆ videoDuration

std::int32_t TgBot::InlineQueryResultVideo::videoDuration

Optional. Video duration in seconds.

Definition at line 83 of file InlineQueryResultVideo.h.

◆ videoHeight

std::int32_t TgBot::InlineQueryResultVideo::videoHeight

Optional. Video height.

Definition at line 78 of file InlineQueryResultVideo.h.

◆ videoUrl

std::string TgBot::InlineQueryResultVideo::videoUrl

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

Definition at line 37 of file InlineQueryResultVideo.h.

◆ videoWidth

std::int32_t TgBot::InlineQueryResultVideo::videoWidth

Optional. Video width.

Definition at line 73 of file InlineQueryResultVideo.h.

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

include/tgbot/types/InlineQueryResultVideo.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes