InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-26 12:08:43 +00:00
Code Releases Activity
036e5da4fc
tgbotapi/tgbotapi.core/dev.inmo.tgbotapi.bot.ktor.base/index.html
InsanusMokrassar 036e5da4fc deploy: 482c375327
2024-10-21 12:34:52 +00:00

209 lines
21 KiB
HTML
Raw Blame History

<!doctype html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dev.inmo.tgbotapi.bot.ktor.base</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="package" id="content" pageids="tgbotapi.core::dev.inmo.tgbotapi.bot.ktor.base////PointingToDeclaration//789214110">
<div class="breadcrumbs"><a href="../index.html">tgbotapi.core</a><span class="delimiter">/</span><span class="current">dev.inmo.tgbotapi.bot.ktor.base</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="PROPERTY,EXTENSION_PROPERTY">Properties</button></div>
<div class="tabs-section-body">
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="1590619925%2FClasslikes%2F789214110" anchor-label="AbstractRequestCallFactory" id="1590619925%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="-abstract-request-call-factory/index.html"><span>Abstract</span><wbr><span>Request</span><wbr><span>Call</span><wbr><span><span>Factory</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1590619925%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">abstract </span><span class="token keyword">class </span><a href="-abstract-request-call-factory/index.html">AbstractRequestCallFactory</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>DefaultKTgBotAPIKSLog</span></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1809555146%2FClasslikes%2F789214110" anchor-label="DefaultKtorRequestsExecutor" id="1809555146%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="-default-ktor-requests-executor/index.html"><span>Default</span><wbr><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="1809555146%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="-default-ktor-requests-executor/index.html">DefaultKtorRequestsExecutor</a> : <a href="../dev.inmo.tgbotapi.bot/-base-requests-executor/index.html">BaseRequestsExecutor</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-467520526%2FClasslikes%2F789214110" anchor-label="DownloadFileChannelRequestCallFactory" id="-467520526%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="-download-file-channel-request-call-factory/index.html"><span>Download</span><wbr><span>File</span><wbr><span>Channel</span><wbr><span>Request</span><wbr><span>Call</span><wbr><span><span>Factory</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-467520526%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="-download-file-channel-request-call-factory/index.html">DownloadFileChannelRequestCallFactory</a> : <a href="../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1567050323%2FClasslikes%2F789214110" anchor-label="DownloadFileRequestCallFactory" id="1567050323%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="-download-file-request-call-factory/index.html"><span>Download</span><wbr><span>File</span><wbr><span>Request</span><wbr><span>Call</span><wbr><span><span>Factory</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1567050323%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="-download-file-request-call-factory/index.html">DownloadFileRequestCallFactory</a> : <a href="../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-423869531%2FClasslikes%2F789214110" anchor-label="MultipartRequestCallFactory" id="-423869531%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="-multipart-request-call-factory/index.html"><span>Multipart</span><wbr><span>Request</span><wbr><span>Call</span><wbr><span><span>Factory</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-423869531%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="-multipart-request-call-factory/index.html">MultipartRequestCallFactory</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span> : <a href="-abstract-request-call-factory/index.html">AbstractRequestCallFactory</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1281049334%2FClasslikes%2F789214110" anchor-label="MultipleClientKtorRequestsExecutor" id="1281049334%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="-multiple-client-ktor-requests-executor/index.html"><span>Multiple</span><wbr><span>Client</span><wbr><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="1281049334%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="-multiple-client-ktor-requests-executor/index.html">MultipleClientKtorRequestsExecutor</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 ">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="../dev.inmo.tgbotapi.bot.ktor/-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">&gt;</span><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 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 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 punctuation">, </span></span><span class="parameter ">pipelineStepsHolder<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot.ktor/-telegram-bot-pipelines-handler/index.html">TelegramBotPipelinesHandler</a><span class="token punctuation">, </span></span><span class="parameter ">requestExecutorsCount<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token punctuation">, </span></span><span class="parameter ">clientFactory<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span data-unresolved-link="io.ktor.client/HttpClient///PointingToDeclaration/">HttpClient</span></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">Will use its parameters of constructor to create several <a href="-default-ktor-requests-executor/index.html">DefaultKtorRequestsExecutor</a> and use them in <a href="-multiple-client-ktor-requests-executor/execute.html">execute</a> and <a href="-multiple-client-ktor-requests-executor/close.html">close</a> operations</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-841344955%2FClasslikes%2F789214110" anchor-label="SimpleRequestCallFactory" id="-841344955%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="-simple-request-call-factory/index.html"><span>Simple</span><wbr><span>Request</span><wbr><span>Call</span><wbr><span><span>Factory</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-841344955%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="-simple-request-call-factory/index.html">SimpleRequestCallFactory</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span> : <a href="-abstract-request-call-factory/index.html">AbstractRequestCallFactory</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-834309022%2FProperties%2F789214110" anchor-label="defaultUpdateTimeoutForZeroDelay" id="-834309022%2FProperties%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="default-update-timeout-for-zero-delay.html"><span>default</span><wbr><span>Update</span><wbr><span>Timeout</span><wbr><span>For</span><wbr><span>Zero</span><wbr><span><span>Delay</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-834309022%2FProperties%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">var </span><a href="default-update-timeout-for-zero-delay.html">defaultUpdateTimeoutForZeroDelay</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></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>
View Git Blame Copy Permalink