docs/dev.inmo.tgbotapi.extensions.behaviour_builder/BehaviourContext

BehaviourContext

interface BehaviourContext : FlowsUpdatesFilter, RequestsExecutor, CoroutineScope

This class contains all necessary tools for work with bots and especially for buildBehaviour

Functions

expect abstract fun close()

copy

abstract fun copy(bot: TelegramBot = this.bot, scope: CoroutineScope = this.scope, broadcastChannelsSize: Int = 100, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND, upstreamUpdatesFlow: Flow<Update>? = null, updatesFilter: BehaviourContextAndTypeReceiver<Boolean, Update>? = null): BehaviourContext

execute

abstract suspend fun <T : Any> execute(request: Request<T>): T

Unsafe execution of incoming request. Can throw almost any exception. So, it is better to use something like dev.inmo.tgbotapi.extensions.utils.shortcuts.executeAsync or dev.inmo.tgbotapi.extensions.utils.shortcuts.executeUnsafe

Properties

allowedUpdates

open override val allowedUpdates: List<String>

allUpdatesFlow

abstract val allUpdatesFlow: Flow<Update>

allUpdatesWithoutMediaGroupsGroupingFlow

abstract val allUpdatesWithoutMediaGroupsGroupingFlow: Flow<Update>

asUpdateReceiver

abstract val asUpdateReceiver: UpdateReceiver<Update>

bot

open val bot: TelegramBot

callbackQueriesFlow

abstract val callbackQueriesFlow: Flow<CallbackQueryUpdate>

channelPostMediaGroupsFlow

abstract val channelPostMediaGroupsFlow: Flow<ChannelPostMediaGroupUpdate>

channelPostsFlow

abstract val channelPostsFlow: Flow<ChannelPostUpdate>

chatJoinRequestUpdateFlow

abstract val chatJoinRequestUpdateFlow: Flow<ChatJoinRequestUpdate>

chatMemberUpdatesFlow

abstract val chatMemberUpdatesFlow: Flow<CommonChatMemberUpdatedUpdate>

chosenInlineResultsFlow

abstract val chosenInlineResultsFlow: Flow<ChosenInlineResultUpdate>

coroutineContext

abstract val coroutineContext: CoroutineContext

editedChannelPostMediaGroupsFlow

abstract val editedChannelPostMediaGroupsFlow: Flow<EditChannelPostMediaGroupUpdate>

editedChannelPostsFlow

abstract val editedChannelPostsFlow: Flow<EditChannelPostUpdate>

editedMessageMediaGroupsFlow

abstract val editedMessageMediaGroupsFlow: Flow<EditMessageMediaGroupUpdate>

editedMessagesFlow

abstract val editedMessagesFlow: Flow<EditMessageUpdate>

flowsUpdatesFilter

open val flowsUpdatesFilter: FlowsUpdatesFilter

This parameter will be used to subscribe on different types of update

inlineQueriesFlow

abstract val inlineQueriesFlow: Flow<InlineQueryUpdate>

messageMediaGroupsFlow

abstract val messageMediaGroupsFlow: Flow<MessageMediaGroupUpdate>

messagesFlow

abstract val messagesFlow: Flow<MessageUpdate>

myChatMemberUpdatesFlow

abstract val myChatMemberUpdatesFlow: Flow<MyChatMemberUpdatedUpdate>

pollAnswersFlow

abstract val pollAnswersFlow: Flow<PollAnswerUpdate>

pollsFlow

abstract val pollsFlow: Flow<PollUpdate>

preCheckoutQueriesFlow

abstract val preCheckoutQueriesFlow: Flow<PreCheckoutQueryUpdate>

scope

open val scope: CoroutineScope

Will be used for creating of some subscriptions inside of methods, updates listening and different other things in context of working with CoroutineScope and coroutines.

shippingQueriesFlow

abstract val shippingQueriesFlow: Flow<ShippingQueryUpdate>

unknownUpdatesFlow

abstract val unknownUpdatesFlow: Flow<UnknownUpdate>

Inheritors

BehaviourContextWithFSM

DefaultBehaviourContextWithFSM

DefaultBehaviourContext

Extensions

doInSubContext

