tgbotapi.behaviour_builder/dev.inmo.tgbotapi.extensions.behaviour_builder

Package-level declarations

Types

interface BehaviourContext : FlowsUpdatesFilter, RequestsExecutor, CoroutineScope

This class contains all necessary tools for work with bots and especially buildBehaviour

typealias BehaviourContextAndTwoTypesReceiver<T, I1, I2> = CustomBehaviourContextAndTwoTypesReceiver<BehaviourContext, T, I1, I2>

BehaviourContextAndTypeReceiver

typealias BehaviourContextAndTypeReceiver<T, I> = CustomBehaviourContextAndTypeReceiver<BehaviourContext, T, I>

BehaviourContextReceiver

typealias BehaviourContextReceiver<T> = CustomBehaviourContextReceiver<BehaviourContext, T>

CustomBehaviourContextAndTwoTypesReceiver

typealias CustomBehaviourContextAndTwoTypesReceiver<BC, T, I1, I2> = suspend BC.(I1, I2) -> T

CustomBehaviourContextAndTypeReceiver

typealias CustomBehaviourContextAndTypeReceiver<BC, T, I> = suspend BC.(I) -> T

CustomBehaviourContextReceiver

typealias CustomBehaviourContextReceiver<BC, T> = suspend BC.() -> T

DefaultBehaviourContext

class DefaultBehaviourContext(val bot: TelegramBot, val scope: CoroutineScope, broadcastChannelsSize: Int = 100, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND, upstreamUpdatesFlow: Flow<Update>? = null, val triggersHolder: TriggersHolder = TriggersHolder()) : AbstractFlowsUpdatesFilter, RequestsExecutor, CoroutineScope, BehaviourContext

Properties

defaultCoroutineScopeProvider

expect var defaultCoroutineScopeProvider: () -> CoroutineScope

This function is used in buildBehaviour extensions to provide default CoroutineScope and allow to avoid all unnecessary parameters except of block

actual var defaultCoroutineScopeProvider: () -> CoroutineScope

Functions

asAction

inline fun <T> Deferred<T>.asAction(): DeferredAction<T, T>

BehaviourContext

fun BehaviourContext(bot: TelegramBot, scope: CoroutineScope, flowsUpdatesFilter: FlowsUpdatesFilter = FlowsUpdatesFilter(), triggersHolder: TriggersHolder = TriggersHolder()): DefaultBehaviourContext

inline fun <T> BehaviourContext(bot: TelegramBot, scope: CoroutineScope, flowsUpdatesFilter: FlowsUpdatesFilter = FlowsUpdatesFilter(), triggersHolder: TriggersHolder = TriggersHolder(), crossinline block: BehaviourContext.() -> T): T

BehaviourContextAndTwoTypesReceiver

inline fun <T, I1, I2> BehaviourContextAndTwoTypesReceiver(noinline block: BehaviourContextAndTwoTypesReceiver<T, I1, I2>): suspend BehaviourContext.(I1, I2) -> T

BehaviourContextAndTypeReceiver

inline fun <T, I> BehaviourContextAndTypeReceiver(noinline block: BehaviourContextAndTypeReceiver<T, I>): suspend BehaviourContext.(I) -> T

BehaviourContextReceiver

inline fun <T> BehaviourContextReceiver(noinline block: BehaviourContextReceiver<T>): suspend BehaviourContext.() -> T

buildBehaviour

suspend fun TelegramBot.buildBehaviour(flowUpdatesFilter: FlowsUpdatesFilter = FlowsUpdatesFilter(), scope: CoroutineScope = defaultCoroutineScopeProvider(), defaultExceptionsHandler: ExceptionHandler<Unit>? = null, block: BehaviourContextReceiver<Unit>): BehaviourContext

Use this method in case you wish to make some additional actions with flowUpdatesFilter.

buildBehaviourWithLongPolling

suspend fun TelegramBot.buildBehaviourWithLongPolling(scope: CoroutineScope = defaultCoroutineScopeProvider(), defaultExceptionsHandler: ExceptionHandler<Unit>? = null, timeoutSeconds: Seconds = 30, autoDisableWebhooks: Boolean = true, autoSkipTimeoutExceptions: Boolean = true, mediaGroupsDebounceTimeMillis: Long? = 1000, block: BehaviourContextReceiver<Unit>): Job

Use this method to build bot behaviour and run it via long polling. In case you wish to get FlowsUpdatesFilter for additional manipulations, you must provide external FlowsUpdatesFilter in other buildBehaviour function.

createSubContext

fun <BC : BehaviourContext> BC.createSubContext(scope: CoroutineScope = LinkedSupervisorScope(), triggersHolder: TriggersHolder = this.triggersHolder, updatesUpstreamFlow: Flow<Update> = allUpdatesFlow): BC

