mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-12-23 09:07:12 +00:00
40 lines
9.6 KiB
HTML
40 lines
9.6 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>startListenWebhooks</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>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.extensions.utils.updates.retrieving//startListenWebhooks/#kotlin.Int#io.ktor.server.engine.ApplicationEngineFactory[*,*]#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]#kotlin.String#kotlin.String?#dev.inmo.tgbotapi.updateshandlers.webhook.WebhookPrivateKeyConfig?#kotlinx.coroutines.CoroutineScope#kotlin.Long#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.update.abstracts.Update,kotlin.Unit]/PointingToDeclaration//2063174889">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../index.html">docs</a>/<a href="index.html">dev.inmo.tgbotapi.extensions.utils.updates.retrieving</a>/<a href="start-listen-webhooks.html">startListenWebhooks</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":docs:dokkaHtml/jvmMain">jvm</button></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>start</span><wbr></wbr><span>Listen</span><wbr></wbr><span><span>Webhooks</span></span></h1>
|
|
</div>
|
|
<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">fun <a href="start-listen-webhooks.html">startListenWebhooks</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><*, *>, 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>? = null, 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>
|
|
<p class="paragraph">Setting up ktor server</p><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/jvmMain"><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><span data-unresolved-link="dev.inmo.tgbotapi.updateshandlers/FlowsUpdatesFilter///PointingToDeclaration/"><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>updateshandlers.</span><wbr></wbr><span>Flows</span><wbr></wbr><span>Updates</span><wbr></wbr><span><span>Filter</span></span></span></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/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><span data-unresolved-link="dev.inmo.tgbotapi.updateshandlers/UpdatesFilter/asUpdateReceiver/#/PointingToDeclaration/"><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>updateshandlers.</span><wbr></wbr><span>Updates</span><wbr></wbr><span><span>Filter</span></span></span></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div></div></div></div></div></div><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span>listen</span><wbr></wbr><span><span>Port</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">port which will be listen by bot</p></div></div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span>listen</span><wbr></wbr><span><span>Route</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">address to listen by bot. If null - will be set up in root of host</p></div></div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span><span>scope</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Scope which will be used for</p></div></div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span>private</span><wbr></wbr><span>Key</span><wbr></wbr><span><span>Config</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If configured - server will be created with <span data-unresolved-link="io.ktor.server.engine//sslConnector/io.ktor.server.engine.ApplicationEngineEnvironmentBuilder#java.security.KeyStore#kotlin.String#kotlin.Function0[kotlin.CharArray]#kotlin.Function0[kotlin.CharArray]#kotlin.Function1[io.ktor.server.engine.EngineSSLConnectorBuilder,kotlin.Unit]/PointingToDeclaration/">sslConnector</span>. <span data-unresolved-link="io.ktor.server.engine//connector/io.ktor.server.engine.ApplicationEngineEnvironmentBuilder#kotlin.Function1[io.ktor.server.engine.EngineConnectorBuilder,kotlin.Unit]/PointingToDeclaration/">connector</span> will be used otherwise</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"></a></span><span>© 2021 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>
|
|
|