suspend fun <T> BehaviourContext.doInSubContext(stopOnCompletion: Boolean = true, updatesUpstreamFlow: Flow<Update> = allUpdatesFlow, scope: CoroutineScope = LinkedSupervisorScope(), behaviourContextReceiver: BehaviourContextReceiver<T>): T

expectFlow

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

expectOne

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

followLocation

suspend fun BehaviourContext.followLocation(message: ContentMessage<LiveLocationContent>, onLocation: BehaviourContextAndTypeReceiver<Unit, Location>)

Use this extension when you want to follow LiveLocation until it will became StaticLocation. This method is synchronous. You may use something like kotlinx.coroutines.launch or kotlinx.coroutines.async to run it asynchronously

oneOf

suspend fun <O> BehaviourContext.oneOf(deferredActions: Iterable<Deferred<O>>): O

suspend fun <O> BehaviourContext.oneOf(vararg deferredActions: Deferred<O>): O

oneOfActions

suspend fun <O> BehaviourContext.oneOfActions(deferredActions: Iterable<DeferredAction<*, O>>): O

suspend fun <O> BehaviourContext.oneOfActions(vararg deferredActions: DeferredAction<*, O>): O

parallel

suspend fun <T> BehaviourContext.parallel(action: BehaviourContextReceiver<T>): Deferred<T>

stop

fun BehaviourContext.stop()

This method will cancel ALL subsequent contexts, expectations and waiters

waitAnimation

suspend fun BehaviourContext.waitAnimation(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<AnimationContent>>? = null, mapper: CommonMessageToContentMapper<AnimationContent>? = null): List<AnimationContent>

waitAnyInlineQuery

suspend fun BehaviourContext.waitAnyInlineQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<InlineQuery>? = null, mapper: InlineQueryMapper<InlineQuery>? = null): List<InlineQuery>

waitAnyMediaGroupContent

suspend fun BehaviourContext.waitAnyMediaGroupContent(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<MediaGroupContent>>? = null, mapper: CommonMessageToContentMapper<MediaGroupContent>? = null): List<MediaGroupContent>

waitAnyPassportMessages

suspend fun BehaviourContext.waitAnyPassportMessages(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<PassportMessage>? = null, mapper: PassportMessageMapper? = null): List<PassportData>

waitAudio

suspend fun BehaviourContext.waitAudio(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<AudioContent>>? = null, mapper: CommonMessageToContentMapper<AudioContent>? = null): List<AudioContent>

waitAudioMediaGroupContent

suspend fun BehaviourContext.waitAudioMediaGroupContent(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<AudioMediaGroupContent>>? = null, mapper: CommonMessageToContentMapper<AudioMediaGroupContent>? = null): List<AudioMediaGroupContent>

waitBaseChosenInlineResult

suspend fun BehaviourContext.waitBaseChosenInlineResult(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<BaseChosenInlineResult>? = null, mapper: PollMapper<BaseChosenInlineResult>? = null): List<BaseChosenInlineResult>

waitBaseInlineQuery

suspend fun BehaviourContext.waitBaseInlineQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<BaseInlineQuery>? = null, mapper: InlineQueryMapper<BaseInlineQuery>? = null): List<BaseInlineQuery>

waitChannelChatCreatedEvents

suspend fun BehaviourContext.waitChannelChatCreatedEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<ChannelChatCreated>>? = null, mapper: EventMessageToEventMapper<ChannelChatCreated>? = null): List<ChannelChatCreated>

waitChannelEvents

suspend fun BehaviourContext.waitChannelEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<ChannelEvent>>? = null, mapper: EventMessageToEventMapper<ChannelEvent>? = null): List<ChannelEvent>

waitChatEvents

suspend fun BehaviourContext.waitChatEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<ChatEvent>>? = null, mapper: EventMessageToEventMapper<ChatEvent>? = null): List<ChatEvent>

waitChatJoinRequests

suspend fun BehaviourContext.waitChatJoinRequests(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatJoinRequest>? = null, mapper: ChatJoinRequestsMapper? = null): List<ChatJoinRequest>

waitChatMemberUpdated

suspend fun BehaviourContext.waitChatMemberUpdated(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatMemberUpdatedUpdate>? = null, mapper: ChatMemberUpdatedMapper<ChatMemberUpdated>? = null): List<ChatMemberUpdated>

waitChosenInlineResult

suspend fun BehaviourContext.waitChosenInlineResult(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChosenInlineResult>? = null, mapper: ChosenInlineResultMapper<ChosenInlineResult>? = null): List<ChosenInlineResult>

waitCommonChatMemberUpdated

suspend fun BehaviourContext.waitCommonChatMemberUpdated(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonChatMemberUpdatedUpdate>? = null, mapper: ChatMemberUpdatedMapper<ChatMemberUpdated>? = null): List<ChatMemberUpdated>

waitCommonEvents

suspend fun BehaviourContext.waitCommonEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<CommonEvent>>? = null, mapper: EventMessageToEventMapper<CommonEvent>? = null): List<CommonEvent>

waitContact

suspend fun BehaviourContext.waitContact(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<ContactContent>>? = null, mapper: CommonMessageToContentMapper<ContactContent>? = null): List<ContactContent>

waitContentMessage

suspend fun BehaviourContext.waitContentMessage(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<MessageContent>>? = null, mapper: CommonMessageToContentMapper<MessageContent>? = null): List<MessageContent>

waitDataCallbackQuery

suspend fun BehaviourContext.waitDataCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<DataCallbackQuery>? = null, mapper: CallbackQueryMapper<DataCallbackQuery>? = null): List<DataCallbackQuery>

waitDeleteChatPhotoEvents

suspend fun BehaviourContext.waitDeleteChatPhotoEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<DeleteChatPhoto>>? = null, mapper: EventMessageToEventMapper<DeleteChatPhoto>? = null): List<DeleteChatPhoto>

waitDice

suspend fun BehaviourContext.waitDice(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<DiceContent>>? = null, mapper: CommonMessageToContentMapper<DiceContent>? = null): List<DiceContent>

waitDocument

suspend fun BehaviourContext.waitDocument(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<DocumentContent>>? = null, mapper: CommonMessageToContentMapper<DocumentContent>? = null): List<DocumentContent>

waitDocumentMediaGroupContent

suspend fun BehaviourContext.waitDocumentMediaGroupContent(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<DocumentMediaGroupContent>>? = null, mapper: CommonMessageToContentMapper<DocumentMediaGroupContent>? = null): List<DocumentMediaGroupContent>

waitDocumentsGroup

suspend fun BehaviourContext.waitDocumentsGroup(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: MediaGroupFilter<DocumentMediaGroupContent>? = null): List<List<DocumentMediaGroupContent>>

waitEditedAnimation

suspend fun BehaviourContext.waitEditedAnimation(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<AnimationContent>>? = null, mapper: CommonMessageToContentMapper<AnimationContent>? = null): List<AnimationContent>

waitEditedAnyMediaGroupContent

suspend fun BehaviourContext.waitEditedAnyMediaGroupContent(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<MediaGroupContent>>? = null, mapper: CommonMessageToContentMapper<MediaGroupContent>? = null): List<MediaGroupContent>

waitEditedAudio

suspend fun BehaviourContext.waitEditedAudio(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<AudioContent>>? = null, mapper: CommonMessageToContentMapper<AudioContent>? = null): List<AudioContent>

waitEditedAudioMediaGroupContent

suspend fun BehaviourContext.waitEditedAudioMediaGroupContent(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<AudioMediaGroupContent>>? = null, mapper: CommonMessageToContentMapper<AudioMediaGroupContent>? = null): List<AudioMediaGroupContent>

waitEditedContact

suspend fun BehaviourContext.waitEditedContact(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<ContactContent>>? = null, mapper: CommonMessageToContentMapper<ContactContent>? = null): List<ContactContent>

waitEditedContentMessage

suspend fun BehaviourContext.waitEditedContentMessage(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<MessageContent>>? = null, mapper: CommonMessageToContentMapper<MessageContent>? = null): List<MessageContent>

waitEditedDice

suspend fun BehaviourContext.waitEditedDice(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<DiceContent>>? = null, mapper: CommonMessageToContentMapper<DiceContent>? = null): List<DiceContent>

waitEditedDocument

suspend fun BehaviourContext.waitEditedDocument(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<DocumentContent>>? = null, mapper: CommonMessageToContentMapper<DocumentContent>? = null): List<DocumentContent>

waitEditedDocumentMediaGroupContent

