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

Telegram Bot API wrapper for Node.js written in TypeScript

import { Attachment, InputFile, MessageEntity, ParseMode } from './';
/**
 * ## InputMediaAnimation
 * Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
 * @see https://core.telegram.org/bots/api#inputmediaanimation
 */
export type InputMediaAnimation = {
    /**
     * Type of the result, must be animation
     */
    type: 'animation';
    /**
     * File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL
     * for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using
     * multipart/form-data under <file_attach_name> name. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
     */
    media: string | Attachment;
    /**
     * Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
     * The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not
     * exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be
     * only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using
     * multipart/form-data under <file_attach_name>. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
     */
    thumbnail?: InputFile | string;
    /**
     * Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing
     */
    caption?: string;
    /**
     * Optional. Mode for parsing entities in the animation 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. Animation width
     */
    width?: number;
    /**
     * Optional. Animation height
     */
    height?: number;
    /**
     * Optional. Animation duration in seconds
     */
    duration?: number;
    /**
     * Optional. Pass True if the animation needs to be covered with a spoiler animation
     */
    has_spoiler?: boolean;
};