docs/dev.inmo.tgbotapi.extensions.utils.updates

Package dev.inmo.tgbotapi.extensions.utils.updates

Functions

asCommonMessagesFlow

fun <T : BaseSentMessageUpdate> Flow<T>.asCommonMessagesFlow(): Flow<CommonMessage<*>>

Will map incoming BaseSentMessageUpdates to CommonMessage from BaseSentMessageUpdate.data

asContentMessagesFlow

fun <T : BaseSentMessageUpdate> Flow<T>.asContentMessagesFlow(): Flow<ContentMessage<*>>

Will map incoming BaseSentMessageUpdates to ContentMessage from BaseSentMessageUpdate.data

asDataCallbackQueryFlow

fun Flow<CallbackQueryUpdate>.asDataCallbackQueryFlow(): Flow<DataCallbackQuery>

asGameShortNameCallbackQueryFlow

fun Flow<CallbackQueryUpdate>.asGameShortNameCallbackQueryFlow(): Flow<GameShortNameCallbackQuery>

asUnknownCallbackQueryFlow

fun Flow<CallbackQueryUpdate>.asUnknownCallbackQueryFlow(): Flow<UnknownCallbackQueryType>

asUnknownMessagesFlow

fun <T : BaseSentMessageUpdate> Flow<T>.asUnknownMessagesFlow(): Flow<UnknownMessageType>

Will map incoming BaseSentMessageUpdates to UnknownMessageType from BaseSentMessageUpdate.data

inline fun <T : BaseSentMessageUpdate> Flow<T>.chatEvents(): Flow<ChatEventMessage<*>>

convertWithMediaGroupUpdates

fun List<Update>.convertWithMediaGroupUpdates(): List<Update>

Will convert incoming list of updates to list with MediaGroupUpdates

filterBaseMessageUpdatesByChat

fun <T : BaseMessageUpdate> Flow<T>.filterBaseMessageUpdatesByChat(chat: Chat): Flow<T>

Flow.filter incoming BaseMessageUpdates by their ChatId using Chat.id of chat

filterBaseMessageUpdatesByChatId

fun <T : BaseMessageUpdate> Flow<T>.filterBaseMessageUpdatesByChatId(chatId: ChatId): Flow<T>

Flow.filter incoming BaseMessageUpdates by their ChatId

filterCommandsInsideTextMessages

fun <T : BaseSentMessageUpdate> Flow<T>.filterCommandsInsideTextMessages(commandRegex: Regex): Flow<ContentMessage<TextContent>>

Convert incoming dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content of messages with fullEntitiesList and check that incoming message contains BotCommandTextSource. Besides, it is checking that BotCommandTextSource.command with incoming commandRegex

filterCommandsWithArgs

fun <T : BaseSentMessageUpdate> Flow<T>.filterCommandsWithArgs(commandRegex: Regex): Flow<Pair<ContentMessage<TextContent>, TextSourcesList>>

Convert incoming dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content of messages with fullEntitiesList and check that incoming message contains first TextSource as BotCommandTextSource. Besides, it is checking that BotCommandTextSource.command with incoming commandRegex and for other TextSource objects used next rules: all incoming text sources will be passed as is, RegularTextSource will be split by " " for several RegularTextSource which will contains not empty args without spaces.

filterExactCommands

fun <T : BaseSentMessageUpdate> Flow<T>.filterExactCommands(commandRegex: Regex): Flow<ContentMessage<TextContent>>

Convert incoming dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content of messages with fullEntitiesList and check that incoming message contains ONLY ONE TextSource and that is BotCommandTextSource. Besides, it is checking that BotCommandTextSource.command with incoming commandRegex

filterSentMediaGroupUpdatesByChat

fun <T : SentMediaGroupUpdate> Flow<T>.filterSentMediaGroupUpdatesByChat(chat: Chat): Flow<T>

Flow.filter incoming SentMediaGroupUpdates by their ChatId using Chat.id of chat

filterSentMediaGroupUpdatesByChatId

fun <T : SentMediaGroupUpdate> Flow<T>.filterSentMediaGroupUpdatesByChatId(chatId: ChatId): Flow<T>

