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

DefaultBehaviourContextWithFSM

class DefaultBehaviourContextWithFSM<T : State>(behaviourContext: BehaviourContext, statesManager: StatesManager<T>, handlers: List<BehaviourWithFSMStateHandlerHolder<*, T>>, fallbackHandler: BehaviourWithFSMStateHandlerHolder<T, T>? = null, val stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, 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

constructor(behaviourContext: BehaviourContext, statesManager: StatesManager<T>, handlers: List<BehaviourWithFSMStateHandlerHolder<*, T>>, fallbackHandler: BehaviourWithFSMStateHandlerHolder<T, T>? = null, stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T> = {}, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler())

Properties

allowedUpdates

open override val allowedUpdates: List<String>

allUpdatesFlow

open override val allUpdatesFlow: Flow<Update>

asUpdateReceiver

open override val asUpdateReceiver: UpdateReceiver<Update>

bot

open override val bot: TelegramBot

businessConnectionUpdatesFlow

open override val businessConnectionUpdatesFlow: Flow<BusinessConnectionUpdate>

businessMessageUpdatesFlow

open override val businessMessageUpdatesFlow: Flow<BusinessMessageUpdate>

callbackQueriesFlow

open override val callbackQueriesFlow: Flow<CallbackQueryUpdate>

channelPostMediaGroupsFlow

open override val channelPostMediaGroupsFlow: Flow<ChannelPostUpdate>

channelPostsFlow

open override val channelPostsFlow: Flow<ChannelPostUpdate>

chatBoostRemovedUpdateFlow

open override val chatBoostRemovedUpdateFlow: Flow<ChatBoostRemovedUpdate>

chatBoostUpdatedUpdateFlow

open override val chatBoostUpdatedUpdateFlow: Flow<ChatBoostUpdatedUpdate>

chatJoinRequestUpdateFlow

open override val chatJoinRequestUpdateFlow: Flow<ChatJoinRequestUpdate>

chatMemberUpdatesFlow

open override val chatMemberUpdatesFlow: Flow<CommonChatMemberUpdatedUpdate>

chatMessageReactionsCountUpdatedUpdateFlow

open override val chatMessageReactionsCountUpdatedUpdateFlow: Flow<ChatMessageReactionsCountUpdatedUpdate>

chatMessageReactionUpdatedUpdateFlow

open override val chatMessageReactionUpdatedUpdateFlow: Flow<ChatMessageReactionUpdatedUpdate>

chosenInlineResultsFlow

open override val chosenInlineResultsFlow: Flow<ChosenInlineResultUpdate>

coroutineContext

open override val coroutineContext: CoroutineContext

data

open override val data: BehaviourContextData

deleteBusinessMessageUpdatesFlow

open override val deleteBusinessMessageUpdatesFlow: Flow<DeletedBusinessMessageUpdate>

editBusinessMessageUpdatesFlow

open override val editBusinessMessageUpdatesFlow: Flow<EditBusinessMessageUpdate>

editedChannelPostMediaGroupsFlow

open override val editedChannelPostMediaGroupsFlow: Flow<EditChannelPostUpdate>

editedChannelPostsFlow

open override val editedChannelPostsFlow: Flow<EditChannelPostUpdate>

editedMessageMediaGroupsFlow

open override val editedMessageMediaGroupsFlow: Flow<EditMessageUpdate>

editedMessagesFlow

open override val editedMessagesFlow: Flow<EditMessageUpdate>

flowsUpdatesFilter

open override val flowsUpdatesFilter: FlowsUpdatesFilter

inlineQueriesFlow

open override val inlineQueriesFlow: Flow<InlineQueryUpdate>

messageMediaGroupsFlow

open override val messageMediaGroupsFlow: Flow<MessageUpdate>

messagesFlow

open override val messagesFlow: Flow<MessageUpdate>

myChatMemberUpdatesFlow

open override val myChatMemberUpdatesFlow: Flow<MyChatMemberUpdatedUpdate>

paidMediaPurchasedUpdatesFlow

open override val paidMediaPurchasedUpdatesFlow: Flow<PaidMediaPurchasedUpdate>

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

shippingQueriesFlow

open override val shippingQueriesFlow: Flow<ShippingQueryUpdate>

stateInitialAction

open override val stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T>

Will be called BEFORE handling of State will be started

subcontextInitialAction

open override val subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, Update>

triggersHolder

open override val triggersHolder: TriggersHolder

unknownUpdatesFlow

open override val unknownUpdatesFlow: Flow<UnknownUpdate>

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

buildBehaviourWithFSM

suspend fun <T : State> TelegramBot.buildBehaviourWithFSM(flowUpdatesFilter: FlowsUpdatesFilter, scope: CoroutineScope = defaultCoroutineScopeProvider(), defaultExceptionsHandler: ExceptionHandler<Unit>? = null, statesManager: StatesManager<T> = DefaultStatesManager(InMemoryDefaultStatesManagerRepo()), presetHandlers: List<BehaviourWithFSMStateHandlerHolder<*, T>> = listOf(), fallbackHandler: BehaviourWithFSMStateHandlerHolder<T, T>? = null, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler(), subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, Update> = {}, stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T> = {}, block: CustomBehaviourContextReceiver<DefaultBehaviourContextWithFSM<T>, Unit>): DefaultBehaviourContextWithFSM<T>

Creates BehaviourContextWithFSM via creating of DefaultBehaviourContext with this as TelegramBot, scope as target scope for that DefaultBehaviourContext and FlowsUpdatesFilter.allUpdatesFlow of flowUpdatesFilter as DefaultBehaviourContext.upstreamUpdatesFlow. Pass statesManager to customize some internal logic of states changes. Pass presetHandlers in case you have some list of BehaviourWithFSMStateHandlerHolder with presets. Use this method in case you wish to make some additional actions with flowUpdatesFilter.

suspend fun <T : State> TelegramBot.buildBehaviourWithFSM(upstreamUpdatesFlow: Flow<Update>? = null, scope: CoroutineScope = defaultCoroutineScopeProvider(), defaultExceptionsHandler: ExceptionHandler<Unit>? = null, statesManager: StatesManager<T> = DefaultStatesManager(InMemoryDefaultStatesManagerRepo()), presetHandlers: List<BehaviourWithFSMStateHandlerHolder<*, T>> = listOf(), fallbackHandler: BehaviourWithFSMStateHandlerHolder<T, T>? = null, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler(), subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, Update> = {}, stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T> = {}, block: CustomBehaviourContextReceiver<DefaultBehaviourContextWithFSM<T>, Unit>): DefaultBehaviourContextWithFSM<T>

Creates BehaviourContextWithFSM via creating of DefaultBehaviourContext with this as TelegramBot, scope as target scope for that DefaultBehaviourContext and upstreamUpdatesFlow. Pass statesManager to customize some internal logic of states changes. Pass presetHandlers in case you have some list of BehaviourWithFSMStateHandlerHolder with presets.

buildBehaviourWithFSMAndStartLongPolling

suspend fun <T : State> TelegramBot.buildBehaviourWithFSMAndStartLongPolling(scope: CoroutineScope = defaultCoroutineScopeProvider(), defaultExceptionsHandler: ExceptionHandler<Unit>? = null, statesManager: StatesManager<T> = DefaultStatesManager(InMemoryDefaultStatesManagerRepo()), presetHandlers: List<BehaviourWithFSMStateHandlerHolder<*, T>> = listOf(), fallbackHandler: BehaviourWithFSMStateHandlerHolder<T, T>? = null, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler(), timeoutSeconds: Seconds = 30, autoDisableWebhooks: Boolean = true, autoSkipTimeoutExceptions: Boolean = true, mediaGroupsDebounceTimeMillis: Long? = 1000, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, Update> = {}, stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T> = {}, block: CustomBehaviourContextReceiver<DefaultBehaviourContextWithFSM<T>, Unit>): Job

suspend fun <T : State> TelegramBot.buildBehaviourWithFSMAndStartLongPolling(upstreamUpdatesFlow: Flow<Update>? = null, scope: CoroutineScope = defaultCoroutineScopeProvider(), defaultExceptionsHandler: ExceptionHandler<Unit>? = null, statesManager: StatesManager<T> = DefaultStatesManager(InMemoryDefaultStatesManagerRepo()), presetHandlers: List<BehaviourWithFSMStateHandlerHolder<*, T>> = listOf(), fallbackHandler: BehaviourWithFSMStateHandlerHolder<T, T>? = null, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler(), timeoutSeconds: Seconds = 30, autoDisableWebhooks: Boolean = true, autoSkipTimeoutExceptions: Boolean = true, mediaGroupsDebounceTimeMillis: Long? = 1000, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, Update> = {}, stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T> = {}, block: CustomBehaviourContextReceiver<DefaultBehaviourContextWithFSM<T>, Unit>): Pair<DefaultBehaviourContextWithFSM<T>, Job>

Use buildBehaviourWithFSM to create BehaviourContextWithFSM and launch getting of updates using longPolling. For longPolling will be used result BehaviourContextWithFSM for both parameters flowsUpdatesFilter and scope

expect open override fun close()

copy

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

open override fun copy(bot: TelegramBot, scope: CoroutineScope, broadcastChannelsSize: Int, onBufferOverflow: BufferOverflow, upstreamUpdatesFlow: Flow<Update>?, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, Update>, triggersHolder: TriggersHolder, stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T>, onStateHandlingErrorHandler: StateHandlingErrorHandler<T>): BehaviourContextWithFSM<T>

execute

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

fsm

fun fsm(): DefaultBehaviourContextWithFSM<T>

fsmOrNull

fun <T : State> BehaviourContext.fsmOrNull(): StatesMachine<T>?

Extracting from BehaviourContext.data exists StatesMachine by key DATA_FSM_KEY, which usually some BehaviourContextWithFSM. In case if value absent in BehaviourContext.data will return null

fsmOrThrow

fun <T : State> BehaviourContext.fsmOrThrow(): StatesMachine<T>

Extracting from BehaviourContext.data exists StatesMachine by key DATA_FSM_KEY, which usually some BehaviourContextWithFSM. In case if value absent in BehaviourContext.data will throw NullPointerException

handleState

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

launchStateHandling

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

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

onStateOrSubstate

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

onStateOrSubstate

inline fun BehaviourContextWithFSM<O>.onStateOrSubstate(handler: BehaviourWithFSMStateHandler<I, O>)

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>)

strictlyOn

inline fun BehaviourContextWithFSM<O>.strictlyOn(handler: BehaviourWithFSMStateHandler<I, O>)