Skip to content

GramIO API Reference / gramio/dist / TelegramLinkPreviewOptions

Interface: TelegramLinkPreviewOptions

Defined in: @gramio/types/out/objects.d.ts:2839

Describes the options used for link preview generation.

Documentation

Properties

PropertyTypeDescriptionDefined in
is_disabled?booleanOptional. True, if the link preview is disabled@gramio/types/out/objects.d.ts:2843
prefer_large_media?booleanOptional. 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@gramio/types/out/objects.d.ts:2855
prefer_small_media?booleanOptional. 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@gramio/types/out/objects.d.ts:2851
show_above_text?booleanOptional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text@gramio/types/out/objects.d.ts:2859
url?stringOptional. URL to use for the link preview. If empty, then the first URL found in the message text will be used@gramio/types/out/objects.d.ts:2847