PeriodicWorkRequest.Builder
public final class PeriodicWorkRequest.Builder extends WorkRequest.Builder
Builder for PeriodicWorkRequests.
Summary
Public constructors |
|---|
@RequiresApi(value = 26)Creates a |
@RequiresApi(value = 26)Creates a |
@RequiresApi(value = 26)Creates a |
Builder(Creates a |
@RequiresApi(value = 26)Creates a |
Builder(Creates a |
Builder(Creates a |
Builder(Creates a |
Public methods |
|
|---|---|
final @NonNull PeriodicWorkRequest.Builder |
Clears any override set by |
final @NonNull PeriodicWorkRequest.Builder |
setNextScheduleTimeOverride(long nextScheduleTimeOverrideMillis)Overrides the next time this work is scheduled to run. |
Inherited methods |
||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public constructors
Builder
@RequiresApi(value = 26)
public Builder(
@NonNull Class<@NonNull ListenableWorker> workerClass,
@NonNull Duration repeatInterval
)
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, Duration, Duration)).
| Parameters | |
|---|---|
@NonNull Class<@NonNull ListenableWorker> workerClass |
The |
@NonNull Duration repeatInterval |
The repeat interval |
Builder
@RequiresApi(value = 26)
public Builder(
@NonNull KClass<@NonNull ListenableWorker> workerClass,
@NonNull Duration repeatInterval
)
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, Duration, Duration)).
| Parameters | |
|---|---|
@NonNull KClass<@NonNull ListenableWorker> workerClass |
The |
@NonNull Duration repeatInterval |
The repeat interval |
Builder
@RequiresApi(value = 26)
public Builder(
@NonNull Class<ListenableWorker> workerClass,
@NonNull Duration repeatInterval,
@NonNull Duration flexInterval
)
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 | |
|---|---|
@NonNull Class<ListenableWorker> workerClass |
The |
@NonNull Duration repeatInterval |
The repeat interval |
@NonNull Duration flexInterval |
The duration in for which this work repeats from the end of the |
Builder
public Builder(
@NonNull Class<ListenableWorker> workerClass,
long repeatInterval,
@NonNull 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 | |
|---|---|
@NonNull Class<ListenableWorker> workerClass |
The |
long repeatInterval |
The repeat interval in |
@NonNull TimeUnit repeatIntervalTimeUnit |
The |
Builder
@RequiresApi(value = 26)
public Builder(
@NonNull KClass<@NonNull ListenableWorker> workerClass,
@NonNull Duration repeatInterval,
@NonNull Duration flexInterval
)
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 | |
|---|---|
@NonNull KClass<@NonNull ListenableWorker> workerClass |
The |
@NonNull Duration repeatInterval |
The repeat interval |
@NonNull Duration flexInterval |
The duration in for which this work repeats from the end of the |
Builder
public Builder(
@NonNull KClass<@NonNull ListenableWorker> workerClass,
long repeatInterval,
@NonNull 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 | |
|---|---|
@NonNull KClass<@NonNull ListenableWorker> workerClass |
The |
long repeatInterval |
The repeat interval in |
@NonNull TimeUnit repeatIntervalTimeUnit |
The |
Builder
public Builder(
@NonNull Class<ListenableWorker> workerClass,
long repeatInterval,
@NonNull TimeUnit repeatIntervalTimeUnit,
long flexInterval,
@NonNull 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 | |
|---|---|
@NonNull Class<ListenableWorker> workerClass |
The |
long repeatInterval |
The repeat interval in |
@NonNull TimeUnit repeatIntervalTimeUnit |
The |
long flexInterval |
The duration in |
@NonNull TimeUnit flexIntervalTimeUnit |
The |
Builder
public Builder(
@NonNull KClass<@NonNull ListenableWorker> workerClass,
long repeatInterval,
@NonNull TimeUnit repeatIntervalTimeUnit,
long flexInterval,
@NonNull 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 | |
|---|---|
@NonNull KClass<@NonNull ListenableWorker> workerClass |
The |
long repeatInterval |
The repeat interval in |
@NonNull TimeUnit repeatIntervalTimeUnit |
The |
long flexInterval |
The duration in |
@NonNull TimeUnit flexIntervalTimeUnit |
The |
Public methods
clearNextScheduleTimeOverride
public final @NonNull PeriodicWorkRequest.Builder clearNextScheduleTimeOverride()
Clears any override set by setNextScheduleTimeOverride.
When an override is cleared, the next schedule is based on the previous enqueue time or run time of the Work and the result of that previous run. Eg. if the previous run returned ListenableWorker.Result.Retry at some time=T, and the next run was set by override, then clearing that override will return the schedule to T+backoffInterval if using linear backoff.
Override may be cleared while a Worker is running. The worker will schedule the next run based on its result type and interval.
setNextScheduleTimeOverride
public final @NonNull PeriodicWorkRequest.Builder setNextScheduleTimeOverride(long nextScheduleTimeOverrideMillis)
Overrides the next time this work is scheduled to run.
Calling this method sets a specific time at which the work will be scheduled to run next, overriding the normal interval, flex, initial delay, and backoff.
This allows dynamic calculation of the next Periodic work schedule, which can be used to implement advanced features like adaptive refresh times, custom retry behavior, or making a newsfeed worker run before the user wakes up every morning without drift. ExistingPeriodicWorkPolicy.UPDATE should be used with these techniques to avoid cancelling a currently-running worker while scheduling the next one.
This method only sets the single next Work schedule. After that Work finishes, the override will be cleared and the Work will be scheduled normally according to the interval or backoff. The override can be cleared by setting clearNextScheduleTimeOverride on a work update request. Otherwise, the override time will persist after unrelated invocations of WorkManager.updateWork.
This method can be used from outside or inside a Worker.startWork method. If the Worker is currently running, then it will override the next time the Work starts, even if the current Worker returns ListenableWorker.Result.Retry. This behavior can be used to customize the backoff behavior of a Worker by catching Exceptions in startWork and using this method to schedule a retry.
MIN_PERIODIC_INTERVAL_MILLIS is enforced on this method to prevent infinite loops. If a previous run time occurred less than the minimum period before the override time, then the override schedule will be delayed to preserve the minimum spacing. This restriction does not apply to the very first run of periodic work, which may be instant.
Work will almost never run at this exact time in the real world. This method assigns the scheduled run time accurately, but cannot guarantee an actual run time. Actual Work run times are dependent on many factors like the underlying system scheduler, doze and power saving modes of the OS, and meeting any configured constraints. This is expected and is not considered a bug.
| Parameters | |
|---|---|
long nextScheduleTimeOverrideMillis |
The time, in |