Interface LinkPreviewOptions

Options to be used for generation of a link preview.

interface LinkPreviewOptions {
    @type: "linkPreviewOptions";
    force_large_media?: boolean;
    force_small_media?: boolean;
    is_disabled?: boolean;
    show_above_text?: boolean;
    url: string;
}

Properties

@type force_large_media? force_small_media? is_disabled? show_above_text? url

Properties

@type

@type: "linkPreviewOptions"

Optional force_large_media

force_large_media?: boolean

True, if shown media preview must be large; ignored in secret chats or if the URL isn't explicitly specified.

Optional force_small_media

force_small_media?: boolean

True, if shown media preview must be small; ignored in secret chats or if the URL isn't explicitly specified.

Optional is_disabled

is_disabled?: boolean

True, if link preview must be disabled.

Optional show_above_text

show_above_text?: boolean

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

url

url: string

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

Settings

Member Visibility

Theme

On This Page

@typeforce_large_mediaforce_small_mediais_disabledshow_above_texturl