InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-06-01 07:25:23 +00:00
Code Releases Activity
4d8ab59161
tgbotapi/tgbotapi.behaviour_builder.fsm/dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-with-f-s-m-state-handler-holder/index.html
InsanusMokrassar 4d8ab59161 deploy: b235ab1c28
2023-06-09 06:14:58 +00:00

125 lines
18 KiB
HTML
Raw Blame History

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>BehaviourWithFSMStateHandlerHolder</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" 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></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer></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>ktgbotapi</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=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/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" data-page-type="classlike" id="content" pageids="tgbotapi.behaviour_builder.fsm::dev.inmo.tgbotapi.extensions.behaviour_builder/BehaviourWithFSMStateHandlerHolder///PointingToDeclaration//983072464">
<div class="breadcrumbs"><a href="../../index.html">tgbotapi.behaviour_builder.fsm</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.tgbotapi.extensions.behaviour_builder</a><span class="delimiter">/</span><span class="current">BehaviourWithFSMStateHandlerHolder</span></div>
<div class="cover ">
<h1 class="cover"><span>Behaviour</span><wbr><span>With</span><wbr><span>FSMState</span><wbr><span>Handler</span><wbr><span><span>Holder</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">BehaviourWithFSMStateHandlerHolder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator"> : </span><a href="index.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator"> : </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">inputKlass<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">strict<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">delegateTo<span class="token operator">: </span><a href="../-behaviour-with-f-s-m-state-handler/index.html">BehaviourWithFSMStateHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span> : <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/CheckableHandlerHolder///PointingToDeclaration/">CheckableHandlerHolder</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">&gt; </span>, <a href="../-behaviour-with-f-s-m-state-handler/index.html">BehaviourWithFSMStateHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">&gt; </span></div><p class="paragraph">Special holder for <a href="../-behaviour-context-with-f-s-m/index.html">BehaviourContextWithFSM</a>. This holder helps <a href="../-behaviour-context-with-f-s-m/index.html">BehaviourContextWithFSM</a> to understand whether it can handle input <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span> with <a href="../../../tgbotapi.behaviour_builder/dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-with-f-s-m-state-handler-holder/delegate-to.html">delegateTo</a> or not</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>input</span><wbr><span><span>Klass</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a> will be used to compare input <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span> type and declare ability of <a href="../../../tgbotapi.behaviour_builder/dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-with-f-s-m-state-handler-holder/delegate-to.html">delegateTo</a> to handle incoming <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span>. See <a href="check-handleable.html">checkHandleable</a> for more info</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>strict</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This flag will be used in <a href="check-handleable.html">checkHandleable</a> to choose strategy of checking incoming <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span></p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>delegate</span><wbr><span><span>To</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This handler will be called in case <a href="check-handleable.html">checkHandleable</a> returns true with class caster incoming <span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span> in <a href="handle-state.html">handleState</a></p></div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="293952883%2FConstructors%2F983072464" anchor-label="BehaviourWithFSMStateHandlerHolder" id="293952883%2FConstructors%2F983072464" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-behaviour-with-f-s-m-state-handler-holder.html"><span>Behaviour</span><wbr><span>With</span><wbr><span>FSMState</span><wbr><span>Handler</span><wbr><span><span>Holder</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="293952883%2FConstructors%2F983072464"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">inputKlass<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">strict<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">delegateTo<span class="token operator">: </span><a href="../-behaviour-with-f-s-m-state-handler/index.html">BehaviourWithFSMStateHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1140830866%2FFunctions%2F983072464" anchor-label="checkHandleable" id="1140830866%2FFunctions%2F983072464" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="check-handleable.html"><span>check</span><wbr><span><span>Handleable</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1140830866%2FFunctions%2F983072464"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="check-handleable.html"><span class="token function">checkHandleable</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Check ability of <a href="../../../tgbotapi.behaviour_builder/dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-with-f-s-m-state-handler-holder/delegate-to.html">delegateTo</a> to handle this <a href="check-handleable.html">state</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1807239605%2FFunctions%2F983072464" anchor-label="handleState" id="1807239605%2FFunctions%2F983072464" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="handle-state.html"><span>handle</span><wbr><span><span>State</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1807239605%2FFunctions%2F983072464"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/StatesMachine///PointingToDeclaration/">StatesMachine</span><span class="token operator">&lt;</span><span class="token keyword">in </span><a href="index.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="handle-state.html"><span class="token function">handleState</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">O</a><span class="token operator">?</span></div><br><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="../-behaviour-context-with-f-s-m/index.html">BehaviourContextWithFSM</a><span class="token operator">&lt;</span><span class="token keyword">in </span><a href="index.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="handle-state.html"><span class="token function">handleState</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">O</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Handling of state :)</p></div></div></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>© 2023 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>
View Git Blame Copy Permalink