mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-03 06:53:48 +00:00
125 lines
16 KiB
HTML
125 lines
16 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||
|
|
<title>KtorRequestsExecutor</title>
|
||
|
|
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||
|
|
<script>var pathToRoot = "../../../";</script>
|
||
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||
|
|
const savedDarkMode = storage ? JSON.parse(storage) : false
|
||
|
|
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/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="async"></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>
|
||
|
|
</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>docs</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=":docs:dokkaHtml/commonMain">common</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" id="content" pageIds="docs::dev.inmo.tgbotapi.bot.ktor/KtorRequestsExecutor///PointingToDeclaration//-1982836883">
|
||
|
|
<div class="breadcrumbs"><a href="../../../index.html">docs</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.tgbotapi.bot.ktor</a><span class="delimiter">/</span><a href="index.html">KtorRequestsExecutor</a></div>
|
||
|
|
<div class="cover ">
|
||
|
|
<h1 class="cover"><span>Ktor</span><wbr></wbr><span>Requests</span><wbr></wbr><span><span>Executor</span></span></h1>
|
||
|
|
<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 common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div>
|
||
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">KtorRequestsExecutor</a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented"> 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 indented"> 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 indented"> 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><span class="token keyword"></span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></span><span class="token operator"> = </span>emptyList()<span class="token punctuation">, </span></span><span class="parameter indented"> 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 indented"> 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 indented"> 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 indented"> 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><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div> </div>
|
||
|
|
</div>
|
||
|
|
<div class="tabbedcontent">
|
||
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
|
||
|
|
<div class="tabs-section-body">
|
||
|
|
<h2 class="tabbedcontent">Constructors</h2>
|
||
|
|
<div class="table" data-togglable="Constructors"><a data-name="-1890418517%2FConstructors%2F-1982836883" anchor-label="KtorRequestsExecutor" id="-1890418517%2FConstructors%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
|
||
|
|
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
|
||
|
|
<div class="main-subrow keyValue TabbedContent">
|
||
|
|
<div class=""><span class="inline-flex">
|
||
|
|
<div><a href="-ktor-requests-executor.html"><span>Ktor</span><wbr></wbr><span>Requests</span><wbr></wbr><span><span>Executor</span></span></a></div>
|
||
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1890418517%2FConstructors%2F-1982836883"></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 common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div>
|
||
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-ktor-requests-executor.html"><span class="token function">KtorRequestsExecutor</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented"> 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 indented"> 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 indented"> 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><span class="token keyword"></span><a href="../-ktor-call-factory/index.html">KtorCallFactory</a><span class="token operator">></span><span class="token operator"> = </span>emptyList()<span class="token punctuation">, </span></span><span class="parameter indented"> 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 indented"> 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 indented"> 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 indented"> 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><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div> </div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="">Functions</h2>
|
||
|
|
<div class="table" data-togglable="Functions"><a data-name="-1399312081%2FFunctions%2F-1982836883" anchor-label="close" id="-1399312081%2FFunctions%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
|
||
|
|
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
|
||
|
|
<div class="main-subrow keyValue ">
|
||
|
|
<div class=""><span class="inline-flex">
|
||
|
|
<div><a href="close.html"><span><span>close</span></span></a></div>
|
||
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1399312081%2FFunctions%2F-1982836883"></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 common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div>
|
||
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="close.html"><span class="token function">close</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div> </div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a data-name="-1750936159%2FFunctions%2F-1982836883" anchor-label="execute" id="-1750936159%2FFunctions%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
|
||
|
|
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
|
||
|
|
<div class="main-subrow keyValue ">
|
||
|
|
<div class=""><span class="inline-flex">
|
||
|
|
<div><a href="execute.html"><span><span>execute</span></span></a></div>
|
||
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1750936159%2FFunctions%2F-1982836883"></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 common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div>
|
||
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="execute.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="execute.html"><span class="token function">execute</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 keyword"></span><a href="execute.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="execute.html">T</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Unsafe execution of incoming <a href="execute.html">request</a>. Can throw almost any exception. So, it is better to use something like <a href="../../dev.inmo.tgbotapi.extensions.utils.shortcuts/execute-async.html">dev.inmo.tgbotapi.extensions.utils.shortcuts.executeAsync</a> or <a href="../../dev.inmo.tgbotapi.extensions.utils.shortcuts/execute-unsafe.html">dev.inmo.tgbotapi.extensions.utils.shortcuts.executeUnsafe</a></p></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>© 2022 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>
|