add full support of link preview customization

2025-09-15 05:09:30 +00:00 · 2024-01-02 22:22:47 +06:00
parent 4e1ecc0e34
commit a01a9910b5
19 changed files with 189 additions and 172 deletions
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/types/DisableWebPagePreview.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/types/DisableWebPagePreview.kt
@@ -1,5 +0,0 @@
-package dev.inmo.tgbotapi.abstracts.types
-
-interface DisableWebPagePreview {
-    val disableWebPagePreview: Boolean?
-}
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/types/LinkPreviewOptionsContainer.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/types/LinkPreviewOptionsContainer.kt
@@ -0,0 +1,12 @@
+package dev.inmo.tgbotapi.abstracts.types
+
+import dev.inmo.tgbotapi.types.LinkPreviewOptions
+
+interface LinkPreviewOptionsContainer {
+    val linkPreviewOptions: LinkPreviewOptions?
+    val disableWebPagePreview: Boolean?
+        get() = linkPreviewOptions ?.isDisabled != true
+}
+
+@Deprecated("Renamed", ReplaceWith("LinkPreviewOptionsContainer", "dev.inmo.tgbotapi.abstracts.types.LinkPreviewOptionsContainer"))
+typealias DisableWebPagePreview = LinkPreviewOptionsContainer
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/edit/abstracts/EditDisableWebPagePreviewMessage.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/edit/abstracts/EditDisableWebPagePreviewMessage.kt
@@ -1,5 +0,0 @@
-package dev.inmo.tgbotapi.requests.edit.abstracts
-
-interface EditDisableWebPagePreviewMessage {
-    val disableWebPagePreview: Boolean?
-}
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/edit/abstracts/EditLinkPreviewOptionsContainer.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/edit/abstracts/EditLinkPreviewOptionsContainer.kt
@@ -0,0 +1,8 @@
+package dev.inmo.tgbotapi.requests.edit.abstracts
+
+import dev.inmo.tgbotapi.abstracts.types.LinkPreviewOptionsContainer
+
+interface EditLinkPreviewOptionsContainer : LinkPreviewOptionsContainer
+
+@Deprecated("Renamed", ReplaceWith("EditLinkPreviewOptionsContainer", "dev.inmo.tgbotapi.requests.edit.abstracts.EditLinkPreviewOptionsContainer"))
+typealias EditDisableWebPagePreviewMessage = EditLinkPreviewOptionsContainer
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/edit/text/EditChatMessageText.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/edit/text/EditChatMessageText.kt
@@ -22,7 +22,7 @@ fun EditChatMessageText(
    messageId: MessageId,
    text: String,
    parseMode: ParseMode? = null,
-    disableWebPagePreview: Boolean? = null,
+    linkPreviewOptions: LinkPreviewOptions? = null,
    replyMarkup: InlineKeyboardMarkup? = null
 ) = EditChatMessageText(
    chatId,
@@ -30,7 +30,7 @@ fun EditChatMessageText(
    text,
    parseMode,
    null,
-    disableWebPagePreview,
+    linkPreviewOptions,
    replyMarkup
 )

@@ -38,7 +38,7 @@ fun EditChatMessageText(
    chatId: ChatIdentifier,
    messageId: MessageId,
    entities: TextSourcesList,
-    disableWebPagePreview: Boolean? = null,
+    linkPreviewOptions: LinkPreviewOptions? = null,
    replyMarkup: InlineKeyboardMarkup? = null
 ) = EditChatMessageText(
    chatId,
@@ -46,7 +46,7 @@ fun EditChatMessageText(
    entities.makeString(),
    null,
    entities.toRawMessageEntities(),
-    disableWebPagePreview,
+    linkPreviewOptions,
    replyMarkup
 )

@@ -62,11 +62,11 @@ data class EditChatMessageText internal constructor(
    override val parseMode: ParseMode? = null,
    @SerialName(entitiesField)
    private val rawEntities: List<RawMessageEntity>? = null,
-    @SerialName(disableWebPagePreviewField)
-    override val disableWebPagePreview: Boolean? = null,
+    @SerialName(linkPreviewOptionsField)
+    override val linkPreviewOptions: LinkPreviewOptions? = null,
    @SerialName(replyMarkupField)
    override val replyMarkup: InlineKeyboardMarkup? = null
-) : EditChatMessage<TextContent>, EditTextChatMessage, EditReplyMessage, EditDisableWebPagePreviewMessage {
+) : EditChatMessage<TextContent>, EditTextChatMessage, EditReplyMessage, EditLinkPreviewOptionsContainer {
    override val textSources: TextSourcesList? by lazy {
        rawEntities ?.asTextSources(text)
    }
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/edit/text/EditInlineMessageText.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/edit/text/EditInlineMessageText.kt
@@ -16,28 +16,28 @@ fun EditInlineMessageText(
    inlineMessageId: InlineMessageIdentifier,
    text: String,
    parseMode: ParseMode? = null,
-    disableWebPagePreview: Boolean? = null,
+    linkPreviewOptions: LinkPreviewOptions? = null,
    replyMarkup: InlineKeyboardMarkup? = null
 ) = EditInlineMessageText(
    inlineMessageId,
    text,
    parseMode,
    null,
-    disableWebPagePreview,
+    linkPreviewOptions,
    replyMarkup
 )

 fun EditInlineMessageText(
    inlineMessageId: InlineMessageIdentifier,
    entities: TextSourcesList,
-    disableWebPagePreview: Boolean? = null,
+    linkPreviewOptions: LinkPreviewOptions? = null,
    replyMarkup: InlineKeyboardMarkup? = null
 ) = EditInlineMessageText(
    inlineMessageId,
    entities.makeString(),
    null,
    entities.toRawMessageEntities(),
-    disableWebPagePreview,
+    linkPreviewOptions,
    replyMarkup
 )

@@ -51,11 +51,11 @@ data class EditInlineMessageText internal constructor(
    override val parseMode: ParseMode? = null,
    @SerialName(entitiesField)
    private val rawEntities: List<RawMessageEntity>? = null,
-    @SerialName(disableWebPagePreviewField)
-    override val disableWebPagePreview: Boolean? = null,
+    @SerialName(linkPreviewOptionsField)
+    override val linkPreviewOptions: LinkPreviewOptions? = null,
    @SerialName(replyMarkupField)
    override val replyMarkup: InlineKeyboardMarkup? = null
-) : EditInlineMessage, EditTextChatMessage, EditReplyMessage, EditDisableWebPagePreviewMessage {
+) : EditInlineMessage, EditTextChatMessage, EditReplyMessage, EditLinkPreviewOptionsContainer {
    override val textSources: TextSourcesList? by lazy {
        rawEntities ?.asTextSources(text)
    }
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/send/SendMessage.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/send/SendMessage.kt
@@ -1,6 +1,6 @@
 package dev.inmo.tgbotapi.requests.send

-import dev.inmo.tgbotapi.abstracts.types.DisableWebPagePreview
+import dev.inmo.tgbotapi.abstracts.types.LinkPreviewOptionsContainer
 import dev.inmo.tgbotapi.requests.send.abstracts.*
 import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.message.textsources.TextSourcesList
@@ -24,7 +24,7 @@ fun SendTextMessage(
    chatId: ChatIdentifier,
    text: String,
    parseMode: ParseMode? = null,
-    disableWebPagePreview: Boolean? = null,
+    linkPreviewOptions: LinkPreviewOptions? = null,
    threadId: MessageThreadId? = chatId.threadId,
    disableNotification: Boolean = false,
    protectContent: Boolean = false,
@@ -37,7 +37,7 @@ fun SendTextMessage(
    parseMode,
    null,
    threadId,
-    disableWebPagePreview,
+    linkPreviewOptions,
    disableNotification,
    protectContent,
    replyToMessageId,
@@ -48,7 +48,7 @@ fun SendTextMessage(
 fun SendTextMessage(
    chatId: ChatIdentifier,
    entities: TextSourcesList,
-    disableWebPagePreview: Boolean? = null,
+    linkPreviewOptions: LinkPreviewOptions? = null,
    threadId: MessageThreadId? = chatId.threadId,
    disableNotification: Boolean = false,
    protectContent: Boolean = false,
@@ -61,7 +61,7 @@ fun SendTextMessage(
    null,
    entities.toRawMessageEntities(),
    threadId,
-    disableWebPagePreview,
+    linkPreviewOptions,
    disableNotification,
    protectContent,
    replyToMessageId,
@@ -81,8 +81,8 @@ data class SendTextMessage internal constructor(
    private val rawEntities: List<RawMessageEntity>? = null,
    @SerialName(messageThreadIdField)
    override val threadId: MessageThreadId? = chatId.threadId,
-    @SerialName(disableWebPagePreviewField)
-    override val disableWebPagePreview: Boolean? = null,
+    @SerialName(linkPreviewOptionsField)
+    override val linkPreviewOptions: LinkPreviewOptions? = null,
    @SerialName(disableNotificationField)
    override val disableNotification: Boolean = false,
    @SerialName(protectContentField)
@@ -96,7 +96,7 @@ data class SendTextMessage internal constructor(
 ) : SendMessageRequest<ContentMessage<TextContent>>,
    ReplyingMarkupSendMessageRequest<ContentMessage<TextContent>>,
    TextableSendMessageRequest<ContentMessage<TextContent>>,
-    DisableWebPagePreview
+    LinkPreviewOptionsContainer
 {
    override val textSources: TextSourcesList? by lazy {
        rawEntities ?.asTextSources(text)
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/Common.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/Common.kt
@@ -202,6 +202,7 @@ const val mediaGroupIdField = "media_group_id"
 const val updateIdField = "update_id"
 const val fromChatIdField = "from_chat_id"
 const val disableWebPagePreviewField = "disable_web_page_preview"
+const val linkPreviewOptionsField = "link_preview_options"
 const val disableNotificationField = "disable_notification"
 const val protectContentField = "protect_content"
 const val replyToMessageIdField = "reply_to_message_id"
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/InlineQueries/InputMessageContent/InputTextMessageContent.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/InlineQueries/InputMessageContent/InputTextMessageContent.kt
@@ -1,7 +1,7 @@
 package dev.inmo.tgbotapi.types.InlineQueries.InputMessageContent

 import dev.inmo.tgbotapi.abstracts.TextedOutput
-import dev.inmo.tgbotapi.abstracts.types.DisableWebPagePreview
+import dev.inmo.tgbotapi.abstracts.types.LinkPreviewOptionsContainer
 import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.message.textsources.TextSourcesList
 import dev.inmo.tgbotapi.types.message.ParseMode
@@ -19,16 +19,16 @@ import kotlinx.serialization.Serializable
 fun InputTextMessageContent(
    text: String,
    parseMode: ParseMode? = null,
-    disableWebPagePreview: Boolean? = null
-) = InputTextMessageContent(text, parseMode, null, disableWebPagePreview)
+    linkPreviewOptions: LinkPreviewOptions? = null
+) = InputTextMessageContent(text, parseMode, null, linkPreviewOptions)

 /**
 * Represents the [InputMessageContent] of a text message to be sent as the result of an inline query.
 */
 fun InputTextMessageContent(
    entities: TextSourcesList,
-    disableWebPagePreview: Boolean? = null
-) = InputTextMessageContent(entities.makeString(), null, entities.toRawMessageEntities(), disableWebPagePreview)
+    linkPreviewOptions: LinkPreviewOptions? = null
+) = InputTextMessageContent(entities.makeString(), null, entities.toRawMessageEntities(), linkPreviewOptions)

@Serializable
 data class InputTextMessageContent internal constructor(
@@ -38,9 +38,9 @@ data class InputTextMessageContent internal constructor(
    override val parseMode: ParseMode? = null,
    @SerialName(entitiesField)
    private val rawEntities: List<RawMessageEntity>? = null,
-    @SerialName(disableWebPagePreviewField)
-    override val disableWebPagePreview: Boolean? = null
-) : TextedOutput, DisableWebPagePreview, InputMessageContent {
+    @SerialName(linkPreviewOptionsField)
+    override val linkPreviewOptions: LinkPreviewOptions? = null
+) : TextedOutput, LinkPreviewOptionsContainer, InputMessageContent {
    override val textSources: TextSourcesList? by lazy {
        rawEntities ?.asTextSources(text)
    }
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/RawMessage.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/RawMessage.kt
@@ -128,6 +128,8 @@ internal data class RawMessage(
    private val passport_data: PassportData? = null,
    private val proximity_alert_triggered: ProximityAlertTriggered? = null,

+    private val link_preview_options: LinkPreviewOptions? = null,
+
    private val reply_markup: InlineKeyboardMarkup? = null
 ) {
    private val content: MessageContent? by lazy {
@@ -141,7 +143,7 @@ internal data class RawMessage(
                messageId,
                story
            )
-            text != null -> TextContent(text, (entities ?: emptyList()).asTextSources(text))
+            text != null -> TextContent(text, (entities ?: emptyList()).asTextSources(text), link_preview_options)
            audio != null -> AudioContent(
                audio,
                caption,
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/content/TextContent.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/content/TextContent.kt
@@ -4,6 +4,7 @@ import dev.inmo.tgbotapi.abstracts.TextedInput
 import dev.inmo.tgbotapi.requests.abstracts.Request
 import dev.inmo.tgbotapi.requests.send.SendTextMessage
 import dev.inmo.tgbotapi.types.ChatIdentifier
+import dev.inmo.tgbotapi.types.LinkPreviewOptions
 import dev.inmo.tgbotapi.types.message.textsources.TextSourcesList
 import dev.inmo.tgbotapi.types.MessageId
 import dev.inmo.tgbotapi.types.MessageThreadId
@@ -15,6 +16,7 @@ import kotlinx.serialization.Serializable
 data class TextContent(
    override val text: String,
    override val textSources: TextSourcesList = emptyList(),
+    val linkPreviewOptions: LinkPreviewOptions? = null
 ) : TextedContent {
    override fun createResend(
        chatId: ChatIdentifier,
@@ -27,7 +29,7 @@ data class TextContent(
    ): Request<ContentMessage<TextContent>> = SendTextMessage(
        chatId,
        textSources,
-        false,
+        linkPreviewOptions,
        messageThreadId,
        disableNotification,
        protectContent,