<!doctype html> <html class="no-js"> <head> <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> <title>Companion</title> <link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../../../../";</script> <script>document.documentElement.classList.replace("no-js","js");</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="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script> <script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async></script> <link href="../../../../styles/style.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"> <link href="../../../../styles/font-jb-sans-auto.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="root"> <nav class="navigation" id="navigation-wrapper"> <div class="navigation--inner"> <div class="navigation-title"> <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button> <div class="library-name"> <a class="library-name--link" href="../../../../index.html"> ktgbotapi </a> </div> <div class="library-version"> </div> </div> <div class="filter-section" id="filter-section"> <button class="platform-tag platform-selector common-like" data-active="" data-filter=":tgbotapi.core:dokkaHtmlPartial/commonMain">common</button> </div> </div> <div class="navigation-controls"> <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button> <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div> </div> </nav> <div id="container"> <div class="sidebar" id="leftColumn"> <div class="sidebar--inner" id="sideMenu"></div> </div> <div id="main"> <div class="main-content" data-page-type="classlike" id="content" pageids="tgbotapi.core::dev.inmo.tgbotapi.bot.ktor/TelegramBotPipelinesHandler.Companion///PointingToDeclaration//789214110"> <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><a href="../index.html">TelegramBotPipelinesHandler</a><span class="delimiter">/</span><span class="current">Companion</span></div> <div class="cover "> <h1 class="cover"><span><span>Companion</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">object </span><a href="index.html">Companion</a> : <a href="../index.html">TelegramBotPipelinesHandler</a></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="FUNCTION"> <h2 class="">Functions</h2> <div class="table"><a data-name="1035335192%2FFunctions%2F789214110" anchor-label="onAfterCallFactoryMakeCall" id="1035335192%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="1035335192%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"><</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">> </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"><</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 ">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="-40626977%2FFunctions%2F789214110" anchor-label="onBeforeCallFactoryMakeCall" id="-40626977%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="-40626977%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"><</span><span class="token operator">*</span><span class="token operator">></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="1517747465%2FFunctions%2F789214110" anchor-label="onBeforeSearchCallFactory" id="1517747465%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="1517747465%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"><</span><span class="token operator">*</span><span class="token operator">></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"><</span><a href="../../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></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="716546641%2FFunctions%2F789214110" anchor-label="onRequestException" id="716546641%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="716546641%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"><</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">> </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"><</span><a href="../on-request-exception.html">T</a><span class="token operator">></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="664792052%2FFunctions%2F789214110" anchor-label="onRequestResultAbsent" id="664792052%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="664792052%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"><</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">> </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"><</span><a href="../on-request-result-absent.html">T</a><span class="token operator">></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"><</span><a href="../../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></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="1428356921%2FFunctions%2F789214110" anchor-label="onRequestResultPresented" id="1428356921%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="1428356921%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"><</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">> </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"><</span><a href="../on-request-result-presented.html">T</a><span class="token operator">></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"><</span><a href="../../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></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="-1374676429%2FFunctions%2F789214110" anchor-label="onRequestReturnResult" id="-1374676429%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="-1374676429%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"><</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">> </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"><</span><a href="../on-request-return-result.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"><</span><a href="../on-request-return-result.html">T</a><span class="token operator">></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"><</span><a href="../../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/index.html">Result</a><span class="token operator"><</span><a href="../on-request-return-result.html">T</a><span class="token operator">></span></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> </div> <div class="footer"> <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 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> </div> </body> </html>