Builder

Kotlin |Java

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

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

Builder for OneTimeWorkRequests.

Summary

Public constructors
`<init>(@NonNull workerClass: Class<out ListenableWorker!>)` Creates a `OneTimeWorkRequest`.

Public methods
OneTimeWorkRequest.Builder	`setInputMerger(@NonNull inputMerger: Class<out InputMerger!>)` Specifies the `InputMerger` class name for this `OneTimeWorkRequest`.

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`	`setExpedited(@NonNull policy: OutOfQuotaPolicy)` Marks the `WorkRequest` as important to the user. In this case, WorkManager provides an additional signal to the OS that this work is important.
`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`.

Extension functions

From androidx.work

OneTimeWorkRequest.Builder

OneTimeWorkRequest.Builder.setInputMerger(@NonNull inputMerger: KClass<out InputMerger>)

Sets an InputMerger on the OneTimeWorkRequest.Builder.