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

Package-level declarations

Types

interface BehaviourContext : 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>

BehaviourContextData

data class BehaviourContextData(data: MutableMap<String, Any?> = mutableMapOf()) : MutableMap<String, Any?>

BehaviourContextReceiver

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

CombinedSubcontextInitialAction

class CombinedSubcontextInitialAction(val subactions: List<CombinedSubcontextInitialAction.SubAction>, logger: <Error class: unknown class> = KSLog("CombinedSubcontextInitialAction_${subactions.size}"))

Contains SubActions which will be used in subcontextInitialAction in order they has been passed in subactions.

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: <Error class: unknown class>, val scope: CoroutineScope, broadcastChannelsSize: Int = 100, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND, upstreamUpdatesFlow: Flow<<Error class: unknown class>>? = null, val triggersHolder: TriggersHolder = TriggersHolder(), val data: BehaviourContextData = BehaviourContextData(), val subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>> = {}) : 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

fun <T> Deferred<T>.asAction(): <Error class: unknown class>

BehaviourContext

fun BehaviourContext(bot: <Error class: unknown class>, scope: CoroutineScope, flowsUpdatesFilter: <Error class: unknown class> = FlowsUpdatesFilter(), triggersHolder: TriggersHolder = TriggersHolder(), useDefaultSubcontextInitialAction: Boolean = true, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>> = {}): DefaultBehaviourContext

fun BehaviourContext(bot: <Error class: unknown class>, scope: CoroutineScope, upstreamUpdatesFlow: Flow<<Error class: unknown class>>, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>>, triggersHolder: TriggersHolder = TriggersHolder(), useDefaultSubcontextInitialAction: Boolean = true): DefaultBehaviourContext

inline fun <T> BehaviourContext(bot: <Error class: unknown class>, scope: CoroutineScope, flowsUpdatesFilter: <Error class: unknown class> = FlowsUpdatesFilter(), triggersHolder: TriggersHolder = TriggersHolder(), noinline subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>> = {}, useDefaultSubcontextInitialAction: Boolean = true, crossinline block: BehaviourContext.() -> T): T

