LinkPreviewOptions

^{ref / types / LinkPreviewOptions}

Describes the options used for link preview generation.

^Source

Properties

is_disabled

is_disabled?: boolean;

True, if the link preview is disabled

^Source

url

url?: string;

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

^Source

prefer_small_media

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

^Source

prefer_large_media

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

^Source

show_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

^Source