ListenableWorker.Result

abstract class ListenableWorker.Result


The result of a ListenableWorker's computation. Call success, failure, or retry or one of their variants to generate an object indicating what happened in your background work.

Summary

Public functions

java-static ListenableWorker.Result

Returns an instance of Result that can be used to indicate that the work completed with a permanent failure.

java-static ListenableWorker.Result
failure(outputData: Data)

Returns an instance of Result that can be used to indicate that the work completed with a permanent failure.

abstract Data
java-static ListenableWorker.Result

Returns an instance of Result that can be used to indicate that the work encountered a transient failure and should be retried with backoff specified in setBackoffCriteria.

java-static ListenableWorker.Result

Returns an instance of Result that can be used to indicate that the work completed successfully.

java-static ListenableWorker.Result
success(outputData: Data)

Returns an instance of Result that can be used to indicate that the work completed successfully.

Public functions

failure

Added in 1.0.0
java-static fun failure(): ListenableWorker.Result

Returns an instance of Result that can be used to indicate that the work completed with a permanent failure. Any work that depends on this will also be marked as failed and will not be run. If you need child workers to run, you need to use success or success; failure indicates a permanent stoppage of the chain of work.

Returns
ListenableWorker.Result

An instance of Result indicating failure when executing work

failure

Added in 1.0.0
java-static fun failure(outputData: Data): ListenableWorker.Result

Returns an instance of Result that can be used to indicate that the work completed with a permanent failure. Any work that depends on this will also be marked as failed and will not be run. If you need child workers to run, you need to use success or success; failure indicates a permanent stoppage of the chain of work.

Parameters
outputData: Data

A Data object that can be used to keep track of why the work failed

Returns
ListenableWorker.Result

An instance of Result indicating failure when executing work

getOutputData

Added in 2.7.0
abstract fun getOutputData(): Data
Returns
Data

The output Data which will be merged into the input Data of any OneTimeWorkRequest that is dependent on this work request.

retry

Added in 1.0.0
java-static fun retry(): ListenableWorker.Result

Returns an instance of Result that can be used to indicate that the work encountered a transient failure and should be retried with backoff specified in setBackoffCriteria.

Returns
ListenableWorker.Result

An instance of Result indicating that the work needs to be retried

success

Added in 1.0.0
java-static fun success(): ListenableWorker.Result

Returns an instance of Result that can be used to indicate that the work completed successfully. Any work that depends on this can be executed as long as all of its other dependencies and constraints are met.

Returns
ListenableWorker.Result

An instance of Result indicating successful execution of work

success

Added in 1.0.0
java-static fun success(outputData: Data): ListenableWorker.Result

Returns an instance of Result that can be used to indicate that the work completed successfully. Any work that depends on this can be executed as long as all of its other dependencies and constraints are met.

Parameters
outputData: Data

A Data object that will be merged into the input Data of any OneTimeWorkRequest that is dependent on this work

Returns
ListenableWorker.Result

An instance of Result indicating successful execution of work