mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-12-23 17:17:13 +00:00
247 lines
40 KiB
HTML
247 lines
40 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>dev.inmo.tgbotapi.extensions.utils.updates.retrieving</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////PointingToDeclaration//1103238440">
|
|
<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></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><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><span>Package</span></span> <span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>extensions.</span><wbr></wbr><span>utils.</span><wbr></wbr><span>updates.</span><wbr></wbr><span>retrieving</span></h1>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="895087387%2FFunctions%2F-1982836883" anchor-label="createAccumulatedUpdatesRetrieverFlow" id="895087387%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="create-accumulated-updates-retriever-flow.html"><span>create</span><wbr></wbr><span>Accumulated</span><wbr></wbr><span>Updates</span><wbr></wbr><span>Retriever</span><wbr></wbr><span><span>Flow</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="895087387%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="create-accumulated-updates-retriever-flow.html">createAccumulatedUpdatesRetrieverFlow</a>(avoidInlineQueries: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, avoidCallbackQueries: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, 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>>? = null, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>? = null): <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="135906216%2FFunctions%2F2063174889" anchor-label="includeWebhookHandlingInRoute" id="135906216%2FFunctions%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="include-webhook-handling-in-route.html"><span>include</span><wbr></wbr><span>Webhook</span><wbr></wbr><span>Handling</span><wbr></wbr><span>In</span><wbr></wbr><span><span>Route</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="135906216%2FFunctions%2F2063174889"></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="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<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">fun <span data-unresolved-link="io.ktor.routing/Route///PointingToDeclaration/">Route</span>.<a href="include-webhook-handling-in-route.html">includeWebhookHandlingInRoute</a>(scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</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>>? = null, 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 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="brief "><p class="paragraph">Allows to include webhook in custom route everywhere in your server</p></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-868229438%2FFunctions%2F2063174889" anchor-label="includeWebhookHandlingInRouteWithFlows" id="-868229438%2FFunctions%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="include-webhook-handling-in-route-with-flows.html"><span>include</span><wbr></wbr><span>Webhook</span><wbr></wbr><span>Handling</span><wbr></wbr><span>In</span><wbr></wbr><span>Route</span><wbr></wbr><span>With</span><wbr></wbr><span><span>Flows</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-868229438%2FFunctions%2F2063174889"></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="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<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">fun <span data-unresolved-link="io.ktor.routing/Route///PointingToDeclaration/">Route</span>.<a href="include-webhook-handling-in-route-with-flows.html">includeWebhookHandlingInRouteWithFlows</a>(scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</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>>? = null, 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/FlowsUpdatesFilter///PointingToDeclaration/">FlowsUpdatesFilter</span>.() -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="371375894%2FFunctions%2F-1982836883" anchor-label="longPolling" id="371375894%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="long-polling.html"><span>long</span><wbr></wbr><span><span>Polling</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="371375894%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="long-polling.html">longPolling</a>(flowsUpdatesFilter: <a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a>, timeoutSeconds: <a href="../dev.inmo.tgbotapi.types/index.html#-1838927582%2FClasslikes%2F-1982836883">Seconds</a> = 30, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = CoroutineScope(Dispatchers.Default), 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>>? = null): <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</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 class="brief "><p class="paragraph">Will <a href="start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a> using incoming <a href="long-polling.html">flowsUpdatesFilter</a>. It is assumed that you ALREADY CONFIGURE all updates receivers, because this method will trigger getting of updates and.</p></div></div>
|
|
<div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="long-polling.html">longPolling</a>(timeoutSeconds: <a href="../dev.inmo.tgbotapi.types/index.html#-1838927582%2FClasslikes%2F-1982836883">Seconds</a> = 30, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = CoroutineScope(Dispatchers.Default), 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>>? = null, flowsUpdatesFilterUpdatesKeeperCount: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = 100, flowUpdatesPreset: <a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a>.() -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</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 class="brief "><p class="paragraph">Will enable <a href="long-polling.html">longPolling</a> by creating <a href="../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></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="728851747%2FFunctions%2F-1982836883" anchor-label="longPollingFlow" id="728851747%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="long-polling-flow.html"><span>long</span><wbr></wbr><span>Polling</span><wbr></wbr><span><span>Flow</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="728851747%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="long-polling-flow.html">longPollingFlow</a>(timeoutSeconds: <a href="../dev.inmo.tgbotapi.types/index.html#-1838927582%2FClasslikes%2F-1982836883">Seconds</a> = 30, 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>>? = null, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>? = null): <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-25728744%2FFunctions%2F-1982836883" anchor-label="retrieveAccumulatedUpdates" id="-25728744%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="retrieve-accumulated-updates.html"><span>retrieve</span><wbr></wbr><span>Accumulated</span><wbr></wbr><span><span>Updates</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-25728744%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="retrieve-accumulated-updates.html">retrieveAccumulatedUpdates</a>(flowsUpdatesFilter: <a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a>, avoidInlineQueries: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, avoidCallbackQueries: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = CoroutineScope(Dispatchers.Default), 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>>? = null): <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</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 class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="retrieve-accumulated-updates.html">retrieveAccumulatedUpdates</a>(avoidInlineQueries: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, avoidCallbackQueries: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = CoroutineScope(Dispatchers.Default), 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>>? = null, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>? = null, updatesReceiver: <a href="../dev.inmo.tgbotapi.updateshandlers/index.html#-1676068861%2FClasslikes%2F-1982836883">UpdateReceiver</a><<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>>): <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</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>
|
|
</div>
|
|
<a data-name="-2099623137%2FFunctions%2F2063174889" anchor-label="setWebhookInfoAndStartListenWebhooks" id="-2099623137%2FFunctions%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="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%2FFunctions%2F2063174889"></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="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<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="../dev.inmo.tgbotapi.bot/-requests-executor/index.html#1584683032%2FExtensions%2F2063174889">RequestsExecutor</a>.<a href="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>
|
|
<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>
|
|
</div>
|
|
<a data-name="-1882856717%2FFunctions%2F-1982836883" anchor-label="startGettingOfUpdatesByLongPolling" id="-1882856717%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="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="-1882856717%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.bot/-requests-executor/index.html">RequestsExecutor</a>.<a href="start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a>(updatesFilter: <a href="../dev.inmo.tgbotapi.updateshandlers/-updates-filter/index.html">UpdatesFilter</a>, timeoutSeconds: <a href="../dev.inmo.tgbotapi.types/index.html#-1838927582%2FClasslikes%2F-1982836883">Seconds</a> = 30, 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>>? = null, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = CoroutineScope(Dispatchers.Default)): <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</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 class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>.<a href="start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a>(timeoutSeconds: <a href="../dev.inmo.tgbotapi.types/index.html#-1838927582%2FClasslikes%2F-1982836883">Seconds</a> = 30, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> = CoroutineScope(Dispatchers.Default), 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>>? = null, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>? = null, updatesReceiver: <a href="../dev.inmo.tgbotapi.updateshandlers/index.html#-1676068861%2FClasslikes%2F-1982836883">UpdateReceiver</a><<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>>): <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</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>
|
|
</div>
|
|
<a data-name="718667552%2FFunctions%2F2063174889" anchor-label="startListenWebhooks" id="718667552%2FFunctions%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="start-listen-webhooks.html"><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="718667552%2FFunctions%2F2063174889"></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="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<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">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>
|
|
<div class="brief "><p class="paragraph">Setting up ktor server</p></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="263531264%2FFunctions%2F-1982836883" anchor-label="updateHandlerWithMediaGroupsAdaptation" id="263531264%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="update-handler-with-media-groups-adaptation.html"><span>update</span><wbr></wbr><span>Handler</span><wbr></wbr><span>With</span><wbr></wbr><span>Media</span><wbr></wbr><span>Groups</span><wbr></wbr><span><span>Adaptation</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="263531264%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><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/commonMain"><div class="symbol monospace">fun <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>.<a href="update-handler-with-media-groups-adaptation.html">updateHandlerWithMediaGroupsAdaptation</a>(output: <a href="../dev.inmo.tgbotapi.updateshandlers/index.html#-1676068861%2FClasslikes%2F-1982836883">UpdateReceiver</a><<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>>): suspend (<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</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="symbol monospace">fun <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>.<a href="update-handler-with-media-groups-adaptation.html">updateHandlerWithMediaGroupsAdaptation</a>(output: <a href="../dev.inmo.tgbotapi.updateshandlers/index.html#-1676068861%2FClasslikes%2F-1982836883">UpdateReceiver</a><<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>>, debounceTimeMillis: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 1000L): <a href="../dev.inmo.tgbotapi.updateshandlers/index.html#-1676068861%2FClasslikes%2F-1982836883">UpdateReceiver</a><<a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</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="brief "><p class="paragraph">Create <a href="../dev.inmo.tgbotapi.updateshandlers/index.html#-1676068861%2FClasslikes%2F-1982836883">UpdateReceiver</a> object which will correctly accumulate updates and send into output updates which INCLUDE <a href="../dev.inmo.tgbotapi.types.update.MediaGroupUpdates/-media-group-update/index.html">dev.inmo.tgbotapi.types.update.MediaGroupUpdates.MediaGroupUpdate</a>s.</p></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>
|
|
|