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

Telegram Bot API wrapper for Node.js written in TypeScript

import { MessageEntity, InlineKeyboardMarkup, InputMessageContent, ParseMode } from './';
/**
 * ## InlineQueryResultGif
 * Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional
 * caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the
 * animation.
 * @see https://core.telegram.org/bots/api#inlinequeryresultgif
 */
export type InlineQueryResultGif = {
    /**
     * Type of the result, must be gif
     */
    type: 'gif';
    /**
     * Unique identifier for this result, 1-64 bytes
     */
    id: string;
    /**
     * A valid URL for the GIF file. File size must not exceed 1MB
     */
    gif_url: string;
    /**
     * Optional. Width of the GIF
     */
    gif_width?: number;
    /**
     * Optional. Height of the GIF
     */
    gif_height?: number;
    /**
     * Optional. Duration of the GIF in seconds
     */
    gif_duration?: number;
    /**
     * URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
     */
    thumbnail_url: string;
    /**
     * Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to
     * “image/jpeg”
     */
    thumbnail_mime_type: 'image/jpeg' | 'image/gif' | 'video/mp4';
    /**
     * Optional. Title for the result
     */
    title?: string;
    /**
     * Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
     */
    caption?: string;
    /**
     * Optional. Mode for parsing entities in the 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. Inline keyboard attached to the message
     */
    reply_markup?: InlineKeyboardMarkup;
    /**
     * Optional. Content of the message to be sent instead of the GIF animation
     */
    input_message_content?: InputMessageContent;
};