Flow.filter incoming SentMediaGroupUpdates by their ChatId

flowsUpdatesFilter

inline fun flowsUpdatesFilter(internalChannelsSizes: Int = 100, block: FlowsUpdatesFilter.() -> Unit): FlowsUpdatesFilter

Non-suspendable function for easy-to-use creating of FlowsUpdatesFilter and applying the block to it

lastUpdateIdentifier

fun Update.lastUpdateIdentifier(): UpdateIdentifier

fun List<Update>.lastUpdateIdentifier(): UpdateIdentifier?

onlyBaseChosenInlineResults

fun Flow<ChosenInlineResultUpdate>.onlyBaseChosenInlineResults(): Flow<BaseChosenInlineResult>

onlyBaseChosenInlineResultsWithUpdates

fun Flow<ChosenInlineResultUpdate>.onlyBaseChosenInlineResultsWithUpdates(): Flow<Pair<UpdateIdentifier, BaseChosenInlineResult>>

onlyBaseInlineQueries

fun Flow<InlineQueryUpdate>.onlyBaseInlineQueries(): Flow<BaseInlineQuery>

onlyBaseInlineQueriesWithUpdates

fun Flow<InlineQueryUpdate>.onlyBaseInlineQueriesWithUpdates(): Flow<Pair<UpdateIdentifier, BaseInlineQuery>>

onlyBaseMessageUpdates

fun Flow<Update>.onlyBaseMessageUpdates(): Flow<BaseMessageUpdate>

onlyEditMediaGroupUpdates

fun Flow<MediaGroupUpdate>.onlyEditMediaGroupUpdates(): Flow<EditMediaGroupUpdate>

Converts flow to Flow of EditMediaGroupUpdate

onlyEditMessageUpdates

fun Flow<BaseMessageUpdate>.onlyEditMessageUpdates(): Flow<BaseEditMessageUpdate>

Converts flow to Flow of BaseSentMessageUpdate

onlyLocationChosenInlineResults

fun Flow<ChosenInlineResultUpdate>.onlyLocationChosenInlineResults(): Flow<LocationChosenInlineResult>

onlyLocationChosenInlineResultsWithUpdates

fun Flow<ChosenInlineResultUpdate>.onlyLocationChosenInlineResultsWithUpdates(): Flow<Pair<UpdateIdentifier, LocationChosenInlineResult>>

onlyLocationInlineQueries

fun Flow<InlineQueryUpdate>.onlyLocationInlineQueries(): Flow<LocationInlineQuery>

onlyLocationInlineQueriesWithUpdates

fun Flow<InlineQueryUpdate>.onlyLocationInlineQueriesWithUpdates(): Flow<Pair<UpdateIdentifier, LocationInlineQuery>>

onlyMediaGroupsUpdates

fun Flow<BaseMessageUpdate>.onlyMediaGroupsUpdates(): Flow<MediaGroupUpdate>

Converts flow to Flow of MediaGroupUpdate. Please, remember that it could be either EditMediaGroupUpdate or SentMediaGroupUpdate

onlySentMediaGroupUpdates

fun Flow<MediaGroupUpdate>.onlySentMediaGroupUpdates(): Flow<SentMediaGroupUpdate>

Converts flow to Flow of SentMediaGroupUpdate

onlySentMessageUpdates

fun Flow<BaseMessageUpdate>.onlySentMessageUpdates(): Flow<BaseSentMessageUpdate>

Converts flow to Flow of BaseSentMessageUpdate

passportMessages

inline fun <T : BaseSentMessageUpdate> Flow<T>.passportMessages(): Flow<PassportMessage>

toEditMediaGroupUpdate

fun BaseEditMessageUpdate.toEditMediaGroupUpdate(): EditMediaGroupUpdate

toSentMediaGroupUpdate

fun List<BaseSentMessageUpdate>.toSentMediaGroupUpdate(): SentMediaGroupUpdate?

toTelegramUpdate

fun String.toTelegramUpdate(): Update

fun JsonElement.toTelegramUpdate(): Update

fun Json.toTelegramUpdate(source: String): Update

fun Json.toTelegramUpdate(source: JsonElement): Update