Summary: Ctors | Inherited Methods

PeriodicWorkRequest.Builder

Kotlin |Java

public static final class PeriodicWorkRequest.Builder
extends Builder<PeriodicWorkRequest.Builder, PeriodicWorkRequest>

java.lang.Object
↳	androidx.work.WorkRequest.Builder<androidx.work.PeriodicWorkRequest.Builder, androidx.work.PeriodicWorkRequest>
	↳	androidx.work.PeriodicWorkRequest.Builder

Builder for PeriodicWorkRequests.

Summary

Public constructors
`Builder(Class<? extends ListenableWorker> workerClass, long repeatInterval, TimeUnit repeatIntervalTimeUnit)` Creates a `PeriodicWorkRequest` to run periodically once every interval period.
`Builder(Class<? extends ListenableWorker> workerClass, Duration repeatInterval)` Creates a `PeriodicWorkRequest` to run periodically once every interval period.
`Builder(Class<? extends ListenableWorker> workerClass, long repeatInterval, TimeUnit repeatIntervalTimeUnit, long flexInterval, TimeUnit flexIntervalTimeUnit)` Creates a `PeriodicWorkRequest` to run periodically once within the flex period of every interval period.
`Builder(Class<? extends ListenableWorker> workerClass, Duration repeatInterval, Duration flexInterval)` Creates a `PeriodicWorkRequest` to run periodically once within the flex period of every interval period.

Inherited methods

From class


        
          androidx.work.WorkRequest.Builder

`final B`	`addTag(String tag)` Adds a tag for the work.
`final W`	`build()` Builds a `WorkRequest` based on this `WorkRequest.Builder`.
`final B`	`keepResultsForAtLeast(long duration, TimeUnit timeUnit)` Specifies that the results of this work should be kept for at least the specified amount of time.
`final B`	`keepResultsForAtLeast(Duration duration)` Specifies that the results of this work should be kept for at least the specified amount of time.
`final B`	`setBackoffCriteria(BackoffPolicy backoffPolicy, long backoffDelay, TimeUnit timeUnit)` Sets the backoff policy and backoff delay for the work.
`final B`	`setBackoffCriteria(BackoffPolicy backoffPolicy, Duration duration)` Sets the backoff policy and backoff delay for the work.
`final B`	`setConstraints(Constraints constraints)` Adds constraints to the `WorkRequest`.
`B`	`setExpedited(OutOfQuotaPolicy policy)` Marks the `WorkRequest` as important to the user.
`B`	`setInitialDelay(Duration duration)` Sets an initial delay for the `WorkRequest`.
`B`	`setInitialDelay(long duration, TimeUnit timeUnit)` Sets an initial delay for the `WorkRequest`.
`final B`	`setInputData(Data inputData)` Adds input `Data` to the work.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

Builder

public Builder (Class<? extends ListenableWorker> workerClass, 
                long repeatInterval, 
                TimeUnit repeatIntervalTimeUnit)

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`: The `ListenableWorker` class to run for this work
`repeatInterval`	`long`: The repeat interval in `repeatIntervalTimeUnit` units
`repeatIntervalTimeUnit`	`TimeUnit`: The `TimeUnit` for `repeatInterval`

Builder

public Builder (Class<? extends ListenableWorker> workerClass, 
                Duration repeatInterval)

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

Builder

public Builder (Class<? extends ListenableWorker> workerClass, 
                long repeatInterval, 
                TimeUnit repeatIntervalTimeUnit, 
                long flexInterval, 
                TimeUnit flexIntervalTimeUnit)

Creates a PeriodicWorkRequest to run periodically once within the flex period of every interval period. See diagram below. 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`: 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`

Builder

public Builder (Class<? extends ListenableWorker> workerClass, 
                Duration repeatInterval, 
                Duration flexInterval)

 [     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`: 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`