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

BehaviourContextWithFSM

interface BehaviourContextWithFSM<T : State> : BehaviourContext, StatesMachine<T>

Interface which combine BehaviourContext and StatesMachine. Subcontext of triggers and states contexts must have one common flow of updates and must not lose updates between updates

Types

Companion

object Companion

Functions

add

abstract fun add(kClass: KClass, strict: Boolean = false, handler: BehaviourWithFSMStateHandler<I, T>)

Add NON STRICT handler to list of available in future BehaviourContextWithFSM. Non strict means that for input State will be used KClass.isInstance and any inheritor of kClass will pass this requirement

addStrict

open fun addStrict(kClass: KClass, handler: BehaviourWithFSMStateHandler<I, T>)

Add STRICT handler to list of available in future BehaviourContextWithFSM. Strict means that for input State will be used State::class == kClass and any State with exactly the same type will pass requirements

expect abstract fun close()

copy

abstract override fun copy(bot: TelegramBot, scope: CoroutineScope, broadcastChannelsSize: Int, onBufferOverflow: BufferOverflow, upstreamUpdatesFlow: Flow<Update>?, updatesFilter: BehaviourContextAndTypeReceiver<Boolean, Update>?): BehaviourContextWithFSM<T>

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

handleState

abstract suspend fun StatesMachine<in T>.handleState(state: T): T?

launchStateHandling

open suspend fun launchStateHandling(state: T, handlers: List<CheckableHandlerHolder<in T, T>>): T?

open suspend fun launchStateHandling(state: T, contextUpdatesFlow: Flow<Update>, handlers: List<BehaviourWithFSMStateHandlerHolder<*, T>>): T?

start

open suspend fun start(): Job

abstract fun start(scope: CoroutineScope): Job

startChain

abstract suspend fun startChain(state: T)

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