typescript-telegram-bot-api/dist/types/InlineQueryResultVideo.d.ts

Telegram Bot API wrapper for Node.js written in TypeScript

import { MessageEntity, InlineKeyboardMarkup, InputMessageContent, ParseMode } from './';
/**
 * ## InlineQueryResultVideo
 * 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.
 * > If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using
 * > input_message_content.
 * @see https://core.telegram.org/bots/api#inlinequeryresultvideo
 */
export type InlineQueryResultVideo = {
    /**
     * Type of the result, must be video
     */
    type: 'video';
    /**
     * Unique identifier for this result, 1-64 bytes
     */
    id: string;
    /**
     * A valid URL for the embedded video player or video file
     */
    video_url: string;
    /**
     * MIME type of the content of the video URL, “text/html” or “video/mp4”
     */
    mime_type: string;
    /**
     * URL of the thumbnail (JPEG only) for the video
     */
    thumbnail_url: string;
    /**
     * Title for the result
     */
    title: string;
    /**
     * Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
     */
    caption?: string;
    /**
     * Optional. Mode for parsing entities in the video caption. See formatting options for more details.
     */
    parse_mode?: ParseMode;
    /**
     * Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
     */
    caption_entities?: MessageEntity[];
    /**
     * Optional. Pass True, if the caption must be shown above the message media
     */
    show_caption_above_media?: boolean;
    /**
     * Optional. Video width
     */
    video_width?: number;
    /**
     * Optional. Video height
     */
    video_height?: number;
    /**
     * Optional. Video duration in seconds
     */
    video_duration?: number;
    /**
     * Optional. Short description of the result
     */
    description?: string;
    /**
     * Optional. Inline keyboard attached to the message
     */
    reply_markup?: InlineKeyboardMarkup;
    /**
     * 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).
     */
    input_message_content?: InputMessageContent;
};