docs/dev.inmo.tgbotapi.updateshandlers/DefaultFlowsUpdatesFilter

DefaultFlowsUpdatesFilter

class DefaultFlowsUpdatesFilter(broadcastChannelsSize: Int = 100, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND, upstreamUpdatesFlow: Flow<Update>? = null) : AbstractFlowsUpdatesFilter

Constructors

DefaultFlowsUpdatesFilter

fun DefaultFlowsUpdatesFilter(broadcastChannelsSize: Int = 100, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND, upstreamUpdatesFlow: Flow<Update>? = null)

Properties

open override val allowedUpdates: List<String>

open override val allUpdatesFlow: Flow<Update>

asUpdateReceiver

open override val asUpdateReceiver: UpdateReceiver<Update>

callbackQueriesFlow

open override val callbackQueriesFlow: Flow<CallbackQueryUpdate>

channelPostMediaGroupsFlow

open val channelPostMediaGroupsFlow: Flow<ChannelPostUpdate>

channelPostsFlow

open override val channelPostsFlow: Flow<ChannelPostUpdate>

chatJoinRequestUpdateFlow

open override val chatJoinRequestUpdateFlow: Flow<ChatJoinRequestUpdate>

chatMemberUpdatesFlow

open override val chatMemberUpdatesFlow: Flow<CommonChatMemberUpdatedUpdate>

chosenInlineResultsFlow

open override val chosenInlineResultsFlow: Flow<ChosenInlineResultUpdate>

editedChannelPostMediaGroupsFlow

open val editedChannelPostMediaGroupsFlow: Flow<EditChannelPostUpdate>

editedChannelPostsFlow

open override val editedChannelPostsFlow: Flow<EditChannelPostUpdate>

editedMessageMediaGroupsFlow

open val editedMessageMediaGroupsFlow: Flow<EditMessageUpdate>

editedMessagesFlow

open override val editedMessagesFlow: Flow<EditMessageUpdate>

inlineQueriesFlow

open override val inlineQueriesFlow: Flow<InlineQueryUpdate>

messageMediaGroupsFlow

open val messageMediaGroupsFlow: Flow<MessageUpdate>

open override val messagesFlow: Flow<MessageUpdate>

myChatMemberUpdatesFlow

open override val myChatMemberUpdatesFlow: Flow<MyChatMemberUpdatedUpdate>

pollAnswersFlow

open override val pollAnswersFlow: Flow<PollAnswerUpdate>

open override val pollsFlow: Flow<PollUpdate>

preCheckoutQueriesFlow

open override val preCheckoutQueriesFlow: Flow<PreCheckoutQueryUpdate>

shippingQueriesFlow

open override val shippingQueriesFlow: Flow<ShippingQueryUpdate>

unknownUpdatesFlow

open override val unknownUpdatesFlow: Flow<UnknownUpdate>

Extensions

animationMessages

fun FlowsUpdatesFilter.animationMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<AnimationContent>>

fun FlowsUpdatesFilter.audioMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<AudioContent>>

channelCreatedEvents

inline fun FlowsUpdatesFilter.channelCreatedEvents(): Flow<ChannelEventMessage<ChannelChatCreated>>

inline fun FlowsUpdatesFilter.channelEvents(): Flow<ChannelEventMessage<*>>

contactMessages

fun FlowsUpdatesFilter.contactMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<ContactContent>>

deletedChannelPhotoEvents

inline fun FlowsUpdatesFilter.deletedChannelPhotoEvents(): Flow<ChannelEventMessage<DeleteChatPhoto>>

deletedGroupPhotoEvents

inline fun FlowsUpdatesFilter.deletedGroupPhotoEvents(): Flow<GroupEventMessage<DeleteChatPhoto>>

deletedSupergroupPhotoEvents

inline fun FlowsUpdatesFilter.deletedSupergroupPhotoEvents(): Flow<SupergroupEventMessage<DeleteChatPhoto>>

fun FlowsUpdatesFilter.diceMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<DiceContent>>

documentMessages

fun FlowsUpdatesFilter.documentMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<DocumentContent>>

inline fun FlowsUpdatesFilter.events(): Flow<ChatEventMessage<*>>

suspend fun <T> FlowsUpdatesFilter.expectFlow(bot: TelegramBot, initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, cancelRequestFactory: NullableRequestBuilder<*> = { null }, cancelTrigger: suspend (Update) -> Boolean = { cancelRequestFactory(it) != null }, filter: suspend (Update) -> List<T>): Flow<T>

suspend fun <T> FlowsUpdatesFilter.expectOne(bot: TelegramBot, initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, cancelRequestFactory: NullableRequestBuilder<*> = { null }, cancelTrigger: suspend (Update) -> Boolean = { cancelRequestFactory(it) != null }, filter: suspend (Update) -> T?): T

filterChannelEvents

inline fun <T : ChannelEvent> FlowsUpdatesFilter.filterChannelEvents(): Flow<ChannelEventMessage<T>>

filterContentMessages

inline fun <T : MessageContent> FlowsUpdatesFilter.filterContentMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<T>>

filterGroupEvents

inline fun <T : GroupEvent> FlowsUpdatesFilter.filterGroupEvents(): Flow<GroupEventMessage<T>>

filterPrivateEvents

inline fun <T : PrivateEvent> FlowsUpdatesFilter.filterPrivateEvents(): Flow<PrivateEventMessage<T>>

filterSupergroupEvents

