android library
The low level api specific for the Android platform, mapping to the WorkManager
library.
Classes
- BackoffCriteria
- Sets the backoff policy and backoff delay for the work.
- OneTimeWorkRequest
- Defines an one-off work request.
- PeriodicWorkRequest
- Defines a periodic work request.
- WorkConstraints
- Constraints for a WorkIntent.
- WorkRequest
- An abstract class representing a work request.
Enums
- BackoffPolicy
- An enumeration of backoff policies when retrying work.
- NetworkType
- An enumeration of various network types that can be used as WorkConstraints.
Functions
-
cancelAllWork(
) → Future< bool> - Cancels all unfinished work.
-
cancelAllWorkByTag(
String tag) → Future< bool> -
Cancels all unfinished work with the given
tag
. -
cancelUniqueWork(
String name) → Future< bool> -
Cancels all unfinished work in the work chain with the given
name
. -
cancelWorkById(
String uuid) → Future< bool> -
Cancels work with the given
uuid
if it isn't finished. -
enqueueWorkRequest(
WorkRequest request) → Future< bool> - Enqueues one item for background processing.
-
enqueueWorkRequests(
Iterable< WorkRequest> requests) → Future<bool> - Enqueues one or more items for background processing.
-
initializeWorker(
WorkerFn worker) → Future< void> -
Initializes the plugin by registering a
worker
callback.