mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-12-24 09:37:12 +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>expectFlow</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.expectations//expectFlow/dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter#dev.inmo.tgbotapi.bot.RequestsExecutor#dev.inmo.tgbotapi.requests.abstracts.Request[*]?#kotlin.Int?#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,kotlin.collections.List[TypeParam(bounds=[kotlin.Any?])]]/PointingToDeclaration//1420480770">
|
|
<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.expectations</a>/<a href="expect-flow.html">expectFlow</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>expect</span><wbr></wbr><span>Flow</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="expect-flow.html">T</a>> <a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a>.<a href="expect-flow.html">expectFlow</a>(bot: <a href="../dev.inmo.tgbotapi.bot/index.html#%5Bdev.inmo.tgbotapi.bot%2FTelegramBot%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F1420480770">TelegramBot</a>, initRequest: <a href="../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><*>? = null, count: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>? = null, errorFactory: <a href="index.html#%5Bdev.inmo.tgbotapi.extensions.behaviour_builder.expectations%2FNullableRequestBuilder%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F1420480770">NullableRequestBuilder</a><*> = { null }, cancelRequestFactory: <a href="index.html#%5Bdev.inmo.tgbotapi.extensions.behaviour_builder.expectations%2FNullableRequestBuilder%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F1420480770">NullableRequestBuilder</a><*> = { null }, cancelTrigger: suspend (<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = { cancelRequestFactory(it) != null }, filter: suspend (<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="expect-flow.html">T</a>>): <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><<a href="expect-flow.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>
|
|
<h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><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">initRequest</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-flow.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">count</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If set, result <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> will return <a href="expect-flow.html">count</a> elements on each <span data-unresolved-link="kotlinx.coroutines.flow/Flow/collect/#kotlinx.coroutines.flow.FlowCollector[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">Flow.collect</span></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">errorFactory</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">cancelRequestFactory</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">cancelTrigger</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">filter</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-flow.html">cancelTrigger</a> (if it will return true - <a href="expect-flow.html">cancelRequestFactory</a> will be called too), <a href="expect-flow.html">errorFactory</a> and then will be returned null</p></div></div></div></div></div></div></div></div></div></div></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="expect-flow.html">T</a>> <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-context/index.html">BehaviourContext</a>.<a href="expect-flow.html">expectFlow</a>(initRequest: <a href="../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><*>? = null, count: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>? = null, errorFactory: <a href="index.html#%5Bdev.inmo.tgbotapi.extensions.behaviour_builder.expectations%2FNullableRequestBuilder%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F1420480770">NullableRequestBuilder</a><*> = { null }, cancelRequestFactory: <a href="index.html#%5Bdev.inmo.tgbotapi.extensions.behaviour_builder.expectations%2FNullableRequestBuilder%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F1420480770">NullableRequestBuilder</a><*> = { null }, cancelTrigger: suspend (<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = { cancelRequestFactory(it) != null }, filter: suspend (<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="expect-flow.html">T</a>>): <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><<a href="expect-flow.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>
|
|
<h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><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">initRequest</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">count</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If set, result <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> will return <a href="expect-flow.html">count</a> elements on each <span data-unresolved-link="kotlinx.coroutines.flow/Flow/collect/#kotlinx.coroutines.flow.FlowCollector[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">Flow.collect</span></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">errorFactory</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">cancelRequestFactory</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">cancelTrigger</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">filter</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-flow.html">cancelTrigger</a> (if it will return true - <a href="expect-flow.html">cancelRequestFactory</a> will be called too), <a href="expect-flow.html">errorFactory</a> and then will be returned null</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"></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>
|
|
|