inline fun <T : SupergroupEvent> FlowsUpdatesFilter.filterSupergroupEvents(): Flow<SupergroupEventMessage<T>>

fun FlowsUpdatesFilter.gameMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<GameContent>>

groupCreatedEvents

inline fun FlowsUpdatesFilter.groupCreatedEvents(): Flow<GroupEventMessage<GroupChatCreated>>

inline fun FlowsUpdatesFilter.groupEvents(): Flow<GroupEventMessage<*>>

inline fun FlowsUpdatesFilter.imageMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<PhotoContent>>

Shortcut for photoMessages

invoiceMessages

fun FlowsUpdatesFilter.invoiceMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<InvoiceContent>>

leftGroupMemberEvents

inline fun FlowsUpdatesFilter.leftGroupMemberEvents(): Flow<GroupEventMessage<LeftChatMember>>

leftSupergroupMemberEvents

inline fun FlowsUpdatesFilter.leftSupergroupMemberEvents(): Flow<SupergroupEventMessage<LeftChatMember>>

locationMessages

fun FlowsUpdatesFilter.locationMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<LocationContent>>

newChannelPhotoEvents

inline fun FlowsUpdatesFilter.newChannelPhotoEvents(): Flow<ChannelEventMessage<NewChatPhoto>>

newChannelPinnedMessageEvents

inline fun FlowsUpdatesFilter.newChannelPinnedMessageEvents(): Flow<ChannelEventMessage<PinnedMessage>>

newChannelTitleEvents

inline fun FlowsUpdatesFilter.newChannelTitleEvents(): Flow<ChannelEventMessage<NewChatTitle>>

newGroupMembersEvents

inline fun FlowsUpdatesFilter.newGroupMembersEvents(): Flow<GroupEventMessage<NewChatMembers>>

newGroupPhotoEvents

inline fun FlowsUpdatesFilter.newGroupPhotoEvents(): Flow<GroupEventMessage<NewChatPhoto>>

newGroupPinnedMessageEvents

inline fun FlowsUpdatesFilter.newGroupPinnedMessageEvents(): Flow<GroupEventMessage<PinnedMessage>>

newGroupTitleEvents

inline fun FlowsUpdatesFilter.newGroupTitleEvents(): Flow<GroupEventMessage<NewChatTitle>>

newPrivatePinnedMessageEvents

inline fun FlowsUpdatesFilter.newPrivatePinnedMessageEvents(): Flow<PrivateEventMessage<PinnedMessage>>

newSupergroupMembersEvents

inline fun FlowsUpdatesFilter.newSupergroupMembersEvents(): Flow<SupergroupEventMessage<NewChatMembers>>

newSupergroupPhotoEvents

inline fun FlowsUpdatesFilter.newSupergroupPhotoEvents(): Flow<SupergroupEventMessage<NewChatPhoto>>

newSupergroupPinnedMessageEvents

inline fun FlowsUpdatesFilter.newSupergroupPinnedMessageEvents(): Flow<SupergroupEventMessage<PinnedMessage>>

newSupergroupTitleEvents

inline fun FlowsUpdatesFilter.newSupergroupTitleEvents(): Flow<SupergroupEventMessage<NewChatTitle>>

fun FlowsUpdatesFilter.photoMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<PhotoContent>>

fun FlowsUpdatesFilter.pollMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<PollContent>>

inline fun FlowsUpdatesFilter.privateEvents(): Flow<PrivateEventMessage<*>>

proximityAlertTriggeredInGroupEvents

inline fun FlowsUpdatesFilter.proximityAlertTriggeredInGroupEvents(): Flow<GroupEventMessage<ProximityAlertTriggered>>

proximityAlertTriggeredInSupergroupEvents

inline fun FlowsUpdatesFilter.proximityAlertTriggeredInSupergroupEvents(): Flow<SupergroupEventMessage<ProximityAlertTriggered>>

fun FlowsUpdatesFilter.sentMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<MessageContent>>

stickerMessages

fun FlowsUpdatesFilter.stickerMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<StickerContent>>

successfulPaymentInChannelEvents

inline fun FlowsUpdatesFilter.successfulPaymentInChannelEvents(): Flow<ChannelEventMessage<SuccessfulPaymentEvent>>

successfulPaymentInGroupEvents

inline fun FlowsUpdatesFilter.successfulPaymentInGroupEvents(): Flow<GroupEventMessage<SuccessfulPaymentEvent>>

successfulPaymentInPrivateEvents

inline fun FlowsUpdatesFilter.successfulPaymentInPrivateEvents(): Flow<PrivateEventMessage<SuccessfulPaymentEvent>>

successfulPaymentInSupergroupEvents

inline fun FlowsUpdatesFilter.successfulPaymentInSupergroupEvents(): Flow<SupergroupEventMessage<SuccessfulPaymentEvent>>

supergroupCreatedEvents

inline fun FlowsUpdatesFilter.supergroupCreatedEvents(): Flow<SupergroupEventMessage<SupergroupChatCreated>>

supergroupEvents

inline fun FlowsUpdatesFilter.supergroupEvents(): Flow<SupergroupEventMessage<*>>

fun FlowsUpdatesFilter.textMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<TextContent>>

fun FlowsUpdatesFilter.venueMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VenueContent>>

fun FlowsUpdatesFilter.videoMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VideoContent>>

videoNoteMessages

fun FlowsUpdatesFilter.videoNoteMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VideoNoteContent>>

fun FlowsUpdatesFilter.voiceMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VoiceContent>>