PeriodicWorkRequest

Kotlin |Java

class PeriodicWorkRequest : WorkRequest

kotlin.Any
↳	androidx.work.WorkRequest
	↳	androidx.work.PeriodicWorkRequest

A WorkRequest for repeating work. This work executes multiple times until it is cancelled, with the first execution happening immediately or as soon as the given Constraints are met. The next execution will happen during the period interval; note that execution may be delayed because WorkManager is subject to OS battery optimizations, such as doze mode.

You can control when the work executes in the period interval more exactly - see PeriodicWorkRequest.Builder#Builder for documentation on flexIntervals.

Periodic work has a minimum interval of 15 minutes and it cannot have an initial delay.

Periodic work is intended for use cases where you want a fairly consistent delay between consecutive runs, and you are willing to accept inexactness due to battery optimizations and doze mode. Please note that if your periodic work has constraints, it will not execute until the constraints are met, even if the delay between periods has been met.

If you need to schedule work that happens exactly at a certain time or only during a certain time window, you should consider using OneTimeWorkRequests.

The normal lifecycle of a PeriodicWorkRequest is ENQUEUED -> RUNNING -> ENQUEUED. By definition, periodic work cannot terminate in a succeeded or failed state, since it must recur. It can only terminate if explicitly cancelled. However, in the case of retries, periodic work will still back off according to PeriodicWorkRequest.Builder#setBackoffCriteria(BackoffPolicy, long, TimeUnit).

Periodic work cannot be part of a chain or graph of work.

Summary

Nested classes
	Builder Builder for PeriodicWorkRequests.

Constants
static Long	MIN_PERIODIC_FLEX_MILLIS The minimum flex duration for PeriodicWorkRequest (in milliseconds).
static Long	MIN_PERIODIC_INTERVAL_MILLIS The minimum interval duration for PeriodicWorkRequest (in milliseconds).

Inherited constants
From class WorkRequest Long DEFAULT_BACKOFF_DELAY_MILLIS The default initial backoff time (in milliseconds) for work that has to be retried. Long MAX_BACKOFF_MILLIS The maximum backoff time (in milliseconds) for work that has to be retried. Long MIN_BACKOFF_MILLIS The minimum backoff time for work (in milliseconds) that has to be retried.

Inherited functions
From class WorkRequest UUID getId() Gets the unique identifier associated with this unit of work.

Constants

MIN_PERIODIC_FLEX_MILLIS

static val MIN_PERIODIC_FLEX_MILLIS: Long

The minimum flex duration for PeriodicWorkRequest (in milliseconds).

Value: 5 * 60 * 1000L

MIN_PERIODIC_INTERVAL_MILLIS

static val MIN_PERIODIC_INTERVAL_MILLIS: Long

The minimum interval duration for PeriodicWorkRequest (in milliseconds).

Value: 15 * 60 * 1000L