mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-12-23 17:17:13 +00:00
77 lines
19 KiB
HTML
77 lines
19 KiB
HTML
<!doctype html>
|
|
<html class="no-js">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>TelegramBotMiddleware</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="member" id="content" pageids="tgbotapi.core::dev.inmo.tgbotapi.bot.ktor.middlewares/TelegramBotMiddleware/TelegramBotMiddleware/#kotlin.coroutines.SuspendFunction2[dev.inmo.tgbotapi.requests.abstracts.Request[*],kotlin.Throwable?,kotlin.Any?]?#kotlin.coroutines.SuspendFunction2[dev.inmo.tgbotapi.requests.abstracts.Request[*],kotlin.collections.List[dev.inmo.tgbotapi.bot.ktor.KtorCallFactory],kotlin.Unit]?#kotlin.coroutines.SuspendFunction2[dev.inmo.tgbotapi.requests.abstracts.Request[*],dev.inmo.tgbotapi.bot.ktor.KtorCallFactory,kotlin.Unit]?#kotlin.coroutines.SuspendFunction3[kotlin.Any?,dev.inmo.tgbotapi.requests.abstracts.Request[*],dev.inmo.tgbotapi.bot.ktor.KtorCallFactory,kotlin.Any?]?#kotlin.coroutines.SuspendFunction4[kotlin.Any?,dev.inmo.tgbotapi.requests.abstracts.Request[*],dev.inmo.tgbotapi.bot.ktor.KtorCallFactory,kotlin.collections.List[dev.inmo.tgbotapi.bot.ktor.KtorCallFactory],kotlin.Any?]?#kotlin.coroutines.SuspendFunction2[dev.inmo.tgbotapi.requests.abstracts.Request[*],kotlin.collections.List[dev.inmo.tgbotapi.bot.ktor.KtorCallFactory],kotlin.Any?]?#kotlin.coroutines.SuspendFunction3[kotlin.Result[*],dev.inmo.tgbotapi.requests.abstracts.Request[*],kotlin.collections.List[dev.inmo.tgbotapi.bot.ktor.KtorCallFactory],kotlin.Result[kotlin.Any?]?]?/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.middlewares</a><span class="delimiter">/</span><a href="index.html">TelegramBotMiddleware</a><span class="delimiter">/</span><span class="current">TelegramBotMiddleware</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Telegram</span><wbr><span>Bot</span><wbr><span><span>Middleware</span></span></h1>
|
|
</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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">onRequestException<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span>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>t<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token operator">?</span><span class="token punctuation">)</span><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><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">onBeforeSearchCallFactory<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span>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>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="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">onBeforeCallFactoryMakeCall<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span>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>potentialFactory<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">onAfterCallFactoryMakeCall<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span>result<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><span class="token punctuation">, </span>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>potentialFactory<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a><span class="token punctuation">)</span><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><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">onRequestResultPresented<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span>result<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><span class="token punctuation">, </span>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>resultCallFactory<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a><span class="token punctuation">, </span>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="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></span><span class="token punctuation">)</span><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><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">onRequestResultAbsent<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span>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>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="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></span><span class="token punctuation">)</span><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><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">onRequestReturnResult<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span>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><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">, </span>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>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="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</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></span><span class="token punctuation">)</span></div><h4 class="">Parameters</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><u><span>on</span><wbr><span>Request</span><wbr><span><span>Exception</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be called when some exception happen during <a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a> handling. Non-null result of lambda will be used as the result of request handling</p></div></div></div></div><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><u><span>on</span><wbr><span>Before</span><wbr><span>Search</span><wbr><span>Call</span><wbr><span><span>Factory</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be called when telegram bot starts to choose which <a href="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a> will handle <a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a></p></div></div></div></div><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><u><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></u></div></span></div><div><div class="title"><p class="paragraph">Will be called when telegram bot trying to use <a href="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a> as potential handler for <a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a></p></div></div></div></div><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><u><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></u></div></span></div><div><div class="title"><p class="paragraph">Will be called when <a href="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a> made call. Non-null result of lambda will be used as the result of request handling</p></div></div></div></div><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><u><span>on</span><wbr><span>Request</span><wbr><span>Result</span><wbr><span><span>Presented</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be called when <a href="../../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a> <strong>or</strong> <a href="../../dev.inmo.tgbotapi.bot.ktor/-telegram-bot-pipelines-handler/index.html">TelegramBotPipelinesHandler</a>/<a href="index.html">TelegramBotMiddleware</a> returned non-null result. Non-null result of lambda will be used as the result of request handling</p></div></div></div></div><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><u><span>on</span><wbr><span>Request</span><wbr><span>Result</span><wbr><span><span>Absent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be called when some there is no any result of <a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a> handling. Non-null result of lambda will be used as the result of request handling</p></div></div></div></div><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><u><span>on</span><wbr><span>Request</span><wbr><span>Return</span><wbr><span><span>Result</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Latest lambda before result returning. Will be called after all previous stages. Non-null result of lambda will be used as the result of request handling</p></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>
|
|
|