Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/grammy_types/message.ts>LinkPreviewOptions

Type declarations of the Telegram Bot API.
Latest
interface LinkPreviewOptions
import { type LinkPreviewOptions } from "https://deno.land/x/grammy_types@v3.16.0/message.ts";

Describes the options used for link preview generation.

Properties

optional
is_disabled: boolean

True, if the link preview is disabled

optional
url: string

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

optional
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

optional
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

optional
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