Creates new BehaviourContext using its BehaviourContext.copy method

createSubContextAndDoAsynchronouslyWithUpdatesFilter

suspend fun <T, BC : BehaviourContext> BC.createSubContextAndDoAsynchronouslyWithUpdatesFilter(triggersHolder: TriggersHolder = this.triggersHolder, updatesUpstreamFlow: Flow<Update> = allUpdatesFlow, context: CoroutineContext = EmptyCoroutineContext, start: CoroutineStart = CoroutineStart.DEFAULT, behaviourContextReceiver: CustomBehaviourContextReceiver<BC, T>): Deferred<T>

Uses createSubContextAndDoSynchronouslyWithUpdatesFilter, but wrapping it in async. That means, that execution of this function will be asynchronous and will not block execution of code by default

createSubContextAndDoSynchronouslyWithUpdatesFilter

suspend fun <T, BC : BehaviourContext> BC.createSubContextAndDoSynchronouslyWithUpdatesFilter(triggersHolder: TriggersHolder = this.triggersHolder, updatesUpstreamFlow: Flow<Update> = allUpdatesFlow, behaviourContextReceiver: CustomBehaviourContextReceiver<BC, T>): T

Creates new one BehaviourContext using createSubContext and launches behaviourContextReceiver in a new context using doInContext.

createSubContextAndDoWithUpdatesFilter

suspend fun <T, BC : BehaviourContext> BC.~~createSubContextAndDoWithUpdatesFilter~~(triggersHolder: TriggersHolder = this.triggersHolder, updatesUpstreamFlow: Flow<Update> = allUpdatesFlow, behaviourContextReceiver: CustomBehaviourContextReceiver<BC, T>): Deferred<T>

It is just backward compatibility function which will be removed in next updates.

CustomBehaviourContextReceiver

inline fun <BC, T> CustomBehaviourContextReceiver(noinline block: CustomBehaviourContextReceiver<BC, T>): suspend BC.() -> T

doInContext

suspend fun <T, BC : BehaviourContext> BC.doInContext(behaviourContextReceiver: CustomBehaviourContextReceiver<BC, T>): T

Launch behaviourContextReceiver in context of this as BehaviourContext and as kotlin.coroutines.CoroutineContext

oneOf

suspend fun <O> BehaviourContext.oneOf(vararg deferredActions: Deferred<O>): O

suspend fun <O> BehaviourContext.oneOf(deferredActions: Iterable<Deferred<O>>): O

oneOfActions

suspend fun <O> BehaviourContext.oneOfActions(vararg deferredActions: DeferredAction<*, O>): O

suspend fun <O> BehaviourContext.oneOfActions(deferredActions: Iterable<DeferredAction<*, O>>): O

parallel

suspend fun <T> BehaviourContext.parallel(action: BehaviourContextReceiver<T>): Deferred<T>

stop

fun BehaviourContext.stop()

This method will cancel ALL subsequent contexts, expectations and waiters

telegramBotWithBehaviour

suspend fun telegramBotWithBehaviour(token: String, flowsUpdatesFilter: FlowsUpdatesFilter = FlowsUpdatesFilter(), scope: CoroutineScope? = null, apiUrl: String = telegramBotAPIDefaultUrl, builder: KtorRequestsExecutorBuilder.() -> Unit = {}, defaultExceptionsHandler: ExceptionHandler<Unit>? = null, testServer: Boolean = false, block: BehaviourContextReceiver<Unit>): TelegramBot

Create bot using telegramBot and start listening for updates using buildBehaviour. Use this method in case you wish to make some additional actions with flowsUpdatesFilter.

telegramBotWithBehaviourAndLongPolling

suspend fun telegramBotWithBehaviourAndLongPolling(token: String, scope: CoroutineScope? = null, apiUrl: String = telegramBotAPIDefaultUrl, builder: KtorRequestsExecutorBuilder.() -> Unit = {}, defaultExceptionsHandler: ExceptionHandler<Unit>? = null, testServer: Boolean = false, timeoutSeconds: Seconds = 30, autoDisableWebhooks: Boolean = true, autoSkipTimeoutExceptions: Boolean = true, mediaGroupsDebounceTimeMillis: Long? = 1000, block: BehaviourContextReceiver<Unit>): Pair<TelegramBot, Job>

Create bot using telegramBot and start listening for updates using buildBehaviourWithLongPolling. Use this method in case you wish to make some additional actions with flowsUpdatesFilter.

withAction

infix inline fun <T, O> Deferred<T>.withAction(noinline callback: suspend (T) -> O): DeferredAction<T, O>