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

DefaultBehaviourContextWithFSM

class DefaultBehaviourContextWithFSM<T : State>( behaviourContext: BehaviourContext, statesManager: StatesManager<T>, handlers: List<BehaviourWithFSMStateHandlerHolder<*, T>>, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler()) : BehaviourContext, BehaviourContextWithFSM<T>

Default realization of BehaviourContextWithFSM. It uses behaviourContext as a base for this object as BehaviourContext, but managing substates contexts updates for avoiding of updates lost between states

Parameters

onStateHandlingErrorHandler

Will be used in case if state handling has not been successfully completed in launchStateHandling

Constructors

DefaultBehaviourContextWithFSM

fun <T : State> DefaultBehaviourContextWithFSM( behaviourContext: BehaviourContext, statesManager: StatesManager<T>, handlers: List<BehaviourWithFSMStateHandlerHolder<*, T>>, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler())

Functions

add

open override fun add( kClass: KClass, strict: Boolean, 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 open override fun close()

copy

open override fun copy( bot: TelegramBot, scope: CoroutineScope, broadcastChannelsSize: Int, onBufferOverflow: BufferOverflow, upstreamUpdatesFlow: Flow<Update>?, triggersHolder: TriggersHolder): DefaultBehaviourContextWithFSM<T>

open fun copy( bot: TelegramBot = this.bot, scope: CoroutineScope = this.scope, broadcastChannelsSize: Int = 100, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND, upstreamUpdatesFlow: Flow<Update>? = null, triggersHolder: TriggersHolder = this.triggersHolder, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler(), updatesFilter: BehaviourContextAndTypeReceiver<Boolean, Update>? = null): BehaviourContextWithFSM<T>

execute

open suspend override 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

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

launchStateHandling

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

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

onStateOrSubstate

inline fun onStateOrSubstate(handler: BehaviourWithFSMStateHandler<I, T>)

start

open suspend fun start(): Job

open override fun start(scope: CoroutineScope): Job

startChain

open suspend override fun startChain(state: T)

strictlyOn

inline fun strictlyOn(handler: BehaviourWithFSMStateHandler<I, T>)

Properties

allowedUpdates

open override val allowedUpdates: List<String>

allUpdatesFlow

open override val allUpdatesFlow: Flow<Update>

allUpdatesWithoutMediaGroupsGroupingFlow

open override val allUpdatesWithoutMediaGroupsGroupingFlow: Flow<Update>

asUpdateReceiver

open override val asUpdateReceiver: UpdateReceiver<Update>

bot

open override val bot: TelegramBot

callbackQueriesFlow

open override val callbackQueriesFlow: Flow<CallbackQueryUpdate>

channelPostMediaGroupsFlow

open override val channelPostMediaGroupsFlow: Flow<ChannelPostMediaGroupUpdate>

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>

coroutineContext

open override val coroutineContext: CoroutineContext

editedChannelPostMediaGroupsFlow

open override val editedChannelPostMediaGroupsFlow: Flow<EditChannelPostMediaGroupUpdate>

editedChannelPostsFlow

open override val editedChannelPostsFlow: Flow<EditChannelPostUpdate>

editedMessageMediaGroupsFlow

open override val editedMessageMediaGroupsFlow: Flow<EditMessageMediaGroupUpdate>

editedMessagesFlow

open override val editedMessagesFlow: Flow<EditMessageUpdate>

flowsUpdatesFilter

open override val flowsUpdatesFilter: FlowsUpdatesFilter

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

inlineQueriesFlow

open override val inlineQueriesFlow: Flow<InlineQueryUpdate>

messageMediaGroupsFlow

open override val messageMediaGroupsFlow: Flow<MessageMediaGroupUpdate>

messagesFlow

open override val messagesFlow: Flow<MessageUpdate>

myChatMemberUpdatesFlow

open override val myChatMemberUpdatesFlow: Flow<MyChatMemberUpdatedUpdate>

pollAnswersFlow

open override val pollAnswersFlow: Flow<PollAnswerUpdate>

pollsFlow

open override val pollsFlow: Flow<PollUpdate>

preCheckoutQueriesFlow

open override val preCheckoutQueriesFlow: Flow<PreCheckoutQueryUpdate>

scope

open override 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

open override val shippingQueriesFlow: Flow<ShippingQueryUpdate>

triggersHolder

open override val triggersHolder: TriggersHolder

unknownUpdatesFlow

open override val unknownUpdatesFlow: Flow<UnknownUpdate>