Builder

Kotlin |Java

class Builder : WorkRequest.Builder<PeriodicWorkRequest.Builder!, PeriodicWorkRequest!>

kotlin.Any
↳	androidx.work.WorkRequest.Builder<androidx.work.PeriodicWorkRequest.Builder, androidx.work.PeriodicWorkRequest>
	↳	androidx.work.PeriodicWorkRequest.Builder

Builder for PeriodicWorkRequests.

Summary

Public constructors
`<init>(@NonNull workerClass: Class<out ListenableWorker!>, repeatInterval: Long, @NonNull repeatIntervalTimeUnit: TimeUnit)` Creates a `PeriodicWorkRequest` to run periodically once every interval period.
`<init>(@NonNull workerClass: Class<out ListenableWorker!>, @NonNull repeatInterval: Duration)` Creates a `PeriodicWorkRequest` to run periodically once every interval period.
`<init>(@NonNull workerClass: Class<out ListenableWorker!>, repeatInterval: Long, @NonNull repeatIntervalTimeUnit: TimeUnit, flexInterval: Long, @NonNull flexIntervalTimeUnit: TimeUnit)` Creates a `PeriodicWorkRequest` to run periodically once within the flex period of every interval period.
`<init>(@NonNull workerClass: Class<out ListenableWorker!>, @NonNull repeatInterval: Duration, @NonNull flexInterval: Duration)` Creates a `PeriodicWorkRequest` to run periodically once within the flex period of every interval period.

Inherited functions

From class Builder

