mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2025-11-27 17:55:52 +00:00
deploy: d4f24ee0cd
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>RequestsExecutor</title>
|
||||
<link href="../../../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.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" async="async"></script> </head>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.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" async="async"></script> </head>
|
||||
<body>
|
||||
<div id="container">
|
||||
<div id="leftColumn"><a href="../../../index.html">
|
||||
@@ -22,7 +22,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>Requests</span><wbr></wbr><span>Executor</span></h1>
|
||||
<h1 class="cover"><span>Requests</span><wbr></wbr><span><span>Executor</span></span></h1>
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">interface <a href="index.html">RequestsExecutor</a> : <span data-unresolved-link="io.ktor.utils.io.core/Closeable///PointingToDeclaration/">Closeable</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><p class="paragraph">Interface for making requests to Telegram Bot API. Currently, there is only one built-in implementation - <a href="../../dev.inmo.tgbotapi.bot.Ktor/-ktor-requests-executor/index.html">dev.inmo.tgbotapi.bot.Ktor.KtorRequestsExecutor</a></p></div></div>
|
||||
</div>
|
||||
<div class="tabbedcontent">
|
||||
@@ -30,13 +30,13 @@
|
||||
<div class="tabs-section-body">
|
||||
<h2 class="">See also</h2>
|
||||
<div data-togglable="See also">
|
||||
<div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="See also"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">dev.inmo.tgbotapi.requests.abstracts.Request</a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.bot.Ktor/-ktor-requests-executor/index.html">dev.inmo.tgbotapi.bot.Ktor.KtorRequestsExecutor</a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div></div></div></div></div>
|
||||
<div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="See also"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html"><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>requests.</span><wbr></wbr><span>abstracts.</span><wbr></wbr><span>Request</span></a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.bot.Ktor/-ktor-requests-executor/index.html"><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>bot.</span><wbr></wbr><span>Ktor.</span><wbr></wbr><span>Ktor</span><wbr></wbr><span>Requests</span><wbr></wbr><span><span>Executor</span></span></a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div></div></div></div></div>
|
||||
</div>
|
||||
<h2 class="">Functions</h2>
|
||||
<div class="table" data-togglable="Functions"><a data-name="539526881%2FFunctions%2F-1982836883" anchor-label="close" id="539526881%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"><a href="../../dev.inmo.tgbotapi.extensions.behaviour_builder/-default-behaviour-context/index.html#539526881%2FFunctions%2F-1982836883">close</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="539526881%2FFunctions%2F-1982836883"></span>
|
||||
<div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.extensions.behaviour_builder/-default-behaviour-context/index.html#539526881%2FFunctions%2F-1982836883"><span><span>close</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="539526881%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>
|
||||
@@ -56,7 +56,7 @@
|
||||
<a data-name="-2115112755%2FFunctions%2F-1982836883" anchor-label="execute" id="-2115112755%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"><a href="execute.html">execute</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2115112755%2FFunctions%2F-1982836883"></span>
|
||||
<div class=""><span class="inline-flex"><a href="execute.html"><span><span>execute</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2115112755%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>
|
||||
@@ -68,7 +68,7 @@
|
||||
<div>
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">abstract suspend fun <<a href="execute.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>> <a href="execute.html">execute</a>(request: <a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><<a href="execute.html">T</a>>): <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></div>
|
||||
</div>
|
||||
<a data-name="-2115112755%2FFunctions%2F-1982836883" anchor-label="execute" id="-2115112755%2FFunctions%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a><div class="brief "><a data-name="-2115112755%2FFunctions%2F-1982836883" anchor-label="execute" id="-2115112755%2FFunctions%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>Unsafe execution of incoming <a href="execute.html">request</a>.</div></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>
|
||||
@@ -107,7 +107,7 @@
|
||||
<div class="table" data-togglable="Extensions"><a data-name="356852609%2FExtensions%2F-1982836883" anchor-label="executeAsync" id="356852609%2FExtensions%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"><a href="../../dev.inmo.tgbotapi.extensions.utils.shortcuts/execute-async.html">executeAsync</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="356852609%2FExtensions%2F-1982836883"></span>
|
||||
<div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.extensions.utils.shortcuts/execute-async.html"><span>execute</span><wbr></wbr><span><span>Async</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="356852609%2FExtensions%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>
|
||||
@@ -127,7 +127,7 @@
|
||||
<a data-name="-1781699129%2FExtensions%2F-1982836883" anchor-label="executeUnsafe" id="-1781699129%2FExtensions%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"><a href="../../dev.inmo.tgbotapi.extensions.utils.shortcuts/execute-unsafe.html">executeUnsafe</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1781699129%2FExtensions%2F-1982836883"></span>
|
||||
<div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.extensions.utils.shortcuts/execute-unsafe.html"><span>execute</span><wbr></wbr><span><span>Unsafe</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1781699129%2FExtensions%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>
|
||||
@@ -147,7 +147,7 @@
|
||||
<a data-name="-2099623137%2FExtensions%2F2063174889" anchor-label="setWebhookInfoAndStartListenWebhooks" id="-2099623137%2FExtensions%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a>
|
||||
<div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/set-webhook-info-and-start-listen-webhooks.html">setWebhookInfoAndStartListenWebhooks</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2099623137%2FExtensions%2F2063174889"></span>
|
||||
<div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/set-webhook-info-and-start-listen-webhooks.html"><span>set</span><wbr></wbr><span>Webhook</span><wbr></wbr><span>Info</span><wbr></wbr><span>And</span><wbr></wbr><span>Start</span><wbr></wbr><span>Listen</span><wbr></wbr><span><span>Webhooks</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2099623137%2FExtensions%2F2063174889"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
@@ -157,9 +157,9 @@
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
||||
|
||||
<div>
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace">suspend fun <a href="index.html#1584683032%2FExtensions%2F2063174889">RequestsExecutor</a>.<a href="../../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/set-webhook-info-and-start-listen-webhooks.html">setWebhookInfoAndStartListenWebhooks</a>(listenPort: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>, engineFactory: <span data-unresolved-link="io.ktor.server.engine/ApplicationEngineFactory///PointingToDeclaration/">ApplicationEngineFactory</span><*, *>, setWebhookRequest: <a href="../../dev.inmo.tgbotapi.requests.webhook/-set-webhook-request/index.html">SetWebhookRequest</a>, exceptionsHandler: <span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> = {}, listenHost: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = "0.0.0.0", listenRoute: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = "/", privateKeyConfig: <a href="../../dev.inmo.tgbotapi.updateshandlers.webhook/-webhook-private-key-config/index.html">WebhookPrivateKeyConfig</a>? = null, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = CoroutineScope(Executors.newFixedThreadPool(4).asCoroutineDispatcher()), mediaGroupsDebounceTimeMillis: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 1000L, block: <span data-unresolved-link="dev.inmo.tgbotapi.updateshandlers/UpdateReceiver///PointingToDeclaration/">UpdateReceiver</span><<a href="../../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>>): <span data-unresolved-link="io.ktor.server.engine/ApplicationEngine///PointingToDeclaration/">ApplicationEngine</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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace">suspend fun <a href="index.html#1584683032%2FExtensions%2F2063174889">RequestsExecutor</a>.<a href="../../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/set-webhook-info-and-start-listen-webhooks.html">setWebhookInfoAndStartListenWebhooks</a>(listenPort: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>, engineFactory: <span data-unresolved-link="io.ktor.server.engine/ApplicationEngineFactory///PointingToDeclaration/">ApplicationEngineFactory</span><*, *>, setWebhookRequest: <span data-unresolved-link="dev.inmo.tgbotapi.requests.webhook/SetWebhookRequest///PointingToDeclaration/">SetWebhookRequest</span>, exceptionsHandler: <span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> = {}, listenHost: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = "0.0.0.0", listenRoute: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = "/", privateKeyConfig: <a href="../../dev.inmo.tgbotapi.updateshandlers.webhook/-webhook-private-key-config/index.html">WebhookPrivateKeyConfig</a>? = null, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = CoroutineScope(Executors.newFixedThreadPool(4).asCoroutineDispatcher()), mediaGroupsDebounceTimeMillis: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 1000L, block: <span data-unresolved-link="dev.inmo.tgbotapi.updateshandlers/UpdateReceiver///PointingToDeclaration/">UpdateReceiver</span><<span data-unresolved-link="dev.inmo.tgbotapi.types.update.abstracts/Update///PointingToDeclaration/">Update</span>>): <span data-unresolved-link="io.ktor.server.engine/ApplicationEngine///PointingToDeclaration/">ApplicationEngine</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>
|
||||
<a data-name="-2099623137%2FExtensions%2F2063174889" anchor-label="setWebhookInfoAndStartListenWebhooks" id="-2099623137%2FExtensions%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a><div class="brief "><a data-name="-2099623137%2FExtensions%2F2063174889" anchor-label="setWebhookInfoAndStartListenWebhooks" id="-2099623137%2FExtensions%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a>Setting up ktor server, set webhook info via <a href="../../dev.inmo.tgbotapi.requests.webhook/-set-webhook-request/index.html">SetWebhookRequest</a> request.</div></div>
|
||||
<div class="brief "><p class="paragraph">Setting up ktor server, set webhook info via <span data-unresolved-link="dev.inmo.tgbotapi.requests.webhook/SetWebhookRequest///PointingToDeclaration/">SetWebhookRequest</span> request.</p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,7 +167,7 @@
|
||||
<a data-name="-688805984%2FExtensions%2F-1982836883" anchor-label="startGettingOfUpdatesByLongPolling" id="-688805984%2FExtensions%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"><a href="../../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-688805984%2FExtensions%2F-1982836883"></span>
|
||||
<div class=""><span class="inline-flex"><a href="../../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/start-getting-of-updates-by-long-polling.html"><span>start</span><wbr></wbr><span>Getting</span><wbr></wbr><span>Of</span><wbr></wbr><span>Updates</span><wbr></wbr><span>By</span><wbr></wbr><span>Long</span><wbr></wbr><span><span>Polling</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-688805984%2FExtensions%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>
|
||||
|
||||
Reference in New Issue
Block a user