mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-26 12:08:43 +00:00
65 lines
16 KiB
HTML
65 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>expectOne</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.expectations//expectOne/dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter#dev.inmo.tgbotapi.bot.RequestsExecutor#dev.inmo.tgbotapi.requests.abstracts.Request[*]?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.update.abstracts.Update,dev.inmo.tgbotapi.requests.abstracts.Request[*]?]#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.update.abstracts.Update,dev.inmo.tgbotapi.requests.abstracts.Request[*]?]#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.update.abstracts.Update,kotlin.Boolean]#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.update.abstracts.Update,TypeParam(bounds=[kotlin.Any?])?]/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.expectations</a><span class="delimiter">/</span><a href="expect-one.html">expectOne</a></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>expect</span><wbr></wbr><span><span>One</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="expect-one.html">T</a><span class="token operator">> </span><a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a><span class="token punctuation">.</span><a href="expect-one.html"><span class="token function">expectOne</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented"> bot<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a><span class="token punctuation">, </span></span><span class="parameter indented"> initRequest<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator"><</span><span class="token operator">*</span><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"> errorFactory<span class="token operator">: </span><a href="index.html#278660993%2FClasslikes%2F-1982836883">NullableRequestBuilder</a><span class="token operator"><</span><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"> cancelRequestFactory<span class="token operator">: </span><a href="index.html#278660993%2FClasslikes%2F-1982836883">NullableRequestBuilder</a><span class="token operator"><</span><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"> cancelTrigger<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token punctuation">)</span><span class="token operator"> -> </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>{ cancelRequestFactory(it) != null }<span class="token punctuation">, </span></span><span class="parameter indented"> filter<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="expect-one.html">T</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="expect-one.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><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><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><span>init</span><wbr></wbr><span><span>Request</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If not null, this request will be sent by <a href="expect-one.html">bot</a> before returning value</p></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><span>error</span><wbr></wbr><span><span>Factory</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If set, this factory will be used to produce requests in case when user have sent incorrect data</p></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><span>cancel</span><wbr></wbr><span>Request</span><wbr></wbr><span><span>Factory</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If set, this factory will be used to produce requests in case when it is required to say user that chain of scenario has been cancelled</p></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><span>cancel</span><wbr></wbr><span><span>Trigger</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">When this trigger returns true, chain is cancelled</p></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><span><span>filter</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">It is main param, which will be called on each update. When it return not null, result will be returned as is, but when it returns null, then will be called <a href="expect-one.html">cancelTrigger</a> (if it will return true - <a href="expect-one.html">cancelRequestFactory</a> will be called too), <a href="expect-one.html">errorFactory</a> and then will be returned null</p></div></div></div></div></div></div></div><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="expect-one.html">T</a><span class="token operator">> </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-context/index.html">BehaviourContext</a><span class="token punctuation">.</span><a href="expect-one.html"><span class="token function">expectOne</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented"> initRequest<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator"><</span><span class="token operator">*</span><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"> errorFactory<span class="token operator">: </span><a href="index.html#278660993%2FClasslikes%2F-1982836883">NullableRequestBuilder</a><span class="token operator"><</span><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"> cancelRequestFactory<span class="token operator">: </span><a href="index.html#278660993%2FClasslikes%2F-1982836883">NullableRequestBuilder</a><span class="token operator"><</span><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"> cancelTrigger<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token punctuation">)</span><span class="token operator"> -> </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>{ cancelRequestFactory(it) != null }<span class="token punctuation">, </span></span><span class="parameter indented"> filter<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="expect-one.html">T</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="expect-one.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><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><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><span>init</span><wbr></wbr><span><span>Request</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If not null, this request will be sent by bot before returning value</p></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><span>error</span><wbr></wbr><span><span>Factory</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If set, this factory will be used to produce requests in case when user have sent incorrect data</p></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><span>cancel</span><wbr></wbr><span>Request</span><wbr></wbr><span><span>Factory</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If set, this factory will be used to produce requests in case when it is required to say user that chain of scenario has been cancelled</p></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><span>cancel</span><wbr></wbr><span><span>Trigger</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">When this trigger returns true, chain is cancelled</p></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><span><span>filter</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">It is main param, which will be called on each update. When it return not null, result will be returned as is, but when it returns null, then will be called <a href="expect-one.html">cancelTrigger</a> (if it will return true - <a href="expect-one.html">cancelRequestFactory</a> will be called too), <a href="expect-one.html">errorFactory</a> and then will be returned null</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>
|