2023-03-04 15:25:22 +00:00
<!doctype html>
2023-11-05 06:58:16 +00:00
< html class = "no-js" >
2023-03-04 15:25:22 +00:00
< head >
< meta name = "viewport" content = "width=device-width, initial-scale=1" charset = "UTF-8" >
< title > dev.inmo.tgbotapi.bot.settings.limiters< / title >
2023-11-05 06:58:16 +00:00
< link href = "../../images/logo-icon.svg" rel = "icon" type = "image/svg" > < script > var pathToRoot = "../../" ; < / script >
< script > document . documentElement . classList . replace ( "no-js" , "js" ) ; < / script >
< script > c o n s t s t o r a g e = l o c a l S t o r a g e . g e t I t e m ( " d o k k a - d a r k - m o d e " )
2023-03-04 15:25:22 +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 >
2023-11-05 06:58:16 +00:00
< script type = "text/javascript" src = "https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async > < / script >
2023-03-04 15:25:22 +00:00
< script type = "text/javascript" src = "../../scripts/sourceset_dependencies.js" async > < / script >
< link href = "../../styles/style.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" >
2023-11-05 06:58:16 +00:00
< link href = "../../styles/font-jb-sans-auto.css" rel = "Stylesheet" >
2023-03-04 15:25:22 +00:00
< 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 >
2023-11-05 06:58:16 +00:00
< div class = "root" >
< nav class = "navigation" id = "navigation-wrapper" >
< div class = "navigation--inner" >
< div class = "navigation-title" >
< button class = "menu-toggle" id = "menu-toggle" type = "button" > toggle menu< / button >
< div class = "library-name" >
< a class = "library-name--link" href = "../../index.html" >
ktgbotapi
< / a > < / div >
< div class = "library-version" >
< / div >
< / div >
2023-03-04 15:25:22 +00:00
< 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 >
< / div >
2023-11-05 06:58:16 +00:00
< div class = "navigation-controls" >
< button class = "navigation-controls--btn navigation-controls--theme" id = "theme-toggle-button" type = "button" > switch theme< / button >
< div class = "navigation-controls--btn navigation-controls--search" id = "searchBar" role = "button" > search in API< / div >
2023-03-04 15:25:22 +00:00
< / div >
2023-11-05 06:58:16 +00:00
< / nav >
< div id = "container" >
< div class = "sidebar" id = "leftColumn" >
< div class = "sidebar--inner" id = "sideMenu" > < / div >
< / div >
< div id = "main" >
2023-03-04 15:25:22 +00:00
< div class = "main-content" data-page-type = "package" id = "content" pageids = "tgbotapi.core::dev.inmo.tgbotapi.bot.settings.limiters////PointingToDeclaration//789214110" >
< div class = "breadcrumbs" > < a href = "../index.html" > tgbotapi.core< / a > < span class = "delimiter" > /< / span > < span class = "current" > dev.inmo.tgbotapi.bot.settings.limiters< / span > < / div >
< div class = "cover " >
< h1 class = "cover" > < span > < span > Package-level< / span > < / span > < span > < span > declarations< / span > < / span > < / h1 >
< / div >
< div class = "tabbedcontent" >
< div class = "tabs-section" tabs-section = "tabs-section" > < button class = "section-tab" data-active = "" data-togglable = "TYPE" > Types< / button > < / div >
< div class = "tabs-section-body" >
< div data-togglable = "TYPE" >
< h2 class = "" > Types< / h2 >
< div class = "table" > < a data-name = "-1600105714%2FClasslikes%2F789214110" anchor-label = "CommonLimiter" id = "-1600105714%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< 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 > < a href = "-common-limiter/index.html" > < span > Common< / span > < wbr > < span > < span > Limiter< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1600105714%2FClasslikes%2F789214110" > < / 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" >
2023-11-05 06:58:16 +00:00
< 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" > < 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 = "-common-limiter/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/-milli-seconds/index.html" > 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 >
2023-03-04 15:25:22 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "1224566515%2FClasslikes%2F789214110" anchor-label = "ExceptionsOnlyLimiter" id = "1224566515%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< 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 > < a href = "-exceptions-only-limiter/index.html" > < span > Exceptions< / span > < wbr > < span > Only< / span > < wbr > < span > < span > Limiter< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1224566515%2FClasslikes%2F789214110" > < / 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" >
2023-04-19 17:05:55 +00:00
< 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" > object < / span > < a href = "-exceptions-only-limiter/index.html" > ExceptionsOnlyLimiter< / a > : < a href = "-request-limiter/index.html" > RequestLimiter< / a > < / div > < div class = "brief " > < p class = "paragraph" > Simple limiter which will lock any request when < a href = "../dev.inmo.tgbotapi.bot.exceptions/-too-much-requests-exception/index.html" > TooMuchRequestsException< / a > is thrown and rerun request after lock time< / p > < / div > < / div > < / div >
2023-03-04 15:25:22 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1619686436%2FClasslikes%2F789214110" anchor-label = "NoLimitsLimiter" id = "-1619686436%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< 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 > < a href = "-no-limits-limiter/index.html" > < span > No< / span > < wbr > < span > Limits< / span > < wbr > < span > < span > Limiter< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1619686436%2FClasslikes%2F789214110" > < / 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" >
< 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" > object < / span > < a href = "-no-limits-limiter/index.html" > NoLimitsLimiter< / a > : < a href = "-request-limiter/index.html" > RequestLimiter< / a > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-178101561%2FClasslikes%2F789214110" anchor-label = "PowLimiter" id = "-178101561%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< 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 > < a href = "-pow-limiter/index.html" > < span > Pow< / span > < wbr > < span > < span > Limiter< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-178101561%2FClasslikes%2F789214110" > < / 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" >
2023-11-05 06:58:16 +00:00
< 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" > < 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" > data < / span > < span class = "token keyword" > class < / span > < a href = "-pow-limiter/index.html" > PowLimiter< / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > minAwaitTime< span class = "token operator" > : < / span > < a href = "../dev.inmo.tgbotapi.types/-milli-seconds/index.html" > MilliSeconds< / a > < span class = "token operator" > = < / span > < span class = "token constant" > 0< / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > maxAwaitTime< span class = "token operator" > : < / span > < a href = "../dev.inmo.tgbotapi.types/-milli-seconds/index.html" > MilliSeconds< / a > < span class = "token operator" > = < / span > < span class = "token constant" > 10000< / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > powValue< span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html" > Double< / a > < span class = "token operator" > = < / span > < span class = "token constant" > 4.0< / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > powK< span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html" > Double< / a > < span class = "token operator" > = < / span > < span class = "token constant" > 1.6< / 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 > < / span > < span class = "token punctuation" > )< / span > : < a href = "-request-limiter/index.html" > RequestLimiter< / a > < / div > < / div > < / div >
2023-03-04 15:25:22 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "-598723586%2FClasslikes%2F789214110" anchor-label = "RequestLimiter" id = "-598723586%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< 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 > < a href = "-request-limiter/index.html" > < span > Request< / span > < wbr > < span > < span > Limiter< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-598723586%2FClasslikes%2F789214110" > < / 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" >
< 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" > interface < / span > < a href = "-request-limiter/index.html" > RequestLimiter< / a > < / div > < / div > < / div >
< / div >
< / 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 >
2023-11-05 06:58:16 +00:00
< / div >
< / div >
2023-03-04 15:25:22 +00:00
< / div >
< / body >
< / html >
