mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-09 09:53:47 +00:00
67 lines
12 KiB
HTML
67 lines
12 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>longPolling</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>ktgbotapi</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.utils:dokkaHtmlPartial/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" data-page-type="member" id="content" pageids="tgbotapi.utils::dev.inmo.tgbotapi.extensions.utils.updates.retrieving//longPolling/dev.inmo.tgbotapi.bot.RequestsExecutor#dev.inmo.tgbotapi.updateshandlers.UpdatesFilter#kotlin.Int#kotlinx.coroutines.CoroutineScope#kotlin.Boolean#kotlin.Boolean#kotlin.Long?#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]?/PointingToDeclaration//-957209142">
|
|
<div class="breadcrumbs"><a href="../index.html">tgbotapi.utils</a><span class="delimiter">/</span><a href="index.html">dev.inmo.tgbotapi.extensions.utils.updates.retrieving</a><span class="delimiter">/</span><span class="current">longPolling</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>long</span><wbr><span><span>Polling</span></span></h1>
|
|
</div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.utils:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a><span class="token punctuation">.</span><a href="long-polling.html"><span class="token function">longPolling</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">updatesFilter<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.updateshandlers/-updates-filter/index.html">UpdatesFilter</a><span class="token punctuation">, </span></span><span class="parameter ">timeoutSeconds<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-seconds/index.html">Seconds</a><span class="token operator"> = </span><span class="token constant">30</span><span class="token punctuation">, </span></span><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token operator"> = </span>CoroutineScope(Dispatchers.Default)<span class="token punctuation">, </span></span><span class="parameter ">autoDisableWebhooks<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">true</span><span class="token punctuation">, </span></span><span class="parameter ">autoSkipTimeoutExceptions<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">true</span><span class="token punctuation">, </span></span><span class="parameter ">mediaGroupsDebounceTimeMillis<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span><span class="token constant">1000</span><span class="token punctuation">, </span></span><span class="parameter ">exceptionsHandler<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><span class="token operator"><</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 class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><p class="paragraph">Will <a href="start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a> using incoming <a href="long-polling.html">updatesFilter</a>. It is assumed that you ALREADY CONFIGURE all updates receivers, because this method will trigger getting of updates and.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.utils:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.utils:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>media</span><wbr><span>Groups</span><wbr><span>Debounce</span><wbr><span>Time</span><wbr><span><span>Millis</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used for calling of <a href="update-handler-with-media-groups-adaptation.html">updateHandlerWithMediaGroupsAdaptation</a>. Pass null in case you wish to enable classic way of updates handling, but in that mode some media group messages can be retrieved in different updates</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a><span class="token punctuation">.</span><a href="long-polling.html"><span class="token function">longPolling</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">timeoutSeconds<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-seconds/index.html">Seconds</a><span class="token operator"> = </span><span class="token constant">30</span><span class="token punctuation">, </span></span><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token operator"> = </span>CoroutineScope(Dispatchers.Default)<span class="token punctuation">, </span></span><span class="parameter ">exceptionsHandler<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><span class="token operator"><</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 class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">flowsUpdatesFilterUpdatesKeeperCount<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">100</span><span class="token punctuation">, </span></span><span class="parameter ">autoDisableWebhooks<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">true</span><span class="token punctuation">, </span></span><span class="parameter ">autoSkipTimeoutExceptions<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">true</span><span class="token punctuation">, </span></span><span class="parameter ">mediaGroupsDebounceTimeMillis<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span><span class="token constant">1000</span><span class="token punctuation">, </span></span><span class="parameter ">flowUpdatesPreset<span class="token operator">: </span><span class="token keyword"></span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><p class="paragraph">Will enable <a href="long-polling.html">longPolling</a> by creating <a href="../../tgbotapi.core/dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a> with <a href="long-polling.html">flowsUpdatesFilterUpdatesKeeperCount</a> as an argument and applied <a href="long-polling.html">flowUpdatesPreset</a>. It is assumed that you WILL CONFIGURE all updates receivers in <a href="long-polling.html">flowUpdatesPreset</a>, because of after <a href="long-polling.html">flowUpdatesPreset</a> method calling will be triggered getting of updates.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.utils:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.utils:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>media</span><wbr><span>Groups</span><wbr><span>Debounce</span><wbr><span>Time</span><wbr><span><span>Millis</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used for calling of <a href="update-handler-with-media-groups-adaptation.html">updateHandlerWithMediaGroupsAdaptation</a>. Pass null in case you wish to enable classic way of updates handling, but in that mode some media group messages can be retrieved in different updates</p></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>
|
|
|