OneTimeWorkRequest.Builder

Added in 1.0.0

Kotlin |Java

class OneTimeWorkRequest.Builder : WorkRequest.Builder

kotlin.Any
↳	androidx.work.WorkRequest.Builder
	↳	androidx.work.OneTimeWorkRequest.Builder

Builder for OneTimeWorkRequests.

Summary

Public constructors
`Builder(workerClass: Class<ListenableWorker>)`
`Builder(workerClass: KClass<ListenableWorker>)` Creates a builder for `OneTimeWorkRequest`s.

Public functions
`OneTimeWorkRequest.Builder`	`setInputMerger(inputMerger: Class<InputMerger>)` Specifies the `InputMerger` class name for this `OneTimeWorkRequest`.

Extension functions
`inline OneTimeWorkRequest.Builder`	`OneTimeWorkRequest.Builder.setInputMerger( inputMerger: KClass<InputMerger> )` Sets an `InputMerger` on the `OneTimeWorkRequest.Builder`.

Inherited functions

From androidx.work.WorkRequest.Builder

`OneTimeWorkRequest.Builder`	`addTag(tag: String)` Adds a tag for the work.
`OneTimeWorkRequest`	`build()` Builds a `WorkRequest` based on this `Builder`.
`OneTimeWorkRequest.Builder`	`@RequiresApi(value = 26) keepResultsForAtLeast(duration: Duration)` Specifies that the results of this work should be kept for at least the specified amount of time.
`OneTimeWorkRequest.Builder`	`keepResultsForAtLeast(duration: Long, timeUnit: TimeUnit)` Specifies that the results of this work should be kept for at least the specified amount of time.
`OneTimeWorkRequest.Builder`	`@RequiresApi(value = 26) setBackoffCriteria(backoffPolicy: BackoffPolicy, duration: Duration)` Sets the backoff policy and backoff delay for the work.
`OneTimeWorkRequest.Builder`	`setBackoffCriteria( backoffPolicy: BackoffPolicy, backoffDelay: Long, timeUnit: TimeUnit )` Sets the backoff policy and backoff delay for the work.
`OneTimeWorkRequest.Builder`	`@ExperimentalWorkRequestBuilderApi setBackoffForSystemInterruptions()` Specifies that the backoff policy (as specified via `setBackoffCriteria`) will be applied when work is interrupted by the system without the app requesting it.
`OneTimeWorkRequest.Builder`	`setConstraints(constraints: Constraints)` Adds constraints to the `WorkRequest`.
`open OneTimeWorkRequest.Builder`	`setExpedited(policy: OutOfQuotaPolicy)` Marks the `WorkRequest` as important to the user.
`OneTimeWorkRequest.Builder`	`setId(id: UUID)` Sets a unique identifier for this unit of work.
`open OneTimeWorkRequest.Builder`	`@RequiresApi(value = 26) setInitialDelay(duration: Duration)` Sets an initial delay for the `WorkRequest`.
`open OneTimeWorkRequest.Builder`	`setInitialDelay(duration: Long, timeUnit: TimeUnit)` Sets an initial delay for the `WorkRequest`.
`OneTimeWorkRequest.Builder`	`setInputData(inputData: Data)` Adds input `Data` to the work.
`OneTimeWorkRequest.Builder`	`setTraceTag(traceTag: String)` Specifies the name of the trace span to be used by `WorkManager` when executing the specified `WorkRequest`.

Public constructors

Builder

Added in 1.0.0

Builder(workerClass: Class<ListenableWorker>)

Parameters
`workerClass: Class<ListenableWorker>`	The `ListenableWorker` class to run for this work

Builder

Added in 2.10.0

Builder(workerClass: KClass<ListenableWorker>)

Creates a builder for OneTimeWorkRequests.

Parameters
`workerClass: KClass<ListenableWorker>`	The `ListenableWorker` class to run for this work

Public functions

setInputMerger

Added in 1.0.0

fun setInputMerger(inputMerger: Class<InputMerger>): OneTimeWorkRequest.Builder

Specifies the InputMerger class name for this OneTimeWorkRequest.

Before workers run, they receive input Data from their parent workers, as well as anything specified directly to them via WorkRequest.Builder.setInputData. An InputMerger takes all of these objects and converts them to a single merged Data to be used as the worker input. The default InputMerger is OverwritingInputMerger. This library also offers ArrayCreatingInputMerger; you can also specify your own.

Parameters
`inputMerger: Class<InputMerger>`	The class name of the `InputMerger` for this `OneTimeWorkRequest`

Returns
`OneTimeWorkRequest.Builder`	The current `Builder`

Extension functions

setInputMerger

Artifact: androidx.work:work-runtime

View Source

inline fun OneTimeWorkRequest.Builder.setInputMerger(
    inputMerger: KClass<InputMerger>
): OneTimeWorkRequest.Builder

Sets an InputMerger on the OneTimeWorkRequest.Builder.