Skip to content

LinkPreviewOptions

Describes the options used for link preview generation.

5 fields.

Used by

Fields

is_disabled boolean
True, if the link preview is disabled.

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

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.

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.

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.