suspend fun BehaviourContext.waitEditedDocumentMediaGroupContent(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<DocumentMediaGroupContent>>? = null, mapper: CommonMessageToContentMapper<DocumentMediaGroupContent>? = null): List<DocumentMediaGroupContent>

waitEditedGame

suspend fun BehaviourContext.waitEditedGame(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<GameContent>>? = null, mapper: CommonMessageToContentMapper<GameContent>? = null): List<GameContent>

waitEditedInvoice

suspend fun BehaviourContext.waitEditedInvoice(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<InvoiceContent>>? = null, mapper: CommonMessageToContentMapper<InvoiceContent>? = null): List<InvoiceContent>

waitEditedLiveLocation

suspend fun BehaviourContext.waitEditedLiveLocation(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<LiveLocationContent>>? = null, mapper: CommonMessageToContentMapper<LiveLocationContent>? = null): List<LiveLocationContent>

waitEditedLocation

suspend fun BehaviourContext.waitEditedLocation(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<LocationContent>>? = null, mapper: CommonMessageToContentMapper<LocationContent>? = null): List<LocationContent>

waitEditedMedia

suspend fun BehaviourContext.waitEditedMedia(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<MediaContent>>? = null, mapper: CommonMessageToContentMapper<MediaContent>? = null): List<MediaContent>

waitEditedPhoto

suspend fun BehaviourContext.waitEditedPhoto(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<PhotoContent>>? = null, mapper: CommonMessageToContentMapper<PhotoContent>? = null): List<PhotoContent>

waitEditedStaticLocation

suspend fun BehaviourContext.waitEditedStaticLocation(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<StaticLocationContent>>? = null, mapper: CommonMessageToContentMapper<StaticLocationContent>? = null): List<StaticLocationContent>

waitEditedSticker

suspend fun BehaviourContext.waitEditedSticker(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<StickerContent>>? = null, mapper: CommonMessageToContentMapper<StickerContent>? = null): List<StickerContent>

waitEditedText

suspend fun BehaviourContext.waitEditedText(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<TextContent>>? = null, mapper: CommonMessageToContentMapper<TextContent>? = null): List<TextContent>

waitEditedVenue

suspend fun BehaviourContext.waitEditedVenue(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<VenueContent>>? = null, mapper: CommonMessageToContentMapper<VenueContent>? = null): List<VenueContent>

waitEditedVideo

suspend fun BehaviourContext.waitEditedVideo(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<VideoContent>>? = null, mapper: CommonMessageToContentMapper<VideoContent>? = null): List<VideoContent>

waitEditedVideoNote

suspend fun BehaviourContext.waitEditedVideoNote(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<VideoNoteContent>>? = null, mapper: CommonMessageToContentMapper<VideoNoteContent>? = null): List<VideoNoteContent>

waitEditedVisualMediaGroupContent

suspend fun BehaviourContext.waitEditedVisualMediaGroupContent(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<VisualMediaGroupContent>>? = null, mapper: CommonMessageToContentMapper<VisualMediaGroupContent>? = null): List<VisualMediaGroupContent>

waitEditedVoice

suspend fun BehaviourContext.waitEditedVoice(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<VoiceContent>>? = null, mapper: CommonMessageToContentMapper<VoiceContent>? = null): List<VoiceContent>

waitGame

suspend fun BehaviourContext.waitGame(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<GameContent>>? = null, mapper: CommonMessageToContentMapper<GameContent>? = null): List<GameContent>

waitGameShortNameCallbackQuery

suspend fun BehaviourContext.waitGameShortNameCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<GameShortNameCallbackQuery>? = null, mapper: CallbackQueryMapper<GameShortNameCallbackQuery>? = null): List<GameShortNameCallbackQuery>

waitGroupChatCreatedEvents

suspend fun BehaviourContext.waitGroupChatCreatedEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<GroupChatCreated>>? = null, mapper: EventMessageToEventMapper<GroupChatCreated>? = null): List<GroupChatCreated>

waitGroupEvents

suspend fun BehaviourContext.waitGroupEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<GroupEvent>>? = null, mapper: EventMessageToEventMapper<GroupEvent>? = null): List<GroupEvent>

waitInlineMessageIdCallbackQuery