inline fun <T> BehaviourContext(bot: <Error class: unknown class>, scope: CoroutineScope, upstreamUpdatesFlow: Flow<<Error class: unknown class>>, triggersHolder: TriggersHolder = TriggersHolder(), noinline subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>> = {}, useDefaultSubcontextInitialAction: Boolean = true, 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 <Error class: unknown class>.buildBehaviour(flowUpdatesFilter: <Error class: unknown class> = FlowsUpdatesFilter(), scope: CoroutineScope = defaultCoroutineScopeProvider(), defaultExceptionsHandler: <Error class: unknown class><Unit>? = null, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>> = {}, useDefaultSubcontextInitialAction: Boolean = true, block: BehaviourContextReceiver<Unit>): BehaviourContext

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

buildBehaviourWithLongPolling

suspend fun <Error class: unknown class>.buildBehaviourWithLongPolling(scope: CoroutineScope = defaultCoroutineScopeProvider(), defaultExceptionsHandler: <Error class: unknown class><Unit>? = null, timeoutSeconds: <Error class: unknown class> = 30, autoDisableWebhooks: Boolean = true, autoSkipTimeoutExceptions: Boolean = true, mediaGroupsDebounceTimeMillis: Long? = 1000, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>> = {}, useDefaultSubcontextInitialAction: Boolean = true, 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.

buildSubcontextInitialAction

inline fun buildSubcontextInitialAction(block: MutableList<CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>>>.() -> Unit): CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>>

Build CombinedSubcontextInitialAction with block and return callback, which appropriate for BehaviourContext builders with subcontextInitialAction argument

buildSubcontextInitialActionWithSubActions

inline fun buildSubcontextInitialActionWithSubActions(block: MutableList<CombinedSubcontextInitialAction.SubAction>.() -> Unit): CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>>

Build CombinedSubcontextInitialAction with block and return callback, which appropriate for BehaviourContext builders with subcontextInitialAction argument

createSubContext

fun <BC : BehaviourContext> BC.createSubContext(scope: CoroutineScope = LinkedSupervisorScope(), triggersHolder: TriggersHolder = this.triggersHolder, updatesUpstreamFlow: Flow<<Error class: unknown class>> = allUpdatesFlow, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BC, Unit, <Error class: unknown class>> = this.subcontextInitialAction): BC

Creates new BehaviourContext using its BehaviourContext.copy method

createSubContextAndDoAsynchronouslyWithUpdatesFilter

suspend fun <T, BC : BehaviourContext> BC.createSubContextAndDoAsynchronouslyWithUpdatesFilter(triggersHolder: TriggersHolder = this.triggersHolder, updatesUpstreamFlow: Flow<<Error class: unknown class>> = allUpdatesFlow, context: <Error class: unknown class> = EmptyCoroutineContext, start: CoroutineStart = CoroutineStart.DEFAULT, additionalSubcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>>? = null, 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<<Error class: unknown class>> = allUpdatesFlow, additionalSubcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>>? = null, 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<<Error class: unknown class>> = allUpdatesFlow, additionalSubcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>>? = null, behaviourContextReceiver: CustomBehaviourContextReceiver<BC, T>): Deferred<T>

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

CustomBehaviourContextAndTypeReceiver

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

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 CoroutineContext

doInNewSubContext

suspend fun <T, BC : BehaviourContext> BC.doInNewSubContext(scope: CoroutineScope = LinkedSupervisorScope(), triggersHolder: TriggersHolder = this.triggersHolder, updatesUpstreamFlow: Flow<<Error class: unknown class>> = allUpdatesFlow, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BC, Unit, <Error class: unknown class>> = this.subcontextInitialAction, behaviourContextReceiver: CustomBehaviourContextReceiver<BC, T>): T

Launch behaviourContextReceiver in context of this as BehaviourContext and as CoroutineContext

launchInNewSubContext

fun <T, BC : BehaviourContext> BC.launchInNewSubContext(scope: CoroutineScope = LinkedSupervisorScope(), triggersHolder: TriggersHolder = this.triggersHolder, updatesUpstreamFlow: Flow<<Error class: unknown class>> = allUpdatesFlow, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BC, Unit, <Error class: unknown class>> = this.subcontextInitialAction, behaviourContextReceiver: CustomBehaviourContextReceiver<BC, T>): Job

Launch behaviourContextReceiver in context of this as BehaviourContext and as CoroutineContext

oneOf

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

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

oneOfActions

suspend fun <O> BehaviourContext.oneOfActions(vararg deferredActions: <Error class: unknown class><out <Error class: unknown class>, O>): <Error class: unknown class>

suspend fun <O> BehaviourContext.oneOfActions(deferredActions: Iterable<<Error class: unknown class><out <Error class: unknown class>, O>>): <Error class: unknown class>

parallel

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: <Error class: unknown class> = FlowsUpdatesFilter(), scope: CoroutineScope? = null, apiUrl: String = telegramBotAPIDefaultUrl, builder: <Error class: unknown class>.() -> Unit = {}, defaultExceptionsHandler: <Error class: unknown class><Unit>? = null, testServer: Boolean = false, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>> = {}, fileLinkUrlMapper: <Error class: unknown class>.(String) -> String = { "${fileBaseUrl}/$it" }, useDefaultSubcontextInitialAction: Boolean = true, block: BehaviourContextReceiver<Unit>): <Error class: unknown class>

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: <Error class: unknown class>.() -> Unit = {}, defaultExceptionsHandler: <Error class: unknown class><Unit>? = null, testServer: Boolean = false, timeoutSeconds: <Error class: unknown class> = 30, autoDisableWebhooks: Boolean = true, autoSkipTimeoutExceptions: Boolean = true, mediaGroupsDebounceTimeMillis: Long? = 1000, subcontextInitialAction: CustomBehaviourContextAndTypeReceiver<BehaviourContext, Unit, <Error class: unknown class>> = {}, fileLinkUrlMapper: <Error class: unknown class>.(String) -> String = { "${fileBaseUrl}/$it" }, useDefaultSubcontextInitialAction: Boolean = true, block: BehaviourContextReceiver<Unit>): <Error class: unknown class><<Error class: unknown class>, 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 fun <T, O> Deferred<T>.withAction(callback: suspend (T) -> O): <Error class: unknown class>