telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface LinkPreviewOptions

    Describes the options used for link preview generation.

    Telegram Bot API: LinkPreviewOptions

    interface LinkPreviewOptions {
        is_disabled?: boolean;
        prefer_large_media?: boolean;
        prefer_small_media?: boolean;
        show_above_text?: boolean;
        url?: string;
    }
    Index
    is_disabled? prefer_large_media? prefer_small_media? show_above_text? url?
    is_disabled?: boolean

    True, if the link preview is disabled.

    prefer_large_media?: boolean

    True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

    prefer_small_media?: boolean

    True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

    Optionalshow_above_text

    show_above_text?: boolean

    True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text.

    url?: string

    URL to use for the link preview. If empty, then the first URL found in the message text is used.

    Settings
    Member Visibility

    On This Page
    Properties