Merge pull request #615 from InsanusMokrassar/2.1.1

2.1.1

CHANGELOG.md

@@ -1,5 +1,17 @@
 # TelegramBotAPI changelog
 
+## 2.1.1
+
+* `API`:
+  * Now it is possible to edit any message text via `editMessageText` (but with warning)
+  * Now it is possible to edit any message caption via `editMessageCaption` (but with warning)
+  * Media message caption edit method (`editMessageCaption`) now returns the message with the same generic type (as it must be in telegram system)
+  * New extensions `TelegramBot#edit` has been added for all possible editions types
+  * New extensions `TelegramBot#send` has been added for all possible sending types
+  * New extensions `TelegramBot#delete` has been added
+* `Versions`:
+    * `MicroUtils`: `0.11.3` -> `0.11.6`
+
 ## 2.1.0
 
 __This update contains including of [Telegram Bot API 6.1](https://core.telegram.org/bots/api-changelog#june-20-2022)__

gradle.properties

@@ -12,7 +12,7 @@ korlibs_version=2.7.0
 uuid_version=0.4.1
 ktor_version=2.0.2
 
-micro_utils_version=0.11.3
+micro_utils_version=0.11.6
 
 javax_activation_version=1.1.1
 
@@ -20,6 +20,6 @@ javax_activation_version=1.1.1
 dokka_version=1.6.21
 
 library_group=dev.inmo
-library_version=2.1.0
+library_version=2.1.1
 
 github_release_plugin_version=2.4.1

tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/DeleteMessage.kt

@@ -23,6 +23,20 @@ suspend fun TelegramBot.deleteMessage(
     message: Message
 ) = deleteMessage(message.chat, message.messageId)
 
+suspend fun TelegramBot.delete(
+    chatId: ChatIdentifier,
+    messageId: MessageIdentifier
+) = deleteMessage(chatId, messageId)
+
+suspend fun TelegramBot.delete(
+    chat: Chat,
+    messageId: MessageIdentifier
+) = deleteMessage(chat, messageId)
+
+suspend fun TelegramBot.delete(
+    message: Message
+) = deleteMessage(message)
+
 suspend fun Message.delete(
     requestsExecutor: TelegramBot
 ) = requestsExecutor.deleteMessage(this)

tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/edit/Edits.kt

@@ -0,0 +1,207 @@
+package dev.inmo.tgbotapi.extensions.api.edit
+
+import dev.inmo.tgbotapi.abstracts.TextedWithTextSources
+import dev.inmo.tgbotapi.bot.TelegramBot
+import dev.inmo.tgbotapi.extensions.api.edit.caption.editMessageCaption
+import dev.inmo.tgbotapi.extensions.api.edit.location.live.editLiveLocation
+import dev.inmo.tgbotapi.extensions.api.edit.media.editMessageMedia
+import dev.inmo.tgbotapi.extensions.api.edit.reply_markup.editMessageReplyMarkup
+import dev.inmo.tgbotapi.extensions.api.edit.text.editMessageText
+import dev.inmo.tgbotapi.types.*
+import dev.inmo.tgbotapi.types.buttons.InlineKeyboardMarkup
+import dev.inmo.tgbotapi.types.chat.Chat
+import dev.inmo.tgbotapi.types.location.LiveLocation
+import dev.inmo.tgbotapi.types.media.TelegramMedia
+import dev.inmo.tgbotapi.types.message.ParseMode
+import dev.inmo.tgbotapi.types.message.abstracts.ContentMessage
+import dev.inmo.tgbotapi.types.message.abstracts.Message
+import dev.inmo.tgbotapi.types.message.content.*
+import dev.inmo.tgbotapi.types.message.textsources.TextSource
+import dev.inmo.tgbotapi.types.message.textsources.TextSourcesList
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun <T> TelegramBot.edit(
+    message: ContentMessage<T>,
+    text: String,
+    parseMode: ParseMode? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+): ContentMessage<T> where T : TextedWithTextSources, T : MediaContent {
+    return editMessageCaption(message, text, parseMode, replyMarkup)
+}
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun <T> TelegramBot.edit(
+    message: ContentMessage<T>,
+    entities: List<TextSource>,
+    replyMarkup: InlineKeyboardMarkup? = null
+): ContentMessage<T> where T : TextedWithTextSources, T : MediaContent {
+    return editMessageCaption(message, entities, replyMarkup)
+}
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    chatId: ChatIdentifier,
+    messageId: MessageIdentifier,
+    latitude: Double,
+    longitude: Double,
+    horizontalAccuracy: Meters? = null,
+    heading: Degrees? = null,
+    proximityAlertRadius: Meters? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editLiveLocation(chatId, messageId, latitude, longitude, horizontalAccuracy, heading, proximityAlertRadius, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    chat: Chat,
+    messageId: MessageIdentifier,
+    latitude: Double,
+    longitude: Double,
+    horizontalAccuracy: Meters? = null,
+    heading: Degrees? = null,
+    proximityAlertRadius: Meters? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editLiveLocation(chat, messageId, latitude, longitude, horizontalAccuracy, heading, proximityAlertRadius, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    message: ContentMessage<LocationContent>,
+    latitude: Double,
+    longitude: Double,
+    horizontalAccuracy: Meters? = null,
+    heading: Degrees? = null,
+    proximityAlertRadius: Meters? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editLiveLocation(message, latitude, longitude, horizontalAccuracy, heading, proximityAlertRadius, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    chatId: ChatIdentifier,
+    messageId: MessageIdentifier,
+    location: LiveLocation,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editLiveLocation(
+    chatId, messageId, location, replyMarkup
+)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    chat: Chat,
+    messageId: MessageIdentifier,
+    location: LiveLocation,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editLiveLocation(chat, messageId, location, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    message: ContentMessage<LocationContent>,
+    location: LiveLocation,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editLiveLocation(message, location, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    chatId: ChatIdentifier,
+    messageId: MessageIdentifier,
+    media: TelegramMedia,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageMedia(chatId, messageId, media, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    chat: Chat,
+    messageId: MessageIdentifier,
+    media: TelegramMedia,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageMedia(chat, messageId, media, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    message: ContentMessage<MediaContent>,
+    media: TelegramMedia,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageMedia(message, media, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    chatId: ChatIdentifier,
+    messageId: MessageIdentifier,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageReplyMarkup(chatId, messageId, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    chat: Chat,
+    messageId: MessageIdentifier,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageReplyMarkup(chat, messageId, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    message: Message,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageReplyMarkup(message, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    message: ContentMessage<TextContent>,
+    text: String,
+    parseMode: ParseMode? = null,
+    disableWebPagePreview: Boolean? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageText(message, text, parseMode, disableWebPagePreview, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    message: ContentMessage<TextContent>,
+    entities: TextSourcesList,
+    disableWebPagePreview: Boolean? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageText(message, entities, disableWebPagePreview, replyMarkup)

tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/edit/caption/EditChatMessageCaption.kt

@@ -11,7 +11,9 @@ import dev.inmo.tgbotapi.types.message.ParseMode
 import dev.inmo.tgbotapi.types.buttons.InlineKeyboardMarkup
 import dev.inmo.tgbotapi.types.chat.Chat
 import dev.inmo.tgbotapi.types.message.abstracts.ContentMessage
+import dev.inmo.tgbotapi.types.message.abstracts.Message
 import dev.inmo.tgbotapi.types.message.content.MediaContent
+import dev.inmo.tgbotapi.utils.RiskFeature
 
 /**
  * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
@@ -48,8 +50,9 @@ suspend fun <T> TelegramBot.editMessageCaption(
     text: String,
     parseMode: ParseMode? = null,
     replyMarkup: InlineKeyboardMarkup? = null
-): ContentMessage<MediaContent> where T : TextedWithTextSources, T : MediaContent {
+): ContentMessage<T> where T : TextedWithTextSources, T : MediaContent {
-    return editMessageCaption(message.chat.id, message.messageId, text, parseMode, replyMarkup)
+    @Suppress("UNCHECKED_CAST")
+    return editMessageCaption(message.chat.id, message.messageId, text, parseMode, replyMarkup) as ContentMessage<T>
 }
 
 /**
@@ -84,6 +87,20 @@ suspend fun <T> TelegramBot.editMessageCaption(
     message: ContentMessage<T>,
     entities: List<TextSource>,
     replyMarkup: InlineKeyboardMarkup? = null
+): ContentMessage<T> where T : TextedWithTextSources, T : MediaContent {
+    @Suppress("UNCHECKED_CAST")
+    return editMessageCaption(message.chat.id, message.messageId, entities, replyMarkup) as ContentMessage<T>
+}
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+@RiskFeature("This method is unsafe due to absence of any guaranties about the type of message. In case if message is not media message this method will throw an exception")
+suspend fun <T> TelegramBot.editMessageCaption(
+    message: Message,
+    entities: List<TextSource>,
+    replyMarkup: InlineKeyboardMarkup? = null
 ): ContentMessage<MediaContent> where T : TextedWithTextSources, T : MediaContent {
     return editMessageCaption(message.chat.id, message.messageId, entities, replyMarkup)
 }

tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/edit/text/EditChatMessageText.kt

@@ -9,7 +9,9 @@ import dev.inmo.tgbotapi.types.message.ParseMode
 import dev.inmo.tgbotapi.types.buttons.InlineKeyboardMarkup
 import dev.inmo.tgbotapi.types.chat.Chat
 import dev.inmo.tgbotapi.types.message.abstracts.ContentMessage
+import dev.inmo.tgbotapi.types.message.abstracts.Message
 import dev.inmo.tgbotapi.types.message.content.TextContent
+import dev.inmo.tgbotapi.utils.RiskFeature
 
 /**
  * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
@@ -87,3 +89,15 @@ suspend fun TelegramBot.editMessageText(
     disableWebPagePreview: Boolean? = null,
     replyMarkup: InlineKeyboardMarkup? = null
 ) = editMessageText(message.chat.id, message.messageId, entities, disableWebPagePreview, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+@RiskFeature("This method is unsafe due to absence of any guaranties about the type of message. In case if message is not text message this method will throw an exception")
+suspend fun TelegramBot.editMessageText(
+    message: Message,
+    entities: TextSourcesList,
+    disableWebPagePreview: Boolean? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageText(message.chat.id, message.messageId, entities, disableWebPagePreview, replyMarkup)

tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/send/SendActionDSL.kt

@@ -22,7 +22,7 @@ suspend fun <T> TelegramBot.withAction(
     contract {
         callsInPlace(block, InvocationKind.EXACTLY_ONCE)
     }
-    val botActionJob = CoroutineScope(coroutineContext).launch {
+    val botActionJob = CoroutineScope(currentCoroutineContext()).launch {
         while (isActive) {
             delay(refreshTime)
             safelyWithoutExceptions {