mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-12-23 17:17:13 +00:00
46 lines
15 KiB
HTML
46 lines
15 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>buildBehaviourWithFSM</title>
|
|
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script><script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../scripts/main.js" async="async"></script> </head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.extensions.behaviour_builder//buildBehaviourWithFSM/dev.inmo.tgbotapi.bot.RequestsExecutor#kotlinx.coroutines.flow.Flow[dev.inmo.tgbotapi.types.update.abstracts.Update]?#kotlinx.coroutines.CoroutineScope#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]?#dev.inmo.micro_utils.fsm.common.StatesManager[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]#kotlin.collections.MutableList[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourWithFSMStateHandlerHolder[*,TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]]#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContextWithFSMBuilder[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])],kotlin.Unit]/PointingToDeclaration//-1982836883">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../index.html">docs</a>/<a href="index.html">dev.inmo.tgbotapi.extensions.behaviour_builder</a>/<a href="build-behaviour-with-f-s-m.html">buildBehaviourWithFSM</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector common-like" data-active="" data-filter=":docs:dokkaHtml/commonMain">common</button></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>build</span><wbr></wbr><span>Behaviour</span><wbr></wbr><span>With</span><wbr></wbr><span><span>FSM</span></span></h1>
|
|
</div>
|
|
<div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">suspend fun <<a href="build-behaviour-with-f-s-m.html">T</a> : <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span>> <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="build-behaviour-with-f-s-m.html">buildBehaviourWithFSM</a>(upstreamUpdatesFlow: <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>>? = null, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = defaultCoroutineScopeProvider(), defaultExceptionsHandler: <span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>>? = null, statesManager: <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/StatesManager///PointingToDeclaration/">StatesManager</span><<a href="build-behaviour-with-f-s-m.html">T</a>> = DefaultStatesManager(InMemoryDefaultStatesManagerRepo()), presetHandlers: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html">MutableList</a><<a href="-behaviour-with-f-s-m-state-handler-holder/index.html">BehaviourWithFSMStateHandlerHolder</a><*, <a href="build-behaviour-with-f-s-m.html">T</a>>> = mutableListOf(), block: <a href="index.html#-1892390839%2FClasslikes%2F-1982836883">CustomBehaviourContextReceiver</a><<a href="-behaviour-context-with-f-s-m-builder/index.html">BehaviourContextWithFSMBuilder</a><<a href="build-behaviour-with-f-s-m.html">T</a>>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>>): <a href="-behaviour-context-with-f-s-m/index.html">BehaviourContextWithFSM</a><<a href="build-behaviour-with-f-s-m.html">T</a>><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<p class="paragraph">Creates <a href="-behaviour-context-with-f-s-m/index.html">BehaviourContextWithFSM</a> via creating of <a href="-default-behaviour-context/index.html">DefaultBehaviourContext</a> with <span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder//&lt;this&gt;/#/PointingToCallableParameters(-1)/">this</span> as <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>, <a href="build-behaviour-with-f-s-m.html">scope</a> as target scope for that <a href="-default-behaviour-context/index.html">DefaultBehaviourContext</a> and <a href="build-behaviour-with-f-s-m.html">upstreamUpdatesFlow</a>. Pass <a href="build-behaviour-with-f-s-m.html">statesManager</a> to customize some internal logic of states changes. Pass <a href="build-behaviour-with-f-s-m.html">presetHandlers</a> in case you have some list of <a href="-behaviour-with-f-s-m-state-handler-holder/index.html">BehaviourWithFSMStateHandlerHolder</a> with presets.</p><p class="paragraph">!!! WARNING !!! This method WILL NOT call <a href="-behaviour-context-with-f-s-m/start.html">BehaviourContextWithFSM.start</a> of result object and WILL NOT start any updates retrieving. See <a href="build-behaviour-with-f-s-m-and-start-long-polling.html">buildBehaviourWithFSMAndStartLongPolling</a> or <a href="telegram-bot-with-behaviour-and-f-s-m-and-start-long-polling.html">telegramBotWithBehaviourAndFSMAndStartLongPolling</a> in case you wish to start <a href="../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/long-polling.html">longPolling</a> automatically</p></div>
|
|
<div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">suspend fun <<a href="build-behaviour-with-f-s-m.html">T</a> : <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span>> <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="build-behaviour-with-f-s-m.html">buildBehaviourWithFSM</a>(flowUpdatesFilter: <a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a>, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = defaultCoroutineScopeProvider(), defaultExceptionsHandler: <span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>>? = null, statesManager: <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/StatesManager///PointingToDeclaration/">StatesManager</span><<a href="build-behaviour-with-f-s-m.html">T</a>> = DefaultStatesManager(InMemoryDefaultStatesManagerRepo()), presetHandlers: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html">MutableList</a><<a href="-behaviour-with-f-s-m-state-handler-holder/index.html">BehaviourWithFSMStateHandlerHolder</a><*, <a href="build-behaviour-with-f-s-m.html">T</a>>> = mutableListOf(), block: <a href="index.html#-1892390839%2FClasslikes%2F-1982836883">CustomBehaviourContextReceiver</a><<a href="-behaviour-context-with-f-s-m-builder/index.html">BehaviourContextWithFSMBuilder</a><<a href="build-behaviour-with-f-s-m.html">T</a>>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>>): <a href="-behaviour-context-with-f-s-m/index.html">BehaviourContextWithFSM</a><<a href="build-behaviour-with-f-s-m.html">T</a>><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<p class="paragraph">Creates <a href="-behaviour-context-with-f-s-m/index.html">BehaviourContextWithFSM</a> via creating of <a href="-default-behaviour-context/index.html">DefaultBehaviourContext</a> with <span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder//&lt;this&gt;/#/PointingToCallableParameters(-1)/">this</span> as <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>, <a href="build-behaviour-with-f-s-m.html">scope</a> as target scope for that <a href="-default-behaviour-context/index.html">DefaultBehaviourContext</a> and <a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/all-updates-flow.html">FlowsUpdatesFilter.allUpdatesFlow</a> of <a href="build-behaviour-with-f-s-m.html">flowUpdatesFilter</a> as <span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder/DefaultBehaviourContext/upstreamUpdatesFlow/#/PointingToDeclaration/">DefaultBehaviourContext.upstreamUpdatesFlow</span>. Pass <a href="build-behaviour-with-f-s-m.html">statesManager</a> to customize some internal logic of states changes. Pass <a href="build-behaviour-with-f-s-m.html">presetHandlers</a> in case you have some list of <a href="-behaviour-with-f-s-m-state-handler-holder/index.html">BehaviourWithFSMStateHandlerHolder</a> with presets. Use this method in case you wish to make some additional actions with <a href="build-behaviour-with-f-s-m.html">flowUpdatesFilter</a>.</p><p class="paragraph">!!! WARNING !!! This method WILL NOT call <a href="-behaviour-context-with-f-s-m/start.html">BehaviourContextWithFSM.start</a> of result object and WILL NOT start any updates retrieving. See <a href="build-behaviour-with-f-s-m-and-start-long-polling.html">buildBehaviourWithFSMAndStartLongPolling</a> or <a href="telegram-bot-with-behaviour-and-f-s-m-and-start-long-polling.html">telegramBotWithBehaviourAndFSMAndStartLongPolling</a> in case you wish to start <a href="../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/long-polling.html">longPolling</a> automatically</p><h2 class="">See also</h2><div data-togglable="See also"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="See also"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="-behaviour-context/index.html"><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>extensions.</span><wbr></wbr><span>behaviour_builder.</span><wbr></wbr><span>Behaviour</span><wbr></wbr><span><span>Context</span></span></a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="-behaviour-context-with-f-s-m/index.html"><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>extensions.</span><wbr></wbr><span>behaviour_builder.</span><wbr></wbr><span>Behaviour</span><wbr></wbr><span>Context</span><wbr></wbr><span>With</span><wbr></wbr><span><span>FSM</span></span></a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/long-polling.html"><span>long</span><wbr></wbr><span><span>Polling</span></span></a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="-behaviour-context-with-f-s-m-builder/on-state-or-substate.html"><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>extensions.</span><wbr></wbr><span>behaviour_builder.</span><wbr></wbr><span>Behaviour</span><wbr></wbr><span>Context</span><wbr></wbr><span>With</span><wbr></wbr><span><span>FSMBuilder</span></span></a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|