1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2026-01-23 13:47:59 +00:00
This commit is contained in:
InsanusMokrassar
2024-10-21 12:34:52 +00:00
parent 54116d3ff2
commit 036e5da4fc
135 changed files with 25202 additions and 17535 deletions

View File

@@ -62,140 +62,11 @@
<div class="breadcrumbs"><a href="../../index.html">tgbotapi.core</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.tgbotapi.bot.ktor</a><span class="delimiter">/</span><span class="current">KtorPipelineStepsHolder</span></div>
<div class="cover ">
<h1 class="cover"><span>Ktor</span><wbr><span>Pipeline</span><wbr><span>Steps</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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">KtorPipelineStepsHolder</a></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="-companion/index.html">Companion</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">typealias </span><strike><a href="index.html">KtorPipelineStepsHolder</a></strike><span class="token operator"> = </span><a href="../-telegram-bot-pipelines-handler/index.html">TelegramBotPipelinesHandler</a></div><div class="deprecation-content"><h3 class="">Deprecated</h3><p class="paragraph">Renamed</p><h4 class="">Replace with</h4><div class="sample-container"><pre><code class="monospace block lang-kotlin" theme="idea">import dev.inmo.tgbotapi.bot.ktor.TelegramBotPipelinesHandler<br></code></pre><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 class="sample-container"><pre><code class="monospace block lang-kotlin" theme="idea">TelegramBotPipelinesHandler</code></pre><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>
</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="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="1709515728%2FClasslikes%2F789214110" anchor-label="Companion" id="1709515728%2FClasslikes%2F789214110" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1709515728%2FClasslikes%2F789214110"></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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a> : <a href="index.html">KtorPipelineStepsHolder</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1071705458%2FFunctions%2F789214110" anchor-label="onAfterCallFactoryMakeCall" id="1071705458%2FFunctions%2F789214110" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-after-call-factory-make-call.html"><span>on</span><wbr><span>After</span><wbr><span>Call</span><wbr><span>Factory</span><wbr><span>Make</span><wbr><span><span>Call</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1071705458%2FFunctions%2F789214110"></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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="on-after-call-factory-make-call.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="on-after-call-factory-make-call.html"><span class="token function">onAfterCallFactoryMakeCall</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">result<span class="token operator">: </span><a href="on-after-call-factory-make-call.html">T</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter ">request<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><a href="on-after-call-factory-make-call.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">potentialFactory<span class="token operator">: </span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="on-after-call-factory-make-call.html">T</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Will always be called after <a href="on-after-call-factory-make-call.html">potentialFactory</a> has tried to make <a href="on-after-call-factory-make-call.html">request</a> and got some <a href="on-after-call-factory-make-call.html">result</a>. If returns value - that value will be returned from <a href="../../dev.inmo.tgbotapi.bot/-requests-executor/execute.html">dev.inmo.tgbotapi.bot.RequestsExecutor.execute</a> instead</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1000366279%2FFunctions%2F789214110" anchor-label="onBeforeCallFactoryMakeCall" id="-1000366279%2FFunctions%2F789214110" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-before-call-factory-make-call.html"><span>on</span><wbr><span>Before</span><wbr><span>Call</span><wbr><span>Factory</span><wbr><span>Make</span><wbr><span><span>Call</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1000366279%2FFunctions%2F789214110"></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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="on-before-call-factory-make-call.html"><span class="token function">onBeforeCallFactoryMakeCall</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">potentialFactory<span class="token operator">: </span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Will always be called before <a href="on-before-call-factory-make-call.html">potentialFactory</a> will try to make <a href="on-before-call-factory-make-call.html">request</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1898156689%2FFunctions%2F789214110" anchor-label="onBeforeSearchCallFactory" id="-1898156689%2FFunctions%2F789214110" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-before-search-call-factory.html"><span>on</span><wbr><span>Before</span><wbr><span>Search</span><wbr><span>Call</span><wbr><span><span>Factory</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1898156689%2FFunctions%2F789214110"></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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="on-before-search-call-factory.html"><span class="token function">onBeforeSearchCallFactory</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">callsFactories<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">&lt;</span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Will always be called before requests executor will check all <a href="on-before-search-call-factory.html">callsFactories</a> for an opportunity to make call of <a href="on-before-search-call-factory.html">request</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1440319445%2FFunctions%2F789214110" anchor-label="onRequestException" id="-1440319445%2FFunctions%2F789214110" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-request-exception.html"><span>on</span><wbr><span>Request</span><wbr><span><span>Exception</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1440319445%2FFunctions%2F789214110"></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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="on-request-exception.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="on-request-exception.html"><span class="token function">onRequestException</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><a href="on-request-exception.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">t<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="on-request-exception.html">T</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Will be called when any exception will happen due to the <a href="on-request-exception.html">request</a> handling. If returns value - that value will be returned from <a href="../../dev.inmo.tgbotapi.bot/-requests-executor/execute.html">dev.inmo.tgbotapi.bot.RequestsExecutor.execute</a> instead</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="265263694%2FFunctions%2F789214110" anchor-label="onRequestResultAbsent" id="265263694%2FFunctions%2F789214110" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-request-result-absent.html"><span>on</span><wbr><span>Request</span><wbr><span>Result</span><wbr><span><span>Absent</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="265263694%2FFunctions%2F789214110"></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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="on-request-result-absent.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="on-request-result-absent.html"><span class="token function">onRequestResultAbsent</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><a href="on-request-result-absent.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">callsFactories<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">&lt;</span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="on-request-result-absent.html">T</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Will be called when there is no <a href="../-ktor-call-factory/index.html">KtorCallFactory</a> from <a href="on-request-result-absent.html">callsFactories</a> which may handle <a href="on-request-result-absent.html">request</a>. If returns value - that value will be returned from <a href="../../dev.inmo.tgbotapi.bot/-requests-executor/execute.html">dev.inmo.tgbotapi.bot.RequestsExecutor.execute</a> instead</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="423936799%2FFunctions%2F789214110" anchor-label="onRequestResultPresented" id="423936799%2FFunctions%2F789214110" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-request-result-presented.html"><span>on</span><wbr><span>Request</span><wbr><span>Result</span><wbr><span><span>Presented</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="423936799%2FFunctions%2F789214110"></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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="on-request-result-presented.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="on-request-result-presented.html"><span class="token function">onRequestResultPresented</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">result<span class="token operator">: </span><a href="on-request-result-presented.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">request<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><a href="on-request-result-presented.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">resultCallFactory<span class="token operator">: </span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token punctuation">, </span></span><span class="parameter ">callsFactories<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">&lt;</span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="on-request-result-presented.html">T</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Will be called when <a href="on-request-result-presented.html">resultCallFactory</a> is the <a href="../-ktor-call-factory/index.html">KtorCallFactory</a> from <a href="on-request-result-presented.html">callsFactories</a> which has successfully handled <a href="on-request-result-presented.html">request</a> and returned <a href="on-request-result-presented.html">result</a>. If returns value - that value will be returned from <a href="../../dev.inmo.tgbotapi.bot/-requests-executor/execute.html">dev.inmo.tgbotapi.bot.RequestsExecutor.execute</a> instead</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-286213363%2FFunctions%2F789214110" anchor-label="onRequestReturnResult" id="-286213363%2FFunctions%2F789214110" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-request-return-result.html"><span>on</span><wbr><span>Request</span><wbr><span>Return</span><wbr><span><span>Result</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-286213363%2FFunctions%2F789214110"></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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="on-request-return-result.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="on-request-return-result.html"><span class="token function">onRequestReturnResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">result<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/index.html">Result</a><span class="token operator">&lt;</span><a href="on-request-return-result.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">request<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><a href="on-request-return-result.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">callsFactories<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">&lt;</span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="on-request-return-result.html">T</a></div><div class="brief "><p class="paragraph">This step will be called when the <a href="on-request-return-result.html">result</a> has been retrieved (or exception has happened). If returns value - that value will be returned from <a href="../../dev.inmo.tgbotapi.bot/-requests-executor/execute.html">dev.inmo.tgbotapi.bot.RequestsExecutor.execute</a> instead</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="tabs-section" tabs-section="tabs-section"></div>
<div class="tabs-section-body"></div>
</div>
</div>
<div class="footer">