InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-06-14 05:45:26 +00:00
Code Releases Activity
fb59d785c3
tgbotapi/tgbotapi.core/dev.inmo.tgbotapi.bot.ktor/index.html
InsanusMokrassar fb59d785c3 deploy: 6fe8e73fca
2023-04-19 17:05:55 +00:00

175 lines
23 KiB
HTML
Raw Blame History

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dev.inmo.tgbotapi.bot.ktor</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</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></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/jetbrains-mono.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">
<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="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../index.html">
<span>TelegramBotAPI</span> </a> </div>
<div>
</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=":tgbotapi.core:dokkaHtmlPartial/commonMain">common</button>
<button class="platform-tag platform-selector js-like" data-active="" data-filter=":tgbotapi.core:dokkaHtmlPartial/jsMain">js</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":tgbotapi.core:dokkaHtmlPartial/jvmMain">jvm</button>
<button class="platform-tag platform-selector native-like" data-active="" data-filter=":tgbotapi.core:dokkaHtmlPartial/linuxX64Main">linuxX64</button>
<button class="platform-tag platform-selector native-like" data-active="" data-filter=":tgbotapi.core:dokkaHtmlPartial/mingwX64Main">mingwX64</button>
</div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="package" id="content" pageids="tgbotapi.core::dev.inmo.tgbotapi.bot.ktor////PointingToDeclaration//765871198">
<div class="breadcrumbs"><a href="../index.html">tgbotapi.core</a><span class="delimiter">/</span><span class="current">dev.inmo.tgbotapi.bot.ktor</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button></div>
<div class="tabs-section-body">
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="-1500065261%2FClasslikes%2F789214110" anchor-label="KtorCallFactory" id="-1500065261%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="-ktor-call-factory/index.html"><span>Ktor</span><wbr><span>Call</span><wbr><span><span>Factory</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1500065261%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">interface </span><a href="-ktor-call-factory/index.html">KtorCallFactory</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="999731406%2FClasslikes%2F789214110" anchor-label="KtorPipelineStepsHolder" id="999731406%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="-ktor-pipeline-steps-holder/index.html"><span>Ktor</span><wbr><span>Pipeline</span><wbr><span>Steps</span><wbr><span><span>Holder</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="999731406%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">interface </span><a href="-ktor-pipeline-steps-holder/index.html">KtorPipelineStepsHolder</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="533040876%2FClasslikes%2F765871198" anchor-label="KtorRequestsExecutor" id="533040876%2FClasslikes%2F765871198" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain :tgbotapi.core:dokkaHtmlPartial/jsMain :tgbotapi.core:dokkaHtmlPartial/jvmMain :tgbotapi.core:dokkaHtmlPartial/linuxX64Main :tgbotapi.core:dokkaHtmlPartial/mingwX64Main"></a>
<div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain :tgbotapi.core:dokkaHtmlPartial/jsMain :tgbotapi.core:dokkaHtmlPartial/jvmMain :tgbotapi.core:dokkaHtmlPartial/linuxX64Main :tgbotapi.core:dokkaHtmlPartial/mingwX64Main" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain :tgbotapi.core:dokkaHtmlPartial/jsMain :tgbotapi.core:dokkaHtmlPartial/jvmMain :tgbotapi.core:dokkaHtmlPartial/linuxX64Main :tgbotapi.core:dokkaHtmlPartial/mingwX64Main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-ktor-requests-executor/index.html"><span>Ktor</span><wbr><span>Requests</span><wbr><span><span>Executor</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="533040876%2FClasslikes%2F765871198"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":tgbotapi.core:dokkaHtmlPartial/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/jsMain" data-toggle=":tgbotapi.core:dokkaHtmlPartial/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/jvmMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/jvmMain" data-toggle=":tgbotapi.core:dokkaHtmlPartial/jvmMain">jvm</button><button class="platform-bookmark" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/linuxX64Main" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/linuxX64Main" data-toggle=":tgbotapi.core:dokkaHtmlPartial/linuxX64Main">linuxX64</button><button class="platform-bookmark" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/mingwX64Main" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/mingwX64Main" data-toggle=":tgbotapi.core:dokkaHtmlPartial/mingwX64Main">mingwX64</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">class </span><a href="-ktor-requests-executor/index.html">KtorRequestsExecutor</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">telegramAPIUrlsKeeper<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.utils/-telegram-a-p-i-urls-keeper/index.html">TelegramAPIUrlsKeeper</a><span class="token punctuation">, </span></span><span class="parameter ">client<span class="token operator">: </span><span data-unresolved-link="io.ktor.client/HttpClient///PointingToDeclaration/">HttpClient</span><span class="token operator"> = </span>HttpClient()<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><span class="token keyword"></span><a href="-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">&gt;</span><span class="token operator"> = </span>emptyList()<span class="token punctuation">, </span></span><span class="parameter ">excludeDefaultFactories<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">requestsLimiter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot.settings.limiters/-request-limiter/index.html">RequestLimiter</a><span class="token operator"> = </span>ExceptionsOnlyLimiter<span class="token punctuation">, </span></span><span class="parameter ">jsonFormatter<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator"> = </span>nonstrictJsonFormat<span class="token punctuation">, </span></span><span class="parameter ">pipelineStepsHolder<span class="token operator">: </span><a href="-ktor-pipeline-steps-holder/index.html">KtorPipelineStepsHolder</a><span class="token operator"> = </span>KtorPipelineStepsHolder</span></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.bot/-base-requests-executor/index.html">BaseRequestsExecutor</a></div><div class="brief "><p class="paragraph">Represents default <a href="../dev.inmo.tgbotapi.bot/-base-requests-executor/index.html">BaseRequestsExecutor</a> working on <a href="https://ktor.io">Ktor</a> <span data-unresolved-link="io.ktor.client/HttpClient///PointingToDeclaration/">HttpClient</span></p></div></div><div class="content sourceset-dependent-content" data-togglable=":tgbotapi.core:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">typealias </span><a href="-ktor-requests-executor/index.html">KtorRequestsExecutor</a><span class="token operator"> = </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.ktor.base/-default-ktor-requests-executor/index.html">DefaultKtorRequestsExecutor</a></div></div><div class="content sourceset-dependent-content" data-togglable=":tgbotapi.core:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">typealias </span><a href="-ktor-requests-executor/index.html">KtorRequestsExecutor</a><span class="token operator"> = </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.ktor.base/-default-ktor-requests-executor/index.html">DefaultKtorRequestsExecutor</a></div></div><div class="content sourceset-dependent-content" data-togglable=":tgbotapi.core:dokkaHtmlPartial/linuxX64Main"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">typealias </span><a href="-ktor-requests-executor/index.html">KtorRequestsExecutor</a><span class="token operator"> = </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.ktor.base/-multiple-client-ktor-requests-executor/index.html">MultipleClientKtorRequestsExecutor</a></div></div><div class="content sourceset-dependent-content" data-togglable=":tgbotapi.core:dokkaHtmlPartial/mingwX64Main"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">typealias </span><a href="-ktor-requests-executor/index.html">KtorRequestsExecutor</a><span class="token operator"> = </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.ktor.base/-default-ktor-requests-executor/index.html">DefaultKtorRequestsExecutor</a></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="197144059%2FClasslikes%2F789214110" anchor-label="KtorRequestsExecutorBuilder" id="197144059%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="-ktor-requests-executor-builder/index.html"><span>Ktor</span><wbr><span>Requests</span><wbr><span>Executor</span><wbr><span><span>Builder</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="197144059%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">class </span><a href="-ktor-requests-executor-builder/index.html">KtorRequestsExecutorBuilder</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </span>telegramAPIUrlsKeeper<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.utils/-telegram-a-p-i-urls-keeper/index.html">TelegramAPIUrlsKeeper</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="-1956548409%2FFunctions%2F789214110" anchor-label="createTelegramBotDefaultKtorCallRequestsFactories" id="-1956548409%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="create-telegram-bot-default-ktor-call-requests-factories.html"><span>create</span><wbr><span>Telegram</span><wbr><span>Bot</span><wbr><span>Default</span><wbr><span>Ktor</span><wbr><span>Call</span><wbr><span>Requests</span><wbr><span><span>Factories</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1956548409%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"></span><span class="token keyword">fun </span><a href="create-telegram-bot-default-ktor-call-requests-factories.html"><span class="token function">createTelegramBotDefaultKtorCallRequestsFactories</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><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><span class="token keyword"></span><a href="-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1135324461%2FFunctions%2F789214110" anchor-label="telegramBot" id="-1135324461%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="telegram-bot.html"><span>telegram</span><wbr><span><span>Bot</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1135324461%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">inline </span><span class="token keyword">fun </span><a href="telegram-bot.html"><span class="token function">telegramBot</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">telegramAPIUrlsKeeper<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.utils/-telegram-a-p-i-urls-keeper/index.html">TelegramAPIUrlsKeeper</a><span class="token punctuation">, </span></span><span class="parameter ">builder<span class="token operator">: </span><span class="token keyword"></span><a href="-ktor-requests-executor-builder/index.html">KtorRequestsExecutorBuilder</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a></div><br><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="telegram-bot.html"><span class="token function">telegramBot</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">token<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">apiUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>telegramBotAPIDefaultUrl<span class="token punctuation">, </span></span><span class="parameter ">testServer<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">builder<span class="token operator">: </span><span class="token keyword"></span><a href="-ktor-requests-executor-builder/index.html">KtorRequestsExecutorBuilder</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a></div><div class="brief "><p class="paragraph">Shortcut for <a href="telegram-bot.html">telegramBot</a></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>© 2023 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>
View Git Blame Copy Permalink