suspend fun BehaviourContext.waitInlineMessageIdCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<InlineMessageIdCallbackQuery>? = null, mapper: CallbackQueryMapper<InlineMessageIdCallbackQuery>? = null): List<InlineMessageIdCallbackQuery>

waitInlineMessageIdDataCallbackQuery

suspend fun BehaviourContext.waitInlineMessageIdDataCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<InlineMessageIdDataCallbackQuery>? = null, mapper: CallbackQueryMapper<InlineMessageIdDataCallbackQuery>? = null): List<InlineMessageIdDataCallbackQuery>

waitInlineMessageIdGameShortNameCallbackQuery

suspend fun BehaviourContext.waitInlineMessageIdGameShortNameCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<InlineMessageIdGameShortNameCallbackQuery>? = null, mapper: CallbackQueryMapper<InlineMessageIdGameShortNameCallbackQuery>? = null): List<InlineMessageIdGameShortNameCallbackQuery>

waitInvoice

suspend fun BehaviourContext.waitInvoice(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<InvoiceContent>>? = null, mapper: CommonMessageToContentMapper<InvoiceContent>? = null): List<InvoiceContent>

waitLeftChatMemberEvents

suspend fun BehaviourContext.waitLeftChatMemberEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<LeftChatMember>>? = null, mapper: EventMessageToEventMapper<LeftChatMember>? = null): List<LeftChatMember>

waitLiveLocation

suspend fun BehaviourContext.waitLiveLocation(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<LiveLocationContent>>? = null, mapper: CommonMessageToContentMapper<LiveLocationContent>? = null): List<LiveLocationContent>

waitLocation

suspend fun BehaviourContext.waitLocation(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<LocationContent>>? = null, mapper: CommonMessageToContentMapper<LocationContent>? = null): List<LocationContent>

waitLocationChosenInlineResult

suspend fun BehaviourContext.waitLocationChosenInlineResult(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<LocationChosenInlineResult>? = null, mapper: PollMapper<LocationChosenInlineResult>? = null): List<LocationChosenInlineResult>

waitLocationInlineQuery

suspend fun BehaviourContext.waitLocationInlineQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<LocationInlineQuery>? = null, mapper: InlineQueryMapper<LocationInlineQuery>? = null): List<LocationInlineQuery>

waitMedia

suspend fun BehaviourContext.waitMedia(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<MediaContent>>? = null, mapper: CommonMessageToContentMapper<MediaContent>? = null): List<MediaContent>

waitMediaGroup

suspend fun BehaviourContext.waitMediaGroup(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: MediaGroupFilter<MediaGroupContent>? = null): List<List<MediaGroupContent>>

waitMessageAutoDeleteTimerChangedEvents

suspend fun BehaviourContext.waitMessageAutoDeleteTimerChangedEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<MessageAutoDeleteTimerChanged>>? = null, mapper: EventMessageToEventMapper<MessageAutoDeleteTimerChanged>? = null): List<MessageAutoDeleteTimerChanged>

waitMessageCallbackQuery

suspend fun BehaviourContext.waitMessageCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<MessageCallbackQuery>? = null, mapper: CallbackQueryMapper<MessageCallbackQuery>? = null): List<MessageCallbackQuery>

waitMessageDataCallbackQuery

suspend fun BehaviourContext.waitMessageDataCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<MessageDataCallbackQuery>? = null, mapper: CallbackQueryMapper<MessageDataCallbackQuery>? = null): List<MessageDataCallbackQuery>

waitMessageGameShortNameCallbackQuery

suspend fun BehaviourContext.waitMessageGameShortNameCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<MessageGameShortNameCallbackQuery>? = null, mapper: CallbackQueryMapper<MessageGameShortNameCallbackQuery>? = null): List<MessageGameShortNameCallbackQuery>

waitMyChatMemberUpdated

suspend fun BehaviourContext.waitMyChatMemberUpdated(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<MyChatMemberUpdatedUpdate>? = null, mapper: ChatMemberUpdatedMapper<ChatMemberUpdated>? = null): List<ChatMemberUpdated>

waitNewChatMembersEvents

suspend fun BehaviourContext.waitNewChatMembersEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<NewChatMembers>>? = null, mapper: EventMessageToEventMapper<NewChatMembers>? = null): List<NewChatMembers>

waitNewChatPhotoEvents

