MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.fsm.common.managers/[android]-default-states-manager/-default-states-manager.html
2022-10-30 16:46:17 +00:00

66 lines
12 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>DefaultStatesManager</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>micro_utils.dokka</span>
</a>
</div>
<div>
0.13.2 </div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/androidMain">android</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="micro_utils.dokka::dev.inmo.micro_utils.fsm.common.managers/DefaultStatesManager/DefaultStatesManager/#dev.inmo.micro_utils.fsm.common.managers.DefaultStatesManagerRepo[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]#kotlin.coroutines.SuspendFunction3[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),kotlin.Boolean]/PointingToDeclaration//-1837788132">
<div class="breadcrumbs"><a href="../../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.micro_utils.fsm.common.managers</a><span class="delimiter">/</span><a href="index.html">[android]DefaultStatesManager</a><span class="delimiter">/</span><a href="-default-states-manager.html">DefaultStatesManager</a></div>
<div class="cover ">
<h1 class="cover"><span>Default</span><wbr></wbr><span>States</span><wbr></wbr><span><span>Manager</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 jvm-like" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/androidMain">android</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../dev.inmo.micro_utils.fsm.common/[android]-state/index.html">State</a><span class="token operator">&gt; </span><a href="-default-states-manager.html"><span class="token function">DefaultStatesManager</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">repo<span class="token operator">: </span><a href="../[android]-default-states-manager-repo/index.html">DefaultStatesManagerRepo</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">onContextsConflictResolver<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span>old<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span>new<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span>currentNew<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</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><br><br><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../dev.inmo.micro_utils.fsm.common/[android]-state/index.html">State</a><span class="token operator">&gt; </span><a href="-default-states-manager.html"><span class="token function">DefaultStatesManager</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;repo<span class="token operator">: </span><a href="../[android]-default-states-manager-repo/index.html">DefaultStatesManagerRepo</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token operator"> = </span>InMemoryDefaultStatesManagerRepo()<span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;onStartContextsConflictResolver<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span>current<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span>new<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span>{ _, _ -&gt; true }<span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;onUpdateContextsConflictResolver<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span>old<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span>new<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span>currentNew<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span>{ _, _, _ -&gt; true }</span></span><span class="token punctuation">)</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><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>repo</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">This repo will be used as repository for storing states. All operations with this repo will happen BEFORE any event will be sent to <a href="on-chain-state-updated.html">onChainStateUpdated</a>, <a href="on-start-chain.html">onStartChain</a> or <a href="on-end-chain.html">onEndChain</a>. By default, will be used <a href="../[android]-in-memory-default-states-manager-repo/index.html">InMemoryDefaultStatesManagerRepo</a> or you may create custom <a href="../[android]-default-states-manager-repo/index.html">DefaultStatesManagerRepo</a> and pass as <span data-unresolved-link="dev.inmo.micro_utils.fsm.common.managers/DefaultStatesManager/&amp;lt;init&amp;gt;/#dev.inmo.micro_utils.fsm.common.managers.DefaultStatesManagerRepo[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]#kotlin.coroutines.SuspendFunction2[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),kotlin.Boolean]#kotlin.coroutines.SuspendFunction3[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),kotlin.Boolean]/PointingToCallableParameters(0)/">repo</span> parameter</p></div></div></div></div></div><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span>on</span><wbr></wbr><span>Start</span><wbr></wbr><span>Contexts</span><wbr></wbr><span>Conflict</span><wbr></wbr><span><span>Resolver</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Receive current <a href="../../dev.inmo.micro_utils.fsm.common/[android]-state/index.html">State</a> and the state passed with <a href="start-chain.html">startChain</a>. In case when this callback will return true, currently placed on the <a href="../../dev.inmo.micro_utils.fsm.common/[android]-state/index.html">State.context</a> will be replaced by new state with <a href="end-chain.html">endChain</a> with current state</p></div></div></div></div></div><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span>on</span><wbr></wbr><span>Update</span><wbr></wbr><span>Contexts</span><wbr></wbr><span>Conflict</span><wbr></wbr><span><span>Resolver</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Receive old <a href="../../dev.inmo.micro_utils.fsm.common/[android]-state/index.html">State</a>, new one and the state currently placed on new <a href="../../dev.inmo.micro_utils.fsm.common/[android]-state/context.html">State.context</a> key. In case when this callback will returns true, the state placed on <a href="../../dev.inmo.micro_utils.fsm.common/[android]-state/context.html">State.context</a> of new will be replaced by new state by using <a href="end-chain.html">endChain</a> with that state</p></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>