mirror of
https://github.com/InsanusMokrassar/krontab.git
synced 2024-11-23 10:38:49 +00:00
75 lines
16 KiB
HTML
75 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>enqueueKronSchedulerWork</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.0 </div>
|
|
<div class="pull-right d-flex">
|
|
<div class="filter-section" id="filter-section">
|
|
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/androidMain">android</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="kdocs::dev.inmo.krontab//enqueueKronSchedulerWork/android.content.Context#kotlin.String#kotlin.Long#java.lang.Class[TypeParam(bounds=[dev.inmo.krontab.KronSchedulerWork])]#androidx.work.ExistingWorkPolicy#kotlin.coroutines.SuspendFunction1[androidx.work.OneTimeWorkRequest.Builder,kotlin.Unit]/PointingToDeclaration//1837590656">
|
|
<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><span class="current">enqueueKronSchedulerWork</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>enqueue</span><wbr></wbr><span>Kron</span><wbr></wbr><span>Scheduler</span><wbr></wbr><span><span>Work</span></span></h1>
|
|
</div>
|
|
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
|
|
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":dokkaHtml/androidMain" data-filterable-set=":dokkaHtml/androidMain" data-active="" data-toggle=":dokkaHtml/androidMain">android</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="enqueue-kron-scheduler-work.html">T</a><span class="token operator"> : </span><a href="-kron-scheduler-work/index.html">KronSchedulerWork</a><span class="token operator">> </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">.</span><a href="enqueue-kron-scheduler-work.html"><span class="token function">enqueueKronSchedulerWork</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">workName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">delayMillis<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">workClass<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a><span class="token operator"><</span><span class="token keyword"></span><a href="enqueue-kron-scheduler-work.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">existingWorkPolicy<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/work/ExistingWorkPolicy.html">ExistingWorkPolicy</a><span class="token operator"> = </span>ExistingWorkPolicy.REPLACE<span class="token punctuation">, </span></span><span class="parameter ">setUpRequest<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token keyword"></span><a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.Builder.html">OneTimeWorkRequest.Builder</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 class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/work/Operation.html">Operation</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/main/kotlin/dev/inmo/krontab/KronSchedulerWork.kt#L12">source</a>)</span></span></div><p class="paragraph">This method will enqueue <a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.html">OneTimeWorkRequest</a> with <a href="enqueue-kron-scheduler-work.html">workName</a> and <a href="enqueue-kron-scheduler-work.html">existingWorkPolicy</a>. Use <a href="enqueue-kron-scheduler-work.html">setUpRequest</a> callback in case you need some additional actions to do before request will be enqueued</p><hr><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="enqueue-kron-scheduler-work.html">T</a><span class="token operator"> : </span><a href="-kron-scheduler-work/index.html">KronSchedulerWork</a><span class="token operator">> </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">.</span><a href="enqueue-kron-scheduler-work.html"><span class="token function">enqueueKronSchedulerWork</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">workName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">delayMillis<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">existingWorkPolicy<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/work/ExistingWorkPolicy.html">ExistingWorkPolicy</a><span class="token operator"> = </span>ExistingWorkPolicy.REPLACE<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>setUpRequest<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token keyword"></span><a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.Builder.html">OneTimeWorkRequest.Builder</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 class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/work/Operation.html">Operation</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/main/kotlin/dev/inmo/krontab/KronSchedulerWork.kt#L29">source</a>)</span></span></div><p class="paragraph">This method is shortcut for <a href="enqueue-kron-scheduler-work.html">enqueueKronSchedulerWork</a> with reified <a href="enqueue-kron-scheduler-work.html">T</a> parameter</p><hr><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="enqueue-kron-scheduler-work.html">T</a><span class="token operator"> : </span><a href="-kron-scheduler-work/index.html">KronSchedulerWork</a><span class="token operator">> </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">.</span><a href="enqueue-kron-scheduler-work.html"><span class="token function">enqueueKronSchedulerWork</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">workName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">initialScheduler<span class="token operator">: </span><a href="-kron-scheduler/index.html">KronScheduler</a><span class="token punctuation">, </span></span><span class="parameter ">workClass<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a><span class="token operator"><</span><span class="token keyword"></span><a href="enqueue-kron-scheduler-work.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">existingWorkPolicy<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/work/ExistingWorkPolicy.html">ExistingWorkPolicy</a><span class="token operator"> = </span>ExistingWorkPolicy.REPLACE<span class="token punctuation">, </span></span><span class="parameter ">setUpRequest<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token keyword"></span><a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.Builder.html">OneTimeWorkRequest.Builder</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 class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/work/Operation.html">Operation</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/main/kotlin/dev/inmo/krontab/KronSchedulerWork.kt#L42">source</a>)</span></span></div><p class="paragraph">This method is shortcut for <a href="enqueue-kron-scheduler-work.html">enqueueKronSchedulerWork</a> with <a href="enqueue-kron-scheduler-work.html">initialScheduler</a>. It will try to calculate delay by itself. In case if <span data-unresolved-link="dev.inmo.krontab/KronScheduler/next/#korlibs.time.DateTime/PointingToDeclaration/">KronScheduler.next</span> of <a href="enqueue-kron-scheduler-work.html">initialScheduler</a> will return null, work WILL NOT be enqueued</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">null in case if <span data-unresolved-link="dev.inmo.krontab/KronScheduler/next/#korlibs.time.DateTime/PointingToDeclaration/">KronScheduler.next</span> of <a href="enqueue-kron-scheduler-work.html">initialScheduler</a> has returned null and work has not been enqueued</p></span><hr><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="enqueue-kron-scheduler-work.html">T</a><span class="token operator"> : </span><a href="-kron-scheduler-work/index.html">KronSchedulerWork</a><span class="token operator">> </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">.</span><a href="enqueue-kron-scheduler-work.html"><span class="token function">enqueueKronSchedulerWork</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">workName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">initialScheduler<span class="token operator">: </span><a href="-kron-scheduler/index.html">KronScheduler</a><span class="token punctuation">, </span></span><span class="parameter ">existingWorkPolicy<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/work/ExistingWorkPolicy.html">ExistingWorkPolicy</a><span class="token operator"> = </span>ExistingWorkPolicy.REPLACE<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>setUpRequest<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token keyword"></span><a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.Builder.html">OneTimeWorkRequest.Builder</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 class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/work/Operation.html">Operation</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/main/kotlin/dev/inmo/krontab/KronSchedulerWork.kt#L58">source</a>)</span></span></div><p class="paragraph">This method is shortcut for <a href="enqueue-kron-scheduler-work.html">enqueueKronSchedulerWork</a> with reified <a href="enqueue-kron-scheduler-work.html">T</a></p></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>
|