suspend fun BehaviourContext.waitNewChatPhotoEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<NewChatPhoto>>? = null, mapper: EventMessageToEventMapper<NewChatPhoto>? = null): List<NewChatPhoto>

waitNewChatTitleEvents

suspend fun BehaviourContext.waitNewChatTitleEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<NewChatTitle>>? = null, mapper: EventMessageToEventMapper<NewChatTitle>? = null): List<NewChatTitle>

waitPassportMessages

suspend fun <O> BehaviourContext.waitPassportMessages(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<PassportMessage>? = null, mapper: suspend PassportMessage.() -> O?): List<O>

waitPassportMessagesWith

inline suspend fun <T : EncryptedPassportElement> BehaviourContext.waitPassportMessagesWith(count: Int = 1, initRequest: Request<*>? = null, noinline errorFactory: NullableRequestBuilder<*> = { null }, noinline filter: SimpleFilter<PassportMessage>? = null, noinline mapper: PassportMessageMapper? = null): List<PassportData>

waitPhoto

suspend fun BehaviourContext.waitPhoto(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<PhotoContent>>? = null, mapper: CommonMessageToContentMapper<PhotoContent>? = null): List<PhotoContent>

waitPhotoGallery

suspend fun BehaviourContext.waitPhotoGallery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: MediaGroupFilter<PhotoContent>? = null): List<List<PhotoContent>>

waitPinnedMessageEvents

suspend fun BehaviourContext.waitPinnedMessageEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<PinnedMessage>>? = null, mapper: EventMessageToEventMapper<PinnedMessage>? = null): List<PinnedMessage>

waitPlaylist

suspend fun BehaviourContext.waitPlaylist(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: MediaGroupFilter<AudioMediaGroupContent>? = null): List<List<AudioMediaGroupContent>>

waitPoll

suspend fun BehaviourContext.waitPoll(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<PollContent>>? = null, mapper: CommonMessageToContentMapper<PollContent>? = null): List<PollContent>

waitPollAnswers

suspend fun BehaviourContext.waitPollAnswers(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<PollAnswer>? = null, mapper: PollAnswerMapper? = null): List<PollAnswer>

This wait will be triggered only for stopped polls and polls, which are sent by the bot

waitPollUpdates

suspend fun BehaviourContext.waitPollUpdates(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<Poll>? = null, mapper: PollMapper<Poll>? = null): List<Poll>

This wait will be triggered only for stopped polls and polls, which are sent by the bot

waitPreCheckoutQueries

suspend fun BehaviourContext.waitPreCheckoutQueries(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<PreCheckoutQuery>? = null, mapper: PreCheckoutQueryMapper? = null): List<PreCheckoutQuery>

waitPrivateEvents

suspend fun BehaviourContext.waitPrivateEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<PrivateEvent>>? = null, mapper: EventMessageToEventMapper<PrivateEvent>? = null): List<PrivateEvent>

waitProximityAlertTriggeredEvents

suspend fun BehaviourContext.waitProximityAlertTriggeredEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<ProximityAlertTriggered>>? = null, mapper: EventMessageToEventMapper<ProximityAlertTriggered>? = null): List<ProximityAlertTriggered>

waitPublicChatEvents

suspend fun BehaviourContext.waitPublicChatEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<PublicChatEvent>>? = null, mapper: EventMessageToEventMapper<PublicChatEvent>? = null): List<PublicChatEvent>

waitQuizPollUpdates

suspend fun BehaviourContext.waitQuizPollUpdates(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<QuizPoll>? = null, mapper: PollMapper<QuizPoll>? = null): List<QuizPoll>

This wait will be triggered only for stopped polls and polls, which are sent by the bot

waitRegularPollUpdates

suspend fun BehaviourContext.waitRegularPollUpdates(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<RegularPoll>? = null, mapper: PollMapper<RegularPoll>? = null): List<RegularPoll>

This wait will be triggered only for stopped polls and polls, which are sent by the bot

waitShippingQueries

suspend fun BehaviourContext.waitShippingQueries(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ShippingQuery>? = null, mapper: ShippingQueryMapper? = null): List<ShippingQuery>

waitStaticLocation

suspend fun BehaviourContext.waitStaticLocation(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<StaticLocationContent>>? = null, mapper: CommonMessageToContentMapper<StaticLocationContent>? = null): List<StaticLocationContent>

