Package dev.inmo.tgbotapi.extensions.behaviour_builder.expectations

Types

CallbackQueryMapper

common

typealias CallbackQueryMapper<T> = suspend T.() -> T?

ChatMemberUpdatedMapper

common

typealias ChatMemberUpdatedMapper<T> = suspend T.() -> T?

CommonMessageToContentMapper

common

typealias CommonMessageToContentMapper<T> = suspend CommonMessage<T>.() -> T?

EventMessageToEventMapper

common

typealias EventMessageToEventMapper<T> = suspend ChatEventMessage<T>.() -> T?

InlineQueryMapper

common

typealias InlineQueryMapper<T> = suspend T.() -> T?

MediaGroupFilter

common

typealias MediaGroupFilter<T> = suspend List<MediaGroupMessage<T>>.() -> Boolean

NullableRequestBuilder

common

typealias NullableRequestBuilder<T> = suspend (Update) -> Request<T>?

PassportMessageMapper

common

typealias PassportMessageMapper = suspend PassportMessage.() -> PassportData

RequestBuilder

common

typealias RequestBuilder<T> = suspend (Update) -> Request<T>

Functions

expectFlow

common

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>

suspend fun <T> FlowsUpdatesFilter.expectFlow(bot: TelegramBot, 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

common

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

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

waitAnimation

common

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

waitAnyInlineQuery

common

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

waitAnyMediaGroupContent

common

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

waitAnyPassportMessages

common

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

waitAudio

common

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

waitAudioMediaGroupContent

common

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

waitBaseInlineQuery

common

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

waitChannelChatCreatedEvents

common

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

waitChannelEvents

common

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

waitChatEvents

common

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

waitChatMemberUpdated

common

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

waitCommonChatMemberUpdated

common

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

waitCommonEvents

common

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

waitContact

common

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

waitContentMessage

common

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

waitDataCallbackQuery

common

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

waitDeleteChatPhotoEvents

common

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

waitDice

common

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

waitDocument

common

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

waitDocumentMediaGroupContent

common

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

waitDocumentsGroup

common

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

waitGame

common

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

waitGameShortNameCallbackQuery

common

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

waitGroupChatCreatedEvents

common

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

waitGroupEvents

common

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

waitInlineMessageIdCallbackQuery

common

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

waitInlineMessageIdDataCallbackQuery

common

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

waitInlineMessageIdGameShortNameCallbackQuery

common

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

waitInvoice

common

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

waitLeftChatMemberEvents

common

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

waitLocation

common

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

waitLocationInlineQuery

common

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

waitMedia

common

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

waitMediaGroup

common

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

waitMessageAutoDeleteTimerChangedEvents

common

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

waitMessageCallbackQuery

common

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

waitMessageDataCallbackQuery

common

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

waitMessageGameShortNameCallbackQuery

common

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

waitMyChatMemberUpdated

common

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

waitNewChatMembersEvents

common

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

waitNewChatPhotoEvents

common

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

waitNewChatTitleEvents

common

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

waitPassportMessages

common

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

waitPassportMessagesWith

common

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

waitPhoto

common

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

waitPhotoGallery

common

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

waitPinnedMessageEvents

common

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

waitPlaylist

common

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

waitPoll

common

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

waitProximityAlertTriggeredEvents

common

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

waitSticker

common

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

waitSupergroupChatCreatedEvents

common

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

waitSupergroupEvents

common

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

waitText

common

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

waitUnknownCallbackQuery

common

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

waitVenue

common

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

waitVideo

common

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

waitVideoGallery

common

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

waitVideoNote

common

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

waitVisualGallery

common

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

waitVisualMediaGroupContent

common

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

waitVoice

common

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

waitVoiceChatEndedEvents

common

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

waitVoiceChatEvents

common

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

waitVoiceChatParticipantsInvitedEvents

common

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

waitVoiceChatStartedEvents

common

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