1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-05 07:53:47 +00:00
tgbotapi/docs/dev.inmo.tgbotapi.extensions.utils.updates/index.md
2021-03-17 15:18:37 +00:00

36 KiB

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

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

Functions

Name Summary
asCommonMessagesFlow [common]
Content
fun <T : BaseSentMessageUpdate> <T>.asCommonMessagesFlow(): <CommonMessage<*>>
More info
Will map incoming BaseSentMessageUpdates to CommonMessage from BaseSentMessageUpdate.data


asContentMessagesFlow [common]
Content
fun <T : BaseSentMessageUpdate> <T>.asContentMessagesFlow(): <ContentMessage<*>>
More info
Will map incoming BaseSentMessageUpdates to ContentMessage from BaseSentMessageUpdate.data


asDataCallbackQueryFlow [common]
Content
fun <CallbackQueryUpdate>.asDataCallbackQueryFlow(): <DataCallbackQuery>


asGameShortNameCallbackQueryFlow [common]
Content
fun <CallbackQueryUpdate>.asGameShortNameCallbackQueryFlow(): <GameShortNameCallbackQuery>


asUnknownCallbackQueryFlow [common]
Content
fun <CallbackQueryUpdate>.asUnknownCallbackQueryFlow(): <UnknownCallbackQueryType>


asUnknownMessagesFlow [common]
Content
fun <T : BaseSentMessageUpdate> <T>.asUnknownMessagesFlow(): <UnknownMessageType>
More info
Will map incoming BaseSentMessageUpdates to UnknownMessageType from BaseSentMessageUpdate.data


chatEvents [common]
Content
inline fun <T : BaseSentMessageUpdate> <T>.chatEvents(): <ChatEventMessage<*>>


convertWithMediaGroupUpdates [common]
Content
fun List<Update>.convertWithMediaGroupUpdates(): List<Update>
More info
Will convert incoming list of updates to list with MediaGroupUpdates


filterBaseMessageUpdatesByChat [common]
Content
fun <T : BaseMessageUpdate> <T>.filterBaseMessageUpdatesByChat(chat: Chat): <T>
More info
incoming BaseMessageUpdates by their ChatId using Chat.id of chat


filterBaseMessageUpdatesByChatId [common]
Content
fun <T : BaseMessageUpdate> <T>.filterBaseMessageUpdatesByChatId(chatId: ChatId): <T>
More info
incoming BaseMessageUpdates by their ChatId


filterCommandsInsideTextMessages [common]
Content
fun <T : BaseSentMessageUpdate> <T>.filterCommandsInsideTextMessages(commandRegex: Regex): <ContentMessage<TextContent>>
More info
Convert incoming dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content of messages with fullEntitiesList and check that incoming message contains BotCommandTextSource.


filterCommandsWithArgs [common]
Content
fun <T : BaseSentMessageUpdate> <T>.filterCommandsWithArgs(commandRegex: Regex): <Pair<ContentMessage<TextContent>, List<TextSource>>>
More info
Convert incoming dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content of messages with fullEntitiesList and check that incoming message contains first TextSource as BotCommandTextSource.


filterExactCommands [common]
Content
fun <T : BaseSentMessageUpdate> <T>.filterExactCommands(commandRegex: Regex): <ContentMessage<TextContent>>
More info
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.


filterSentMediaGroupUpdatesByChat [common]
Content
fun <T : SentMediaGroupUpdate> <T>.filterSentMediaGroupUpdatesByChat(chat: Chat): <T>
More info
incoming SentMediaGroupUpdates by their ChatId using Chat.id of chat


filterSentMediaGroupUpdatesByChatId [common]
Content
fun <T : SentMediaGroupUpdate> <T>.filterSentMediaGroupUpdatesByChatId(chatId: ChatId): <T>
More info
incoming SentMediaGroupUpdates by their ChatId


