mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-24 02:58:43 +00:00
65 lines
21 KiB
HTML
65 lines
21 KiB
HTML
<!DOCTYPE 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>const storage = localStorage.getItem("dokka-dark-mode")
|
|
const savedDarkMode = storage ? JSON.parse(storage) : false
|
|
if(savedDarkMode === true){
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}</script>
|
|
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
|
<link href="../../styles/style.css" rel="Stylesheet">
|
|
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
|
|
<link href="../../styles/main.css" rel="Stylesheet">
|
|
<link href="../../styles/prism.css" rel="Stylesheet">
|
|
<link href="../../styles/logo-styles.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" defer="defer"></script>
|
|
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
|
|
</head>
|
|
<body>
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<div class="library-name">
|
|
<a href="../../index.html">
|
|
<span>docs</span>
|
|
</a>
|
|
</div>
|
|
<div>
|
|
</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>
|
|
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div id="container">
|
|
<div id="leftColumn">
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<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.List[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourWithFSMStateHandlerHolder[*,TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]]#kotlin.coroutines.SuspendFunction2[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),kotlin.Throwable,TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])?]#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.DefaultBehaviourContextWithFSM[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])],kotlin.Unit]/PointingToDeclaration//-1982836883">
|
|
<div class="breadcrumbs"><a href="../../index.html">docs</a><span class="delimiter">/</span><a href="index.html">dev.inmo.tgbotapi.extensions.behaviour_builder</a><span class="delimiter">/</span><a href="build-behaviour-with-f-s-m.html">buildBehaviourWithFSM</a></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="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
|
|
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div>
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator"> : </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span><span class="token operator">> </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a><span class="token punctuation">.</span><a href="build-behaviour-with-f-s-m.html"><span class="token function">buildBehaviourWithFSM</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented"> upstreamUpdatesFlow<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter indented"> scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token operator"> = </span>defaultCoroutineScopeProvider()<span class="token punctuation">, </span></span><span class="parameter indented"> defaultExceptionsHandler<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter indented"> statesManager<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/StatesManager///PointingToDeclaration/">StatesManager</span><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><span class="token operator"> = </span>DefaultStatesManager(InMemoryDefaultStatesManagerRepo())<span class="token punctuation">, </span></span><span class="parameter indented"> presetHandlers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="-behaviour-with-f-s-m-state-handler-holder/index.html">BehaviourWithFSMStateHandlerHolder</a><span class="token operator"><</span><span class="token operator">*</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token operator"> = </span>listOf()<span class="token punctuation">, </span></span><span class="parameter indented"> onStateHandlingErrorHandler<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common.utils/StateHandlingErrorHandler///PointingToDeclaration/">StateHandlingErrorHandler</span><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><span class="token operator"> = </span>defaultStateHandlingErrorHandler()<span class="token punctuation">, </span></span><span class="parameter indented"> block<span class="token operator">: </span><a href="index.html#-1892390839%2FClasslikes%2F-1982836883">CustomBehaviourContextReceiver</a><span class="token operator"><</span><span class="token keyword"></span><a href="-default-behaviour-context-with-f-s-m/index.html">DefaultBehaviourContextWithFSM</a><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-default-behaviour-context-with-f-s-m/index.html">DefaultBehaviourContextWithFSM</a><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><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><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><br><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator"> : </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span><span class="token operator">> </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a><span class="token punctuation">.</span><a href="build-behaviour-with-f-s-m.html"><span class="token function">buildBehaviourWithFSM</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented"> flowUpdatesFilter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a><span class="token punctuation">, </span></span><span class="parameter indented"> scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token operator"> = </span>defaultCoroutineScopeProvider()<span class="token punctuation">, </span></span><span class="parameter indented"> defaultExceptionsHandler<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter indented"> statesManager<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/StatesManager///PointingToDeclaration/">StatesManager</span><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><span class="token operator"> = </span>DefaultStatesManager(InMemoryDefaultStatesManagerRepo())<span class="token punctuation">, </span></span><span class="parameter indented"> presetHandlers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="-behaviour-with-f-s-m-state-handler-holder/index.html">BehaviourWithFSMStateHandlerHolder</a><span class="token operator"><</span><span class="token operator">*</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token operator"> = </span>listOf()<span class="token punctuation">, </span></span><span class="parameter indented"> onStateHandlingErrorHandler<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common.utils/StateHandlingErrorHandler///PointingToDeclaration/">StateHandlingErrorHandler</span><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><span class="token operator"> = </span>defaultStateHandlingErrorHandler()<span class="token punctuation">, </span></span><span class="parameter indented"> block<span class="token operator">: </span><a href="index.html#-1892390839%2FClasslikes%2F-1982836883">CustomBehaviourContextReceiver</a><span class="token operator"><</span><span class="token keyword"></span><a href="-default-behaviour-context-with-f-s-m/index.html">DefaultBehaviourContextWithFSM</a><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-default-behaviour-context-with-f-s-m/index.html">DefaultBehaviourContextWithFSM</a><span class="token operator"><</span><span class="token keyword"></span><a href="build-behaviour-with-f-s-m.html">T</a><span class="token operator">></span><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><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="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"><div class=""><span class="inline-flex"><div><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></div></span></div><div><div class="title"><div data-togglable="See also"></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"><div class=""><span class="inline-flex"><div><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></div></span></div><div><div class="title"><div data-togglable="See also"></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"><div class=""><span class="inline-flex"><div><a href="../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/long-polling.html"><span>long</span><wbr></wbr><span><span>Polling</span></span></a></div></span></div><div><div class="title"><div data-togglable="See also"></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"><div class=""><span class="inline-flex"><div><a href="strictly-on.html"><span>Behaviour</span><wbr></wbr><span>Context</span><wbr></wbr><span>With</span><wbr></wbr><span>FSM.</span><wbr></wbr><span>strictlyOn</span></a></div></span></div><div><div class="title"><div data-togglable="See also"></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"><div class=""><span class="inline-flex"><div><a href="on-state-or-substate.html"><span>Behaviour</span><wbr></wbr><span>Context</span><wbr></wbr><span>With</span><wbr></wbr><span>FSM.</span><wbr></wbr><span>on</span><wbr></wbr><span>State</span><wbr></wbr><span>Or</span><wbr></wbr><span><span>Substate</span></span></a></div></span></div><div><div class="title"><div data-togglable="See also"></div></div></div></div></div></div></div></div> </div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 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>
|