206 lines
19 KiB
HTML
206 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>Companion</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="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>
|
|
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="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>kdocs</span>
|
|
</a>
|
|
</div>
|
|
<div>
|
|
2.1.2 </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=":dokkaHtml/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="classlike" id="content" pageIds="kdocs::dev.inmo.krontab/KronScheduler.Companion///PointingToDeclaration//788909594">
|
|
<div class="breadcrumbs"><a href="../../../../index.html">kdocs</a><span class="delimiter">/</span><a href="../../index.html">dev.inmo.krontab</a><span class="delimiter">/</span><a href="../index.html">KronScheduler</a><span class="delimiter">/</span><span class="current">Companion</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>Companion</span></span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/commonMain/kotlin/dev/inmo/krontab/KronScheduler.kt#L22">source</a>)</span></span></div></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members & Extensions</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="EXTENSION_PROPERTY">
|
|
<h2 class="">Properties</h2>
|
|
<div class="table"><a data-name="-997567722%2FProperties%2F788909594" anchor-label="annually" id="-997567722%2FProperties%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../annually.html"><span><span>annually</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-997567722%2FProperties%2F788909594"></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=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../annually.html">annually</a><span class="token operator">: </span><a href="../index.html">KronScheduler</a></div><div class="brief "><p class="paragraph">Shortcut for <a href="../../-every-year-scheduler.html">EveryYearScheduler</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-2029429781%2FProperties%2F788909594" anchor-label="daily" id="-2029429781%2FProperties%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../daily.html"><span><span>daily</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2029429781%2FProperties%2F788909594"></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=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../daily.html">daily</a><span class="token operator">: </span><a href="../index.html">KronScheduler</a></div><div class="brief "><p class="paragraph">Shortcut for <a href="../../-every-day-of-month-scheduler.html">EveryDayOfMonthScheduler</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1997197980%2FProperties%2F788909594" anchor-label="everyMillisecond" id="1997197980%2FProperties%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../every-millisecond.html"><span>every</span><wbr></wbr><span><span>Millisecond</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1997197980%2FProperties%2F788909594"></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=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../every-millisecond.html">everyMillisecond</a><span class="token operator">: </span><a href="../index.html">KronScheduler</a></div><div class="brief "><p class="paragraph">Shortcut for <a href="../../-every-millisecond-scheduler.html">EveryMillisecondScheduler</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="253640437%2FProperties%2F788909594" anchor-label="everyMinute" id="253640437%2FProperties%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../every-minute.html"><span>every</span><wbr></wbr><span><span>Minute</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="253640437%2FProperties%2F788909594"></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=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../every-minute.html">everyMinute</a><span class="token operator">: </span><a href="../index.html">KronScheduler</a></div><div class="brief "><p class="paragraph">Shortcut for <a href="../../-every-minute-scheduler.html">EveryMinuteScheduler</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-455775083%2FProperties%2F788909594" anchor-label="everySecond" id="-455775083%2FProperties%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../every-second.html"><span>every</span><wbr></wbr><span><span>Second</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-455775083%2FProperties%2F788909594"></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=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../every-second.html">everySecond</a><span class="token operator">: </span><a href="../index.html">KronScheduler</a></div><div class="brief "><p class="paragraph">Shortcut for <a href="../../-every-second-scheduler.html">EverySecondScheduler</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-2009855823%2FProperties%2F788909594" anchor-label="hourly" id="-2009855823%2FProperties%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../hourly.html"><span><span>hourly</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2009855823%2FProperties%2F788909594"></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=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../hourly.html">hourly</a><span class="token operator">: </span><a href="../index.html">KronScheduler</a></div><div class="brief "><p class="paragraph">Shortcut for <a href="../../-every-hour-scheduler.html">EveryHourScheduler</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2000833591%2FProperties%2F788909594" anchor-label="monthly" id="2000833591%2FProperties%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../monthly.html"><span><span>monthly</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2000833591%2FProperties%2F788909594"></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=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../monthly.html">monthly</a><span class="token operator">: </span><a href="../index.html">KronScheduler</a></div><div class="brief "><p class="paragraph">Shortcut for <a href="../../-every-month-scheduler.html">EveryMonthScheduler</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="EXTENSION_FUNCTION">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table"><a data-name="-1577939611%2FFunctions%2F788909594" anchor-label="invoke" id="-1577939611%2FFunctions%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../../dev.inmo.krontab.builder/invoke.html"><span><span>invoke</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1577939611%2FFunctions%2F788909594"></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=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">inline operator </span><span class="token keyword">fun </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../../dev.inmo.krontab.builder/invoke.html"><span class="token function">invoke</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">settingsBlock<span class="token operator">: </span><span class="token keyword"></span><a href="../../../dev.inmo.krontab.builder/-scheduler-builder/index.html">SchedulerBuilder</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><a href="../index.html">KronScheduler</a></div><div class="symbol monospace"><span class="token keyword">inline operator </span><span class="token keyword">fun </span><a href="index.html">KronScheduler.Companion</a><span class="token punctuation">.</span><a href="../../../dev.inmo.krontab.builder/invoke.html"><span class="token function">invoke</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">offset<span class="token operator">: </span><a href="../../../dev.inmo.krontab.utils/index.html#1215844957%2FClasslikes%2F788909594">Minutes</a><span class="token punctuation">, </span></span><span class="parameter ">settingsBlock<span class="token operator">: </span><span class="token keyword"></span><a href="../../../dev.inmo.krontab.builder/-scheduler-builder/index.html">SchedulerBuilder</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><a href="../../-kron-scheduler-tz/index.html">KronSchedulerTz</a></div><div class="brief "><p class="paragraph">Creates new <a href="../index.html">KronScheduler</a> with <a href="../../../dev.inmo.krontab.builder/invoke.html">settingsBlock</a></p></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>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|