flowsUpdatesFilter [common]
Content
inline fun flowsUpdatesFilter(internalChannelsSizes: Int = 100, block: FlowsUpdatesFilter.() -> Unit): FlowsUpdatesFilter
More info
Non-suspendable function for easy-to-use creating of FlowsUpdatesFilter and applying the block to it


lastUpdateIdentifier [common]
Content
fun Update.lastUpdateIdentifier(): UpdateIdentifier
fun List<Update>.lastUpdateIdentifier(): UpdateIdentifier?


onlyBaseChosenInlineResults [common]
Content
fun <ChosenInlineResultUpdate>.onlyBaseChosenInlineResults(): <BaseChosenInlineResult>


onlyBaseChosenInlineResultsWithUpdates [common]
Content
fun <ChosenInlineResultUpdate>.onlyBaseChosenInlineResultsWithUpdates(): <Pair<UpdateIdentifier, BaseChosenInlineResult>>


onlyBaseInlineQueries [common]
Content
fun <InlineQueryUpdate>.onlyBaseInlineQueries(): <BaseInlineQuery>


onlyBaseInlineQueriesWithUpdates [common]
Content
fun <InlineQueryUpdate>.onlyBaseInlineQueriesWithUpdates(): <Pair<UpdateIdentifier, BaseInlineQuery>>


onlyBaseMessageUpdates [common]
Content
fun <Update>.onlyBaseMessageUpdates(): <BaseMessageUpdate>


onlyEditMediaGroupUpdates [common]
Content
fun <MediaGroupUpdate>.onlyEditMediaGroupUpdates(): <EditMediaGroupUpdate>
More info
Converts flow to of EditMediaGroupUpdate


onlyEditMessageUpdates [common]
Content
fun <BaseMessageUpdate>.onlyEditMessageUpdates(): <BaseEditMessageUpdate>
More info
Converts flow to of BaseSentMessageUpdate


onlyLocationChosenInlineResults [common]
Content
fun <ChosenInlineResultUpdate>.onlyLocationChosenInlineResults(): <LocationChosenInlineResult>


onlyLocationChosenInlineResultsWithUpdates [common]
Content
fun <ChosenInlineResultUpdate>.onlyLocationChosenInlineResultsWithUpdates(): <Pair<UpdateIdentifier, LocationChosenInlineResult>>


onlyLocationInlineQueries [common]
Content
fun <InlineQueryUpdate>.onlyLocationInlineQueries(): <LocationInlineQuery>


onlyLocationInlineQueriesWithUpdates [common]
Content
fun <InlineQueryUpdate>.onlyLocationInlineQueriesWithUpdates(): <Pair<UpdateIdentifier, LocationInlineQuery>>


onlyMediaGroupsUpdates [common]
Content
fun <BaseMessageUpdate>.onlyMediaGroupsUpdates(): <MediaGroupUpdate>
More info
Converts flow to of MediaGroupUpdate.


onlySentMediaGroupUpdates [common]
Content
fun <MediaGroupUpdate>.onlySentMediaGroupUpdates(): <SentMediaGroupUpdate>
More info
Converts flow to of SentMediaGroupUpdate


onlySentMessageUpdates [common]
Content
fun <BaseMessageUpdate>.onlySentMessageUpdates(): <BaseSentMessageUpdate>
More info
Converts flow to of BaseSentMessageUpdate


passportMessages [common]
Content
inline fun <T : BaseSentMessageUpdate> <T>.passportMessages(): <PassportMessage>


toEditMediaGroupUpdate [common]
Content
fun BaseEditMessageUpdate.toEditMediaGroupUpdate(): EditMediaGroupUpdate


toSentMediaGroupUpdate [common]
Content
fun List<BaseSentMessageUpdate>.toSentMediaGroupUpdate(): SentMediaGroupUpdate?


toTelegramUpdate [common]
Content
fun String.toTelegramUpdate(): Update
fun .toTelegramUpdate(): Update
fun .toTelegramUpdate(source: String): Update
fun .toTelegramUpdate(source: ): Update