WorkContinuation

Added in 1.0.0

Kotlin |Java

abstract class WorkContinuation

A class that allows you to chain together OneTimeWorkRequests. WorkContinuations allow the user to create arbitrary acyclic graphs of work dependencies. You can add dependent work to a WorkContinuation by invoking then or its variants. This returns a new WorkContinuation.

To construct more complex graphs, combine or its variants can be used to return a WorkContinuation with the input WorkContinuations as prerequisites. To create a graph like this:

    A       C
    |       |
    B       D
    |       |
    +-------+
        |
E

you would write the following:

 WorkContinuation left = workManager.beginWith(A).then(B);
 WorkContinuation right = workManager.beginWith(C).then(D);
 WorkContinuation final = WorkContinuation.combine(Arrays.asList(left, right)).then(E);
 final.enqueue();

Not that enqueuing a WorkContinuation enqueues all previously-unenqueued prerequisites. You must call enqueue to inform WorkManager to actually enqueue the work graph. As usual, enqueues are asynchronous - you can observe or block on the returned Operation if you need to be informed about its completion.

Because of the fluent nature of this class, its existence should be invisible in most cases.

Summary

Public constructors
`WorkContinuation()`

Public functions
`java-static WorkContinuation`	`combine(continuations: (Mutable)List<WorkContinuation!>)` Combines multiple `WorkContinuation`s as prerequisites for a new WorkContinuation to allow for complex chaining.
`abstract Operation`	`enqueue()` Enqueues the instance of `WorkContinuation` on the background thread.
`abstract ListenableFuture<(Mutable)List<WorkInfo!>!>`	`getWorkInfos()` Returns a `ListenableFuture` of a `List` of `WorkInfo`s that provides information about the status of each `OneTimeWorkRequest` in this `WorkContinuation`, as well as their prerequisites.
`abstract LiveData<(Mutable)List<WorkInfo!>!>`	`getWorkInfosLiveData()` Returns a `LiveData` list of `WorkInfo`s that provide information about the status of each `OneTimeWorkRequest` in this `WorkContinuation`, as well as their prerequisites.
`abstract WorkContinuation`	`then(work: (Mutable)List<OneTimeWorkRequest!>)` Adds new `OneTimeWorkRequest` items that depend on the successful completion of all previously added `OneTimeWorkRequest`s.
`WorkContinuation`	`then(work: OneTimeWorkRequest)` Adds new `OneTimeWorkRequest` items that depend on the successful completion of all previously added `OneTimeWorkRequest`s.

Public constructors

WorkContinuation

Added in 1.0.0

WorkContinuation()

Public functions

combine

Added in 1.0.0

java-static fun combine(continuations: (Mutable)List<WorkContinuation!>): WorkContinuation

Combines multiple WorkContinuations as prerequisites for a new WorkContinuation to allow for complex chaining. For example, to create a graph like this:

    A       C
    |       |
    B       D
    |       |
    +-------+
        |
E

you would write the following:

 WorkContinuation left = workManager.beginWith(A).then(B);
 WorkContinuation right = workManager.beginWith(C).then(D);
 WorkContinuation final = WorkContinuation.combine(Arrays.asList(left, right)).then(E);
 final.enqueue();

Parameters
`continuations: (Mutable)List<WorkContinuation!>`	One or more `WorkContinuation`s that are prerequisites for the return value

Returns
`WorkContinuation`	A `WorkContinuation` that allows further chaining

enqueue

Added in 1.0.0

abstract fun enqueue(): Operation

Enqueues the instance of WorkContinuation on the background thread.

Returns
`Operation`	An `Operation` that can be used to determine when the enqueue has completed

getWorkInfos

Added in 1.0.0

abstract fun getWorkInfos(): ListenableFuture<(Mutable)List<WorkInfo!>!>

Returns a ListenableFuture of a List of WorkInfos that provides information about the status of each OneTimeWorkRequest in this WorkContinuation, as well as their prerequisites.

Returns
`ListenableFuture<(Mutable)List<WorkInfo!>!>`	A `ListenableFuture` of a `List` of `WorkInfo`s

getWorkInfosLiveData

Added in 1.0.0

abstract fun getWorkInfosLiveData(): LiveData<(Mutable)List<WorkInfo!>!>

Returns a LiveData list of WorkInfos that provide information about the status of each OneTimeWorkRequest in this WorkContinuation, as well as their prerequisites. If the state or outputs of any of the work changes, any attached Observers will trigger.

Returns
`LiveData<(Mutable)List<WorkInfo!>!>`	A `LiveData` containing a list of `WorkInfo`s; you must use `observe` to receive updates

then

Added in 1.0.0

abstract fun then(work: (Mutable)List<OneTimeWorkRequest!>): WorkContinuation

Adds new OneTimeWorkRequest items that depend on the successful completion of all previously added OneTimeWorkRequests.

Parameters
`work: (Mutable)List<OneTimeWorkRequest!>`	One or more `OneTimeWorkRequest` to add as dependents

Returns
`WorkContinuation`	A `WorkContinuation` that allows for further chaining of dependent `OneTimeWorkRequest`s

then

Added in 1.0.0

fun then(work: OneTimeWorkRequest): WorkContinuation

Adds new OneTimeWorkRequest items that depend on the successful completion of all previously added OneTimeWorkRequests.

Parameters
`work: OneTimeWorkRequest`	One or more `OneTimeWorkRequest`s to add as dependents

Returns
`WorkContinuation`	A `WorkContinuation` that allows for further chaining of dependent `OneTimeWorkRequest`s