2022-05-11 18:10:43 +00:00
|
|
|
<!DOCTYPE html>
|
2021-03-21 17:26:45 +00:00
|
|
|
<html>
|
2022-05-11 18:10:43 +00:00
|
|
|
<head>
|
2021-03-21 17:26:45 +00:00
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
|
|
|
<title>CommonLimiter</title>
|
2022-05-11 18:10:43 +00:00
|
|
|
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
|
|
|
|
<script>var pathToRoot = "../../../";</script>
|
|
|
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
2022-10-22 12:06:20 +00:00
|
|
|
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>
|
2022-05-11 18:10:43 +00:00
|
|
|
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="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="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" defer="defer"></script>
|
|
|
|
|
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
2022-10-22 12:06:20 +00:00
|
|
|
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
2022-05-11 18:10:43 +00:00
|
|
|
</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>docs</span>
|
|
|
|
|
</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
2023-02-06 08:25:47 +00:00
|
|
|
5.1.0 </div>
|
2022-05-11 18:10:43 +00:00
|
|
|
<div class="pull-right d-flex">
|
2022-08-05 16:09:22 +00:00
|
|
|
<div class="filter-section" id="filter-section">
|
|
|
|
|
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":docs:dokkaHtml/commonMain">common</button>
|
|
|
|
|
</div>
|
2022-05-11 18:10:43 +00:00
|
|
|
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
|
2022-01-01 21:40:22 +00:00
|
|
|
<div id="searchBar"></div>
|
|
|
|
|
</div>
|
2022-05-11 18:10:43 +00:00
|
|
|
</div>
|
|
|
|
|
<div id="container">
|
|
|
|
|
<div id="leftColumn">
|
2021-03-21 17:26:45 +00:00
|
|
|
<div id="sideMenu"></div>
|
2022-05-11 18:10:43 +00:00
|
|
|
</div>
|
|
|
|
|
<div id="main">
|
|
|
|
|
<div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.bot.settings.limiters/CommonLimiter///PointingToDeclaration//-1982836883">
|
2022-10-22 12:06:20 +00:00
|
|
|
<div class="breadcrumbs"><a href="../../../index.html">docs</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.tgbotapi.bot.settings.limiters</a><span class="delimiter">/</span><span class="current">CommonLimiter</span></div>
|
2022-05-11 18:10:43 +00:00
|
|
|
<div class="cover ">
|
|
|
|
|
<h1 class="cover"><span>Common</span><wbr></wbr><span><span>Limiter</span></span></h1>
|
2022-10-22 12:06:20 +00:00
|
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">class </span><a href="index.html">CommonLimiter</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">lockCount<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">10</span><span class="token punctuation">, </span></span><span class="parameter ">regenTime<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.types/index.html#1266067951%2FClasslikes%2F-1982836883">MilliSeconds</a><span class="token operator"> = </span>15 * 1000<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></span><span class="token punctuation">)</span> : <a href="../-request-limiter/index.html">RequestLimiter</a></div></div></div>
|
2022-05-11 18:10:43 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="tabbedcontent">
|
|
|
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
|
|
|
|
|
<div class="tabs-section-body">
|
|
|
|
|
<h2 class="tabbedcontent">Constructors</h2>
|
|
|
|
|
<div class="table" data-togglable="Constructors"><a data-name="1748674063%2FConstructors%2F-1982836883" anchor-label="CommonLimiter" id="1748674063%2FConstructors%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 TabbedContent">
|
|
|
|
|
<div class=""><span class="inline-flex">
|
|
|
|
|
<div><a href="-common-limiter.html"><span>Common</span><wbr></wbr><span><span>Limiter</span></span></a></div>
|
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1748674063%2FConstructors%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="title">
|
2022-10-22 12:06:20 +00:00
|
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-common-limiter.html"><span class="token function">CommonLimiter</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">lockCount<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">10</span><span class="token punctuation">, </span></span><span class="parameter ">regenTime<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.types/index.html#1266067951%2FClasslikes%2F-1982836883">MilliSeconds</a><span class="token operator"> = </span>15 * 1000<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></span><span class="token punctuation">)</span></div></div></div>
|
2022-05-11 18:10:43 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-03-21 17:26:45 +00:00
|
|
|
</div>
|
2022-05-11 18:10:43 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h2 class="">Functions</h2>
|
2022-12-28 03:23:33 +00:00
|
|
|
<div class="table" data-togglable="Functions"><a data-name="416962967%2FFunctions%2F-1982836883" anchor-label="limit" id="416962967%2FFunctions%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
|
2022-05-11 18:10:43 +00:00
|
|
|
<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">
|
|
|
|
|
<div><a href="limit.html"><span><span>limit</span></span></a></div>
|
2022-12-28 03:23:33 +00:00
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="416962967%2FFunctions%2F-1982836883"></span>
|
2022-05-11 18:10:43 +00:00
|
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
|
|
|
</span></span></div>
|
|
|
|
|
<div>
|
|
|
|
|
<div class="title">
|
2022-12-28 03:23:33 +00:00
|
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="limit.html">T</a><span class="token operator">> </span><a href="limit.html"><span class="token function">limit</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="limit.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="limit.html">T</a></div><div class="brief "><p class="paragraph">Use limit for working of block (like delay between or after, for example)</p></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../-request-limiter/limit.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">> </span><a href="../-request-limiter/limit.html"><span class="token function">limit</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator"><</span><span class="token keyword"></span><a href="../-request-limiter/limit.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="../-request-limiter/limit.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-request-limiter/limit.html">T</a></div></div></div>
|
2021-03-21 17:26:45 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2022-05-11 18:10:43 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
2022-08-05 16:09:22 +00:00
|
|
|
<div class="footer">
|
2023-01-18 17:55:09 +00:00
|
|
|
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
|
2022-05-11 18:10:43 +00:00
|
|
|
class="pull-right"><span>Generated by </span><a
|
|
|
|
|
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
|
2022-08-05 16:09:22 +00:00
|
|
|
</div>
|
2022-05-11 18:10:43 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
2021-03-21 17:26:45 +00:00
|
|
|
</html>
|
