mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2026-08-19 07:36:26 +00:00
131 lines
23 KiB
HTML
131 lines
23 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js" lang="en">
|
|
<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="../../../scripts/sourceset_dependencies.js" async="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="../../../ui-kit/ui-kit.min.css" rel="Stylesheet">
|
|
<script type="text/javascript" src="../../../scripts/safe-local-storage_blocking.js"></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>
|
|
<script type="text/javascript" src="../../../ui-kit/ui-kit.min.js" defer="defer"></script>
|
|
</head>
|
|
<body>
|
|
<div class="root">
|
|
<header class="navigation theme-dark" id="navigation-wrapper" role="banner">
|
|
<a class="library-name--link" href="../../../index.html" tabindex="1">
|
|
docs
|
|
</a>
|
|
<button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle"
|
|
type="button">Toggle table of contents
|
|
</button>
|
|
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
|
<div class="library-version" id="library-version">
|
|
35.1.0 </div>
|
|
<div class="navigation-controls">
|
|
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">
|
|
<button class="platform-tag platform-selector common-like" data-active="" aria-pressed="true"
|
|
data-filter=":docs/commonMain">common</button>
|
|
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
|
|
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox"
|
|
data-role="dropdown-toggle"
|
|
aria-controls="platform-tags-listbox"
|
|
aria-haspopup="listbox"
|
|
aria-expanded="false"
|
|
aria-label="Toggle source sets"
|
|
></button>
|
|
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox" aria-label="Target filter">
|
|
<div class="dropdown--header"><span>Target filter</span>
|
|
<button class="button" data-role="dropdown-toggle" aria-label="Close target filter">
|
|
<i class="ui-kit-icon ui-kit-icon_cross"></i>
|
|
</button>
|
|
</div>
|
|
<li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0">
|
|
<label class="checkbox">
|
|
<input type="checkbox" class="checkbox--input" id=":docs/commonMain"
|
|
data-filter=":docs/commonMain"/>
|
|
<span class="checkbox--icon"></span>
|
|
common
|
|
</label>
|
|
</li>
|
|
</ul>
|
|
<div class="dropdown--overlay"></div>
|
|
</div>
|
|
</ul>
|
|
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button"
|
|
type="button">Switch theme
|
|
</button>
|
|
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
|
|
API
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div id="container">
|
|
<nav id="leftColumn" class="sidebar" data-item-type="SECTION" data-item-config='{"defaultSize": 280, "minSize": 200, "maxSize": 400}'>
|
|
<a class="toc--skip-link" href="#main">Skip to content</a>
|
|
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
|
|
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list"
|
|
data-role="dropdown-listbox" aria-label="Table of contents">
|
|
<div class="dropdown--header">
|
|
<span>
|
|
docs
|
|
</span>
|
|
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
|
|
<i class="ui-kit-icon ui-kit-icon_cross"></i>
|
|
</button>
|
|
</div>
|
|
<div class="sidebar--inner" id="sideMenu"></div>
|
|
</ul>
|
|
<div class="dropdown--overlay"></div>
|
|
</div>
|
|
</nav>
|
|
<div id="resizer" class="resizer" data-item-type="BAR"></div>
|
|
<div id="main" data-item-type="SECTION" role="main">
|
|
<div class="main-content" data-page-type="member" id="content" pageIds="docs::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?]?]?#kotlin.coroutines.SuspendFunction2[dev.inmo.tgbotapi.requests.abstracts.Request[*],kotlin.Throwable?,kotlin.Any?]?#kotlin.String/PointingToDeclaration//444310150">
|
|
<div class="breadcrumbs"><a href="../../../index.html">docs</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></wbr><span>Bot</span><wbr></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=":docs/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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-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/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-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 class="token punctuation">, </span></span><span class="parameter ">onRequestExceptionInLimiter<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/core/kotlin-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/core/kotlin-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 ">id<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>uuid4().toString()</span></span><span class="token punctuation">)</span><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/ktgbotapi/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/bot/ktor/middlewares/TelegramBotMiddleware.kt#L26">source</a>)</span></span></div><h4 class="tableheader">Parameters</h4><div class="table"><div class="table-row table-row_content" data-filterable-current=":docs/commonMain" data-filterable-set=":docs/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>Request</span><wbr></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 table-row_content" data-filterable-current=":docs/commonMain" data-filterable-set=":docs/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>Before</span><wbr></wbr><span>Search</span><wbr></wbr><span>Call</span><wbr></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 table-row_content" data-filterable-current=":docs/commonMain" data-filterable-set=":docs/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>Before</span><wbr></wbr><span>Call</span><wbr></wbr><span>Factory</span><wbr></wbr><span>Make</span><wbr></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 table-row_content" data-filterable-current=":docs/commonMain" data-filterable-set=":docs/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>After</span><wbr></wbr><span>Call</span><wbr></wbr><span>Factory</span><wbr></wbr><span>Make</span><wbr></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 table-row_content" data-filterable-current=":docs/commonMain" data-filterable-set=":docs/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>Request</span><wbr></wbr><span>Result</span><wbr></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 table-row_content" data-filterable-current=":docs/commonMain" data-filterable-set=":docs/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>Request</span><wbr></wbr><span>Result</span><wbr></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 table-row_content" data-filterable-current=":docs/commonMain" data-filterable-set=":docs/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>Request</span><wbr></wbr><span>Return</span><wbr></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">
|
|
<div class="footer--container">
|
|
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
|
|
<div class="footer--content">
|
|
<div>
|
|
<span>Generated by </span>
|
|
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
|
|
Dokka
|
|
</a>
|
|
<div>© 2026 Copyright</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |