krontab/kdocs/dev.inmo.krontab/enqueue-kron-scheduler-work.html
2021-09-23 07:24:15 +00:00

58 lines
11 KiB
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 type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.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" async="async"></script> </head>
<body>
<div id="container">
<div id="leftColumn"><a href="../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" 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="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">kdocs</a>/<a href="index.html">dev.inmo.krontab</a>/<a href="enqueue-kron-scheduler-work.html">enqueueKronSchedulerWork</a></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>
<div id="searchBar"></div>
</div>
</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="divergent-group" data-filterable-current=":dokkaHtml/androidMain" data-filterable-set=":dokkaHtml/androidMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/androidMain"><div class="symbol monospace">suspend fun &lt;<a href="enqueue-kron-scheduler-work.html">T</a> : <a href="-kron-scheduler-work/index.html">KronSchedulerWork</a>&gt; <a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a>.<a href="enqueue-kron-scheduler-work.html">enqueueKronSchedulerWork</a>(workName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, delayMillis: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, workClass: <a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;<a href="enqueue-kron-scheduler-work.html">T</a>&gt;, existingWorkPolicy: <a href="https://developer.android.com/reference/kotlin/androidx/work/ExistingWorkPolicy.html">ExistingWorkPolicy</a> = ExistingWorkPolicy.REPLACE, setUpRequest: suspend <a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.Builder.html">OneTimeWorkRequest.Builder</a>.() -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> = {}): <a href="https://developer.android.com/reference/kotlin/androidx/work/Operation.html">Operation</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</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></div>
<div class="divergent-group" data-filterable-current=":dokkaHtml/androidMain" data-filterable-set=":dokkaHtml/androidMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/androidMain"><div class="symbol monospace">inline suspend fun &lt;<a href="enqueue-kron-scheduler-work.html">T</a> : <a href="-kron-scheduler-work/index.html">KronSchedulerWork</a>&gt; <a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a>.<a href="enqueue-kron-scheduler-work.html">enqueueKronSchedulerWork</a>(workName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, delayMillis: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, existingWorkPolicy: <a href="https://developer.android.com/reference/kotlin/androidx/work/ExistingWorkPolicy.html">ExistingWorkPolicy</a> = ExistingWorkPolicy.REPLACE, noinline setUpRequest: suspend <a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.Builder.html">OneTimeWorkRequest.Builder</a>.() -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> = {}): <a href="https://developer.android.com/reference/kotlin/androidx/work/Operation.html">Operation</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</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></div>
<div class="divergent-group" data-filterable-current=":dokkaHtml/androidMain" data-filterable-set=":dokkaHtml/androidMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/androidMain"><div class="symbol monospace">suspend fun &lt;<a href="enqueue-kron-scheduler-work.html">T</a> : <a href="-kron-scheduler-work/index.html">KronSchedulerWork</a>&gt; <a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a>.<a href="enqueue-kron-scheduler-work.html">enqueueKronSchedulerWork</a>(workName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, initialScheduler: <span data-unresolved-link="dev.inmo.krontab/KronScheduler///PointingToDeclaration/">KronScheduler</span>, workClass: <a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;<a href="enqueue-kron-scheduler-work.html">T</a>&gt;, existingWorkPolicy: <a href="https://developer.android.com/reference/kotlin/androidx/work/ExistingWorkPolicy.html">ExistingWorkPolicy</a> = ExistingWorkPolicy.REPLACE, setUpRequest: suspend <a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.Builder.html">OneTimeWorkRequest.Builder</a>.() -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> = {}): <a href="https://developer.android.com/reference/kotlin/androidx/work/Operation.html">Operation</a>?<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</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/#com.soywiz.klock.DateTime/PointingToDeclaration/">KronScheduler.next</span> of <a href="enqueue-kron-scheduler-work.html">initialScheduler</a> will return null, work WILL NOT be enqueued</p><h4 class="">Return</h4><p class="paragraph">null in case if <span data-unresolved-link="dev.inmo.krontab/KronScheduler/next/#com.soywiz.klock.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></div>
<div class="divergent-group" data-filterable-current=":dokkaHtml/androidMain" data-filterable-set=":dokkaHtml/androidMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/androidMain"><div class="symbol monospace">inline suspend fun &lt;<a href="enqueue-kron-scheduler-work.html">T</a> : <a href="-kron-scheduler-work/index.html">KronSchedulerWork</a>&gt; <a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a>.<a href="enqueue-kron-scheduler-work.html">enqueueKronSchedulerWork</a>(workName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, initialScheduler: <span data-unresolved-link="dev.inmo.krontab/KronScheduler///PointingToDeclaration/">KronScheduler</span>, existingWorkPolicy: <a href="https://developer.android.com/reference/kotlin/androidx/work/ExistingWorkPolicy.html">ExistingWorkPolicy</a> = ExistingWorkPolicy.REPLACE, noinline setUpRequest: suspend <a href="https://developer.android.com/reference/kotlin/androidx/work/OneTimeWorkRequest.Builder.html">OneTimeWorkRequest.Builder</a>.() -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> = {}): <a href="https://developer.android.com/reference/kotlin/androidx/work/Operation.html">Operation</a>?<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</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 class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>