waitSticker

suspend fun BehaviourContext.waitSticker(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<StickerContent>>? = null, mapper: CommonMessageToContentMapper<StickerContent>? = null): List<StickerContent>

waitSuccessfulPaymentEvents

suspend fun BehaviourContext.waitSuccessfulPaymentEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<SuccessfulPaymentEvent>>? = null, mapper: EventMessageToEventMapper<SuccessfulPaymentEvent>? = null): List<SuccessfulPaymentEvent>

waitSupergroupChatCreatedEvents

suspend fun BehaviourContext.waitSupergroupChatCreatedEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<SupergroupChatCreated>>? = null, mapper: EventMessageToEventMapper<SupergroupChatCreated>? = null): List<SupergroupChatCreated>

waitSupergroupEvents

suspend fun BehaviourContext.waitSupergroupEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<SupergroupEvent>>? = null, mapper: EventMessageToEventMapper<SupergroupEvent>? = null): List<SupergroupEvent>

waitText

suspend fun BehaviourContext.waitText(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<TextContent>>? = null, mapper: CommonMessageToContentMapper<TextContent>? = null): List<TextContent>

waitUnknownCallbackQuery

suspend fun BehaviourContext.waitUnknownCallbackQuery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<UnknownCallbackQueryType>? = null, mapper: CallbackQueryMapper<UnknownCallbackQueryType>? = null): List<UnknownCallbackQueryType>

waitVenue

suspend fun BehaviourContext.waitVenue(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<VenueContent>>? = null, mapper: CommonMessageToContentMapper<VenueContent>? = null): List<VenueContent>

waitVideo

suspend fun BehaviourContext.waitVideo(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = false, filter: SimpleFilter<CommonMessage<VideoContent>>? = null, mapper: CommonMessageToContentMapper<VideoContent>? = null): List<VideoContent>

waitVideoGallery

suspend fun BehaviourContext.waitVideoGallery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: MediaGroupFilter<VideoContent>? = null): List<List<VideoContent>>

waitVideoNote

suspend fun BehaviourContext.waitVideoNote(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<VideoNoteContent>>? = null, mapper: CommonMessageToContentMapper<VideoNoteContent>? = null): List<VideoNoteContent>

waitVisualGallery

suspend fun BehaviourContext.waitVisualGallery(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: MediaGroupFilter<VisualMediaGroupContent>? = null): List<List<VisualMediaGroupContent>>

waitVisualMediaGroupContent

suspend fun BehaviourContext.waitVisualMediaGroupContent(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, includeMediaGroups: Boolean = true, filter: SimpleFilter<CommonMessage<VisualMediaGroupContent>>? = null, mapper: CommonMessageToContentMapper<VisualMediaGroupContent>? = null): List<VisualMediaGroupContent>

waitVoice

suspend fun BehaviourContext.waitVoice(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<CommonMessage<VoiceContent>>? = null, mapper: CommonMessageToContentMapper<VoiceContent>? = null): List<VoiceContent>

waitVoiceChatEndedEvents

suspend fun BehaviourContext.waitVoiceChatEndedEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<VoiceChatEnded>>? = null, mapper: EventMessageToEventMapper<VoiceChatEnded>? = null): List<VoiceChatEnded>

waitVoiceChatEvents

suspend fun BehaviourContext.waitVoiceChatEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<VoiceChatEvent>>? = null, mapper: EventMessageToEventMapper<VoiceChatEvent>? = null): List<VoiceChatEvent>

waitVoiceChatParticipantsInvitedEvents

suspend fun BehaviourContext.waitVoiceChatParticipantsInvitedEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<VoiceChatParticipantsInvited>>? = null, mapper: EventMessageToEventMapper<VoiceChatParticipantsInvited>? = null): List<VoiceChatParticipantsInvited>

waitVoiceChatStartedEvents

suspend fun BehaviourContext.waitVoiceChatStartedEvents(initRequest: Request<*>? = null, errorFactory: NullableRequestBuilder<*> = { null }, count: Int = 1, filter: SimpleFilter<ChatEventMessage<VoiceChatStarted>>? = null, mapper: EventMessageToEventMapper<VoiceChatStarted>? = null): List<VoiceChatStarted>

BehaviourContext

See also

Functions

Properties

Inheritors

Extensions