simbot-component-telegram-type/love.forte.simbot.telegram.type/LinkPreviewOptions

LinkPreviewOptions

@Serializable
data class LinkPreviewOptions(val isDisabled: Boolean? = null, val url: String? = null, val preferSmallMedia: Boolean? = null, val preferLargeMedia: Boolean? = null, val showAboveText: Boolean? = null)(source)

LinkPreviewOptions

Describes the options used for link preview generation.

(auto-generated)

Author

ForteScarlet

Constructors

Link copied to clipboard
constructor(isDisabled: Boolean? = null, url: String? = null, preferSmallMedia: Boolean? = null, preferLargeMedia: Boolean? = null, showAboveText: Boolean? = null)

Properties

Link copied to clipboard
@SerialName(value = "is_disabled")
val isDisabled: Boolean? = null

Optional. True, if the link preview is disabled

Link copied to clipboard
@SerialName(value = "prefer_large_media")
val preferLargeMedia: Boolean? = null

Optional. 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

Link copied to clipboard
@SerialName(value = "prefer_small_media")
val preferSmallMedia: Boolean? = null

Optional. 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

Link copied to clipboard
@SerialName(value = "show_above_text")
val showAboveText: Boolean? = null

Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text

Link copied to clipboard
val url: String? = null

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