tgbotapi.behaviour_builder.fsm/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

Inheritors

DefaultBehaviourContextWithFSM

Types

Companion

object Companion

Properties

allowedUpdates

open override val allowedUpdates: List<String>

allUpdatesFlow

abstract val allUpdatesFlow: Flow<Update>

asUpdateReceiver

abstract val asUpdateReceiver: UpdateReceiver<Update>

bot

open val bot: TelegramBot

businessConnectionUpdatesFlow

abstract val businessConnectionUpdatesFlow: Flow<BusinessConnectionUpdate>

businessMessageUpdatesFlow

abstract val businessMessageUpdatesFlow: Flow<BusinessMessageUpdate>

callbackQueriesFlow

abstract val callbackQueriesFlow: Flow<CallbackQueryUpdate>

channelPostMediaGroupsFlow

open val channelPostMediaGroupsFlow: Flow<ChannelPostUpdate>

channelPostsFlow

abstract val channelPostsFlow: Flow<ChannelPostUpdate>

chatBoostRemovedUpdateFlow

abstract val chatBoostRemovedUpdateFlow: Flow<ChatBoostRemovedUpdate>

chatBoostUpdatedUpdateFlow

abstract val chatBoostUpdatedUpdateFlow: Flow<ChatBoostUpdatedUpdate>

chatJoinRequestUpdateFlow

abstract val chatJoinRequestUpdateFlow: Flow<ChatJoinRequestUpdate>

chatMemberUpdatesFlow

abstract val chatMemberUpdatesFlow: Flow<CommonChatMemberUpdatedUpdate>

chatMessageReactionsCountUpdatedUpdateFlow

abstract val chatMessageReactionsCountUpdatedUpdateFlow: Flow<ChatMessageReactionsCountUpdatedUpdate>

chatMessageReactionUpdatedUpdateFlow

abstract val chatMessageReactionUpdatedUpdateFlow: Flow<ChatMessageReactionUpdatedUpdate>

chosenInlineResultsFlow

abstract val chosenInlineResultsFlow: Flow<ChosenInlineResultUpdate>

coroutineContext

abstract val coroutineContext: CoroutineContext

data

abstract val data: BehaviourContextData

deleteBusinessMessageUpdatesFlow

abstract val deleteBusinessMessageUpdatesFlow: Flow<DeletedBusinessMessageUpdate>

editBusinessMessageUpdatesFlow

abstract val editBusinessMessageUpdatesFlow: Flow<EditBusinessMessageUpdate>

editedChannelPostMediaGroupsFlow

open val editedChannelPostMediaGroupsFlow: Flow<EditChannelPostUpdate>

editedChannelPostsFlow

abstract val editedChannelPostsFlow: Flow<EditChannelPostUpdate>

editedMessageMediaGroupsFlow

open val editedMessageMediaGroupsFlow: Flow<EditMessageUpdate>

editedMessagesFlow

abstract val editedMessagesFlow: Flow<EditMessageUpdate>

flowsUpdatesFilter

open val flowsUpdatesFilter: FlowsUpdatesFilter

inlineQueriesFlow

abstract val inlineQueriesFlow: Flow<InlineQueryUpdate>

messageMediaGroupsFlow

open val messageMediaGroupsFlow: Flow<MessageUpdate>

messagesFlow

abstract val messagesFlow: Flow<MessageUpdate>

myChatMemberUpdatesFlow

abstract val myChatMemberUpdatesFlow: Flow<MyChatMemberUpdatedUpdate>

paidMediaPurchasedUpdatesFlow

abstract val paidMediaPurchasedUpdatesFlow: Flow<PaidMediaPurchasedUpdate>

pollAnswersFlow

abstract val pollAnswersFlow: Flow<PollAnswerUpdate>

pollsFlow

abstract val pollsFlow: Flow<PollUpdate>

preCheckoutQueriesFlow

abstract val preCheckoutQueriesFlow: Flow<PreCheckoutQueryUpdate>

scope

open val scope: CoroutineScope

shippingQueriesFlow

abstract val shippingQueriesFlow: Flow<ShippingQueryUpdate>

stateInitialAction

abstract val stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T>

Will be called BEFORE handling of State will be started

subcontextInitialAction

abstract val subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, Update>

triggersHolder

abstract val triggersHolder: TriggersHolder

unknownUpdatesFlow

abstract val unknownUpdatesFlow: Flow<UnknownUpdate>

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

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 abstract fun close()

copy

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

abstract fun copy(bot: TelegramBot = this.bot, scope: CoroutineScope = this.scope, broadcastChannelsSize: Int = 100, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND, upstreamUpdatesFlow: Flow<Update>? = null, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, Update> = {}, triggersHolder: TriggersHolder = this.triggersHolder, stateInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContextWithFSM<T>, Unit, T> = this.stateInitialAction, onStateHandlingErrorHandler: StateHandlingErrorHandler<T> = defaultStateHandlingErrorHandler()): BehaviourContextWithFSM<T>

execute

abstract suspend fun <T : Any> execute(request: Request<T>): 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

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, handlers: List<CheckableHandlerHolder<in T, T>>, onStateHandlingErrorHandler: StateHandlingErrorHandler<T>): T?

onStateOrSubstate

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

start

abstract fun start(scope: CoroutineScope): Job

open suspend fun start(): Job

startChain

abstract suspend fun startChain(state: T)

strictlyOn

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

BehaviourContextWithFSM

See also

Inheritors

Types

Properties

Functions