ListenableWorker.Result
public
static
abstract
class
ListenableWorker.Result
extends Object
java.lang.Object | |
↳ | androidx.work.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 methods | |
---|---|
static
ListenableWorker.Result
|
failure()
Returns an instance of |
static
ListenableWorker.Result
|
failure(Data outputData)
Returns an instance of |
static
ListenableWorker.Result
|
retry()
Returns an instance of |
static
ListenableWorker.Result
|
success()
Returns an instance of |
static
ListenableWorker.Result
|
success(Data outputData)
Returns an instance of |
Inherited methods | |
---|---|
Public methods
failure
public static ListenableWorker.Result failure ()
Returns an instance of ListenableWorker.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(Data)
; failure indicates a permanent stoppage
of the chain of work.
Returns | |
---|---|
ListenableWorker.Result |
An instance of ListenableWorker.Result indicating failure when executing work
|
failure
public static ListenableWorker.Result failure (Data outputData)
Returns an instance of ListenableWorker.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(Data)
; 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 ListenableWorker.Result indicating failure when executing work
|
retry
public static ListenableWorker.Result retry ()
Returns an instance of ListenableWorker.Result
that can be used to indicate that the work
encountered a transient failure and should be retried with backoff specified in
WorkRequest.Builder.setBackoffCriteria(BackoffPolicy, long, TimeUnit)
.
Returns | |
---|---|
ListenableWorker.Result |
An instance of ListenableWorker.Result indicating that the work needs to be retried
|
success
public static ListenableWorker.Result success ()
Returns an instance of ListenableWorker.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 ListenableWorker.Result indicating successful execution of work
|
success
public static ListenableWorker.Result success (Data outputData)
Returns an instance of ListenableWorker.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 ListenableWorker.Result indicating successful execution of work
|