BehaviourContextWithFSMBuilder

class BehaviourContextWithFSMBuilder<T : State> : BehaviourContextWithFSM<T>

Functions

add

common

fun add(kClass: KClass, 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

common

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

common

open override fun close()

copy

common

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

execute

common

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

common

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

launchStateHandling

common

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

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

onStateOrSubstate

common

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

start

common

open suspend override fun start(): Job

open override fun start(scope: CoroutineScope): Job

startChain

common

open suspend override fun startChain(state: T)

strictlyOn

common

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

Properties

allowedUpdates

common

open override val allowedUpdates: List<String>

allUpdatesFlow

common

open override val allUpdatesFlow: Flow<Update>

allUpdatesWithoutMediaGroupsGroupingFlow

common

open override val allUpdatesWithoutMediaGroupsGroupingFlow: Flow<Update>

asUpdateReceiver

common

open override val asUpdateReceiver: UpdateReceiver<Update>

bot

common

open override val bot: TelegramBot

callbackQueriesFlow

common

open override val callbackQueriesFlow: Flow<CallbackQueryUpdate>

channelPostMediaGroupsFlow

common

open override val channelPostMediaGroupsFlow: Flow<ChannelPostMediaGroupUpdate>

channelPostsFlow

common

open override val channelPostsFlow: Flow<ChannelPostUpdate>

chatJoinRequestUpdateFlow

common

open override val chatJoinRequestUpdateFlow: Flow<ChatJoinRequestUpdate>

chatMemberUpdatesFlow

common

open override val chatMemberUpdatesFlow: Flow<CommonChatMemberUpdatedUpdate>

chosenInlineResultsFlow

common

open override val chosenInlineResultsFlow: Flow<ChosenInlineResultUpdate>

coroutineContext

common

open override val coroutineContext: CoroutineContext

editedChannelPostMediaGroupsFlow

common

open override val editedChannelPostMediaGroupsFlow: Flow<EditChannelPostMediaGroupUpdate>

editedChannelPostsFlow

common

open override val editedChannelPostsFlow: Flow<EditChannelPostUpdate>

editedMessageMediaGroupsFlow

common

open override val editedMessageMediaGroupsFlow: Flow<EditMessageMediaGroupUpdate>

editedMessagesFlow

common

open override val editedMessagesFlow: Flow<EditMessageUpdate>

flowsUpdatesFilter

common

open override val flowsUpdatesFilter: FlowsUpdatesFilter

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

inlineQueriesFlow

common

open override val inlineQueriesFlow: Flow<InlineQueryUpdate>

messageMediaGroupsFlow

common

open override val messageMediaGroupsFlow: Flow<MessageMediaGroupUpdate>

messagesFlow

common

open override val messagesFlow: Flow<MessageUpdate>

myChatMemberUpdatesFlow

common

open override val myChatMemberUpdatesFlow: Flow<MyChatMemberUpdatedUpdate>

pollAnswersFlow

common

open override val pollAnswersFlow: Flow<PollAnswerUpdate>

pollsFlow

common

open override val pollsFlow: Flow<PollUpdate>

preCheckoutQueriesFlow

common

open override val preCheckoutQueriesFlow: Flow<PreCheckoutQueryUpdate>

scope

common

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

common

open override val shippingQueriesFlow: Flow<ShippingQueryUpdate>

unknownUpdatesFlow

common

open override val unknownUpdatesFlow: Flow<UnknownUpdate>