InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-29 13:38:43 +00:00
Code Releases Activity
fdf5f81bbc
tgbotapi/tgbotapi.core/dev.inmo.tgbotapi.bot.multiserver/telegram-bot.html

77 lines
30 KiB
HTML
Raw Normal View History

deploy: 804b9919219872434c07c35f67ca0453f6c5b3eb
2023-03-04 15:25:22 +00:00
<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>telegramBot</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">
deploy: b575695f90c119ac56d786817aa2dc1e2d38ccca
2023-05-19 17:03:00 +00:00
<span>ktgbotapi</span> </a> </div>
deploy: 804b9919219872434c07c35f67ca0453f6c5b3eb
2023-03-04 15:25:22 +00:00
<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.core: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.core::dev.inmo.tgbotapi.bot.multiserver//telegramBot/#kotlin.collections.List[dev.inmo.tgbotapi.bot.RequestsExecutor]#kotlin.coroutines.SuspendFunction3[kotlin.collections.List[dev.inmo.tgbotapi.bot.RequestsExecutor],kotlin.Int,kotlin.Throwable?,dev.inmo.tgbotapi.bot.RequestsExecutor]#kotlin.Function0[kotlin.Unit]/PointingToDeclaration//789214110">
<div class="breadcrumbs"><a href="../index.html">tgbotapi.core</a><span class="delimiter">/</span><a href="index.html">dev.inmo.tgbotapi.bot.multiserver</a><span class="delimiter">/</span><span class="current">telegramBot</span></div>
<div class="cover ">
<h1 class="cover"><span>telegram</span><wbr><span><span>Bot</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.core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="telegram-bot.html"><span class="token function">telegramBot</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">bots<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">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>botSelector<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token keyword"></span>currentBotIndex<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span><span class="token keyword"></span>t<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token operator">?</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a><span class="token operator"> = </span>{ i, _ -&gt;
getOrElse(i + 1) { first() }
}<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>onClose<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </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>{
bots.forEach(TelegramBot::close)
}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a></div><p class="paragraph">Creates <a href="-simple-multi-server-requests-executor/index.html">SimpleMultiServerRequestsExecutor</a></p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>bots</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Bots which will be used to <a href="../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">SimpleMultiServerRequestsExecutor.execute</a>s</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>bot</span><wbr><span><span>Selector</span></span></u></div></span></div><div><div class="title"><p class="paragraph">It is strategy by which the bot is selected for the execution. This lambda will receive <strong>-1</strong> when request execution just started and this call is first in context of one <a href="-simple-multi-server-requests-executor/execute.html">SimpleMultiServerRequestsExecutor.execute</a>. By default, will select next <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a> when called (or first when current index is last or -1)</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span><span>Close</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This method will be called inside of <a href="-simple-multi-server-requests-executor/close.html">SimpleMultiServerRequestsExecutor.close</a> method. By default, will close all <a href="telegram-bot.html">bots</a></p></div></div></div></div></div><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"telegramBotByApiUrlsKeepers"</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="telegram-bot.html"><span class="token function">telegramBot</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">keepers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.utils/-telegram-a-p-i-urls-keeper/index.html">TelegramAPIUrlsKeeper</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">crossinline </span>builder<span class="token operator">: </span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.bot.ktor/-ktor-requests-executor-builder/index.html">KtorRequestsExecutorBuilder</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.utils/-telegram-a-p-i-urls-keeper/index.html">TelegramAPIUrlsKeeper</a><span class="token punctuation">)</span><span class="token operator"> -
getOrElse(i + 1) { first() }
}<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>onClose<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </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>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>keepers</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used to create result <a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.multiserver/-simple-multi-server-requests-executor/bots.html">SimpleMultiServerRequestsExecutor.bots</a></p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>builder</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be called with each item from <a href="telegram-bot.html">keepers</a> in process of bots creation</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>bot</span><wbr><span><span>Selector</span></span></u></div></span></div><div><div class="title"><p class="paragraph">It is strategy by which the bot is selected for the execution. This lambda will receive <strong>-1</strong> when request execution just started and this call is first in context of one <a href="-simple-multi-server-requests-executor/execute.html">SimpleMultiServerRequestsExecutor.execute</a>. By default, will select next <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a> when called (or first when current index is last or -1)</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span><span>Close</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This method will be called inside of <a href="-simple-multi-server-requests-executor/close.html">SimpleMultiServerRequestsExecutor.close</a> method. By default, will close all <a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.multiserver/-simple-multi-server-requests-executor/bots.html">SimpleMultiServerRequestsExecutor.bots</a></p></div></div></div></div></div><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="to
getOrElse(i + 1) { first() }
}<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>onClose<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </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>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>tokens</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used to create result <a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.multiserver/-simple-multi-server-requests-executor/bots.html">SimpleMultiServerRequestsExecutor.bots</a></p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>builder</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be called with each item from <a href="telegram-bot.html">tokens</a> in process of bots creation</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>bot</span><wbr><span><span>Selector</span></span></u></div></span></div><div><div class="title"><p class="paragraph">It is strategy by which the bot is selected for the execution. This lambda will receive <strong>-1</strong> when request execution just started and this call is first in context of one <a href="-simple-multi-server-requests-executor/execute.html">SimpleMultiServerRequestsExecutor.execute</a>. By default, will select next <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a> when called (or first when current index is last or -1)</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span><span>Close</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This method will be called inside of <a href="-simple-multi-server-requests-executor/close.html">SimpleMultiServerRequestsExecutor.close</a> method. By default, will close all <a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.multiserver/-simple-multi-server-requests-executor/bots.html">SimpleMultiServerRequestsExecutor.bots</a></p></div></div></div></div></div><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="toke
getOrElse(i + 1) { first() }
}<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>onClose<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </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>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>tokens</span></span></u></div></span></div><div><div class="title"><p class="paragraph"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a>s with first parameter as a token and second parameter api url. Will be used to create result <a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.multiserver/-simple-multi-server-requests-executor/bots.html">SimpleMultiServerRequestsExecutor.bots</a></p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>builder</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be called with each item from <a href="telegram-bot.html">tokens</a> in process of bots creation</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>bot</span><wbr><span><span>Selector</span></span></u></div></span></div><div><div class="title"><p class="paragraph">It is strategy by which the bot is selected for the execution. This lambda will receive <strong>-1</strong> when request execution just started and this call is first in context of one <a href="-simple-multi-server-requests-executor/execute.html">SimpleMultiServerRequestsExecutor.execute</a>. By default, will select next <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F789214110">TelegramBot</a> when called (or first when current index is last or -1)</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span><span>Close</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This method will be called inside of <a href="-simple-multi-server-requests-executor/close.html">SimpleMultiServerRequestsExecutor.close</a> method. By default, will close all <a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.multiserver/-simple-multi-server-requests-executor/bots.html">SimpleMultiServerRequestsExecutor.bots</a></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>
Copy Permalink