`B`	`addTag(@NonNull tag: String)` Adds a tag for the work. You can query and cancel work by tags. Tags are particularly useful for modules or libraries to find and operate on their own work.
`W`	`build()` Builds a `WorkRequest` based on this `Builder`.
`B`	`keepResultsForAtLeast(duration: Long, @NonNull timeUnit: TimeUnit)` Specifies that the results of this work should be kept for at least the specified amount of time. After this time has elapsed, the results may be pruned at the discretion of WorkManager when there are no pending dependent jobs. When the results of a work are pruned, it becomes impossible to query for its `WorkInfo`. Specifying a long duration here may adversely affect performance in terms of app storage and database query time.
`B`	`keepResultsForAtLeast(@NonNull duration: Duration)` Specifies that the results of this work should be kept for at least the specified amount of time. After this time has elapsed, the results may be pruned at the discretion of WorkManager when this WorkRequest has reached a finished state (see `WorkInfo.State#isFinished()`) and there are no pending dependent jobs. When the results of a work are pruned, it becomes impossible to query for its `WorkInfo`. Specifying a long duration here may adversely affect performance in terms of app storage and database query time.
`B`	`setBackoffCriteria(@NonNull backoffPolicy: BackoffPolicy, backoffDelay: Long, @NonNull timeUnit: TimeUnit)` Sets the backoff policy and backoff delay for the work. The default values are `BackoffPolicy#EXPONENTIAL` and {@value WorkRequest#DEFAULT_BACKOFF_DELAY_MILLIS}, respectively. `backoffDelay` will be clamped between `WorkRequest#MIN_BACKOFF_MILLIS` and `WorkRequest#MAX_BACKOFF_MILLIS`.
`B`	`setBackoffCriteria(@NonNull backoffPolicy: BackoffPolicy, @NonNull duration: Duration)` Sets the backoff policy and backoff delay for the work. The default values are `BackoffPolicy#EXPONENTIAL` and {@value WorkRequest#DEFAULT_BACKOFF_DELAY_MILLIS}, respectively. `duration` will be clamped between `WorkRequest#MIN_BACKOFF_MILLIS` and `WorkRequest#MAX_BACKOFF_MILLIS`.
`B`	`setConstraints(@NonNull constraints: Constraints)` Adds constraints to the `WorkRequest`.
`B`	`setInitialDelay(duration: Long, @NonNull timeUnit: TimeUnit)` Sets an initial delay for the `WorkRequest`.
`B`	`setInitialDelay(@NonNull duration: Duration)` Sets an initial delay for the `WorkRequest`.
`B`	`setInputData(@NonNull inputData: Data)` Adds input `Data` to the work. If a worker has prerequisites in its chain, this Data will be merged with the outputs of the prerequisites using an `InputMerger`.

Public constructors

<init>

Builder(
    @NonNull workerClass: Class<out ListenableWorker!>, 
    repeatInterval: Long, 
    @NonNull repeatIntervalTimeUnit: TimeUnit)

Creates a PeriodicWorkRequest to run periodically once every interval period. The PeriodicWorkRequest is guaranteed to run exactly one time during this interval (subject to OS battery optimizations, such as doze mode). The repeat interval must be greater than or equal to PeriodicWorkRequest#MIN_PERIODIC_INTERVAL_MILLIS. It may run immediately, at the end of the period, or any time in between so long as the other conditions are satisfied at the time. The run time of the PeriodicWorkRequest can be restricted to a flex period within an interval (see Builder(Class, long, TimeUnit, long, TimeUnit)).

Parameters
`workerClass`	Class<out ListenableWorker!>: The `ListenableWorker` class to run for this work
`repeatInterval`	Long: The repeat interval in `repeatIntervalTimeUnit` units
`repeatIntervalTimeUnit`	TimeUnit: The `TimeUnit` for `repeatInterval`

<init>

Builder(
    @NonNull workerClass: Class<out ListenableWorker!>, 
    @NonNull repeatInterval: Duration)

Parameters
`workerClass`	Class<out ListenableWorker!>: The `ListenableWorker` class to run for this work
`repeatInterval`	Duration: The repeat interval

<init>

Builder(
    @NonNull workerClass: Class<out ListenableWorker!>, 
    repeatInterval: Long, 
    @NonNull repeatIntervalTimeUnit: TimeUnit, 
    flexInterval: Long, 
    @NonNull flexIntervalTimeUnit: TimeUnit)

Creates a PeriodicWorkRequest to run periodically once within the flex period of every interval period. See diagram below. Note that flex intervals are ignored for certain OS versions (in particular, API 23). The flex period begins at repeatInterval - flexInterval to the end of the interval. The repeat interval must be greater than or equal to PeriodicWorkRequest#MIN_PERIODIC_INTERVAL_MILLIS and the flex interval must be greater than or equal to PeriodicWorkRequest#MIN_PERIODIC_FLEX_MILLIS.

[     before flex     |     flex     ][     before flex     |     flex     ]...
          [   cannot run work   | can run work ][   cannot run work   | can run work ]...
          \____________________________________/\____________________________________/...
                         interval 1                            interval 2             ...(repeat)

Parameters
`workerClass`	Class<out ListenableWorker!>: The `ListenableWorker` class to run for this work
`repeatInterval`	Long: The repeat interval in `repeatIntervalTimeUnit` units
`repeatIntervalTimeUnit`	TimeUnit: The `TimeUnit` for `repeatInterval`
`flexInterval`	Long: The duration in `flexIntervalTimeUnit` units for which this work repeats from the end of the `repeatInterval`
`flexIntervalTimeUnit`	TimeUnit: The `TimeUnit` for `flexInterval`

<init>

Builder(
    @NonNull workerClass: Class<out ListenableWorker!>, 
    @NonNull repeatInterval: Duration, 
    @NonNull flexInterval: Duration)

[     before flex     |     flex     ][     before flex     |     flex     ]...
          [   cannot run work   | can run work ][   cannot run work   | can run work ]...
          \____________________________________/\____________________________________/...
                         interval 1                            interval 2             ...(repeat)

Parameters
`workerClass`	Class<out ListenableWorker!>: The `ListenableWorker` class to run for this work
`repeatInterval`	Duration: The repeat interval
`flexInterval`	Duration: The duration in for which this work repeats from the end of the `repeatInterval`