# WorkManager
Artifact: [androidx.work:work-runtime](https://developer.android.com/jetpack/androidx/releases/work) [View Source](https://cs.android.com/search?q=file:androidx/work/WorkManager.kt+class:androidx.work.WorkManager) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
*** ** * ** ***
```
public abstract class WorkManager
```
*** ** * ** ***
WorkManager is the recommended library for persistent work. Scheduled work is guaranteed to execute sometime after its `https://developer.android.com/reference/androidx/work/Constraints` are met. WorkManager allows observation of work status and the ability to create complex chains of work.
WorkManager uses an underlying job dispatching service when available based on the following criteria:
- Uses JobScheduler for API 23+
- Uses a custom AlarmManager + BroadcastReceiver implementation for API 14-22
All work must be done in a `https://developer.android.com/reference/androidx/work/ListenableWorker` class. A simple implementation, `https://developer.android.com/reference/androidx/work/Worker`, is recommended as the starting point for most developers. With the optional dependencies, you can also use `CoroutineWorker` or `RxWorker`. All background work is given a maximum of ten minutes to finish its execution. After this time has expired, the worker will be signalled to stop.
There are two types of work supported by WorkManager: `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` and `https://developer.android.com/reference/androidx/work/PeriodicWorkRequest`. You can enqueue requests using WorkManager as follows:
```
WorkManager workManager = WorkManager.getInstance(Context);
workManager.enqueue(new OneTimeWorkRequest.Builder(FooWorker.class).build());
```
A `https://developer.android.com/reference/androidx/work/WorkRequest` has an associated id that can be used for lookups and observation as follows:
```
WorkRequest request = new OneTimeWorkRequest.Builder(FooWorker.class).build();
workManager.enqueue(request);
LiveData status = workManager.getWorkInfoByIdLiveData(request.getId());
status.observe(...);
```
You can also use the id for cancellation:
```
WorkRequest request = new OneTimeWorkRequest.Builder(FooWorker.class).build();
workManager.enqueue(request);
workManager.cancelWorkById(request.getId());
```
You can chain work as follows:
```
WorkRequest request1 = new OneTimeWorkRequest.Builder(FooWorker.class).build();
WorkRequest request2 = new OneTimeWorkRequest.Builder(BarWorker.class).build();
WorkRequest request3 = new OneTimeWorkRequest.Builder(BazWorker.class).build();
workManager.beginWith(request1, request2).then(request3).enqueue();
```
Each call to `https://developer.android.com/reference/androidx/work/WorkManager#beginWith(androidx.work.OneTimeWorkRequest)` returns a `https://developer.android.com/reference/androidx/work/WorkContinuation` upon which you can call `https://developer.android.com/reference/androidx/work/WorkContinuation#then(androidx.work.OneTimeWorkRequest)` with a single `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` or a list of `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` to chain further work. This allows for creation of complex chains of work. For example, to create a chain like this:
```
A
|
+---+
| |
B C
|
+---+
| |
D E
```
you would enqueue them as follows:
```
WorkContinuation continuation = workManager.beginWith(A);
continuation.then(B).then(D, E).enqueue(); // A is implicitly enqueued here
continuation.then(C).enqueue();
```
Work is eligible for execution when all of its prerequisites are complete. If any of its prerequisites fail or are cancelled, the work will never run.
WorkRequests can accept `https://developer.android.com/reference/androidx/work/Constraints`, inputs (see `https://developer.android.com/reference/androidx/work/Data`), and backoff criteria. WorkRequests can be tagged with human-readable Strings (see `https://developer.android.com/reference/androidx/work/WorkRequest.Builder#addTag(kotlin.String)`), and chains of work can be given a uniquely-identifiable name (see `https://developer.android.com/reference/androidx/work/WorkManager#beginUniqueWork(kotlin.String,androidx.work.ExistingWorkPolicy,androidx.work.OneTimeWorkRequest)`).
### Initializing WorkManager
By default, WorkManager auto-initializes itself using a built-in `ContentProvider`. ContentProviders are created and run before the `Application` object, so this allows the WorkManager singleton to be setup before your code can run in most cases. This is suitable for most developers. However, you can provide a custom `https://developer.android.com/reference/androidx/work/Configuration` by using `https://developer.android.com/reference/androidx/work/Configuration.Provider` or `https://developer.android.com/reference/androidx/work/WorkManager#initialize(android.content.Context,androidx.work.Configuration)`.
### Renaming and Removing ListenableWorker Classes
Exercise caution in renaming classes derived from `https://developer.android.com/reference/androidx/work/ListenableWorker`s. WorkManager stores the class name in its internal database when the `https://developer.android.com/reference/androidx/work/WorkRequest` is enqueued so it can later create an instance of that worker when constraints are met. Unless otherwise specified in the WorkManager `https://developer.android.com/reference/androidx/work/Configuration`, this is done in the default `https://developer.android.com/reference/androidx/work/WorkerFactory` which tries to reflectively create the ListenableWorker object. Therefore, renaming or removing these classes is dangerous - if there is pending work with the given class, it will fail permanently if the class cannot be found. If you are using a custom WorkerFactory, make sure you properly handle cases where the class is not found so that your code does not crash.
In case it is desirable to rename a class, implement a custom WorkerFactory that instantiates the right ListenableWorker for the old class name.
## Summary
| ### Nested types |
|---|
| `public enum https://developer.android.com/reference/androidx/work/WorkManager.UpdateResult extends https://developer.android.com/reference/java/lang/Enum.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkManager.UpdateResult>` An enumeration of results for `https://developer.android.com/reference/androidx/work/WorkManager#updateWork(androidx.work.WorkRequest)` method. |
| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkContinuation` | `https://developer.android.com/reference/androidx/work/WorkManager#beginUniqueWork(kotlin.String,androidx.work.ExistingWorkPolicy,androidx.work.OneTimeWorkRequest)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingWorkPolicy existingWorkPolicy, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest request )` This method allows you to begin unique chains of work for situations where you only want one chain with a given name to be active at a time. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkContinuation` | `https://developer.android.com/reference/androidx/work/WorkManager#beginUniqueWork(kotlin.String,androidx.work.ExistingWorkPolicy,kotlin.collections.List)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingWorkPolicy existingWorkPolicy, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest> requests )` This method allows you to begin unique chains of work for situations where you only want one chain with a given name to be active at a time. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkContinuation` | `https://developer.android.com/reference/androidx/work/WorkManager#beginWith(androidx.work.OneTimeWorkRequest)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest request)` Begins a chain with one or more `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest`s, which can be enqueued together in the future using `https://developer.android.com/reference/androidx/work/WorkContinuation#enqueue()`. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkContinuation` | `https://developer.android.com/reference/androidx/work/WorkManager#beginWith(kotlin.collections.List)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest> requests)` Begins a chain with one or more `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest`s, which can be enqueued together in the future using `https://developer.android.com/reference/androidx/work/WorkContinuation#enqueue()`. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#cancelAllWork()()` Cancels all unfinished work. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#cancelAllWorkByTag(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html tag)` Cancels all unfinished work with the given tag. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#cancelUniqueWork(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName)` Cancels all unfinished work in the work chain with the given name. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#cancelWorkById(java.util.UUID)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id)` Cancels work with the given id if it isn't finished. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/app/PendingIntent.html` | `https://developer.android.com/reference/androidx/work/WorkManager#createCancelPendingIntent(java.util.UUID)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id)` Creates a `https://developer.android.com/reference/android/app/PendingIntent.html` which can be used to cancel a `https://developer.android.com/reference/androidx/work/WorkRequest` with the given `id`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#enqueue(androidx.work.WorkRequest)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkRequest request)` Enqueues one item for background processing. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#enqueue(kotlin.collections.List)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkRequest> requests)` Enqueues one or more items for background processing. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#enqueueUniquePeriodicWork(kotlin.String,androidx.work.ExistingPeriodicWorkPolicy,androidx.work.PeriodicWorkRequest)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingPeriodicWorkPolicy existingPeriodicWorkPolicy, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/PeriodicWorkRequest request )` This method allows you to enqueue a uniquely-named `https://developer.android.com/reference/androidx/work/PeriodicWorkRequest`, where only one PeriodicWorkRequest of a particular name can be active at a time. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#enqueueUniqueWork(kotlin.String,androidx.work.ExistingWorkPolicy,androidx.work.OneTimeWorkRequest)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingWorkPolicy existingWorkPolicy, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest request )` This method allows you to enqueue `work` requests to a uniquely-named `https://developer.android.com/reference/androidx/work/WorkContinuation`, where only one continuation of a particular name can be active at a time. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#enqueueUniqueWork(kotlin.String,androidx.work.ExistingWorkPolicy,kotlin.collections.List)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingWorkPolicy existingWorkPolicy, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest> requests )` This method allows you to enqueue `work` requests to a uniquely-named `https://developer.android.com/reference/androidx/work/WorkContinuation`, where only one continuation of a particular name can be active at a time. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Configuration` | `https://developer.android.com/reference/androidx/work/WorkManager#getConfiguration()()` The `https://developer.android.com/reference/androidx/work/Configuration` instance that `https://developer.android.com/reference/androidx/work/WorkManager` was initialized with. |
| `static @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkManager` | `[getInstance](https://developer.android.com/reference/androidx/work/WorkManager#getInstance())()` **This method is deprecated.** Use the overload receiving Context |
| `static @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkManager` | `https://developer.android.com/reference/androidx/work/WorkManager#getInstance(android.content.Context)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context)` Retrieves the `default` singleton instance of `https://developer.android.com/reference/androidx/work/WorkManager`. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Long.html>` | `https://developer.android.com/reference/androidx/work/WorkManager#getLastCancelAllTimeMillis()()` Gets a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the last time all work was cancelled. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Long.html>` | `https://developer.android.com/reference/androidx/work/WorkManager#getLastCancelAllTimeMillisLiveData()()` Gets a `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the last time all work was cancelled. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfoById(java.util.UUID)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id)` Gets a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for a given work id. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfoByIdFlow(java.util.UUID)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id)` Gets a `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for a given work id. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfoByIdLiveData(java.util.UUID)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id)` Gets a `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for a given work id. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfos(androidx.work.WorkQuery)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkQuery workQuery)` Gets the `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for all work referenced by the `https://developer.android.com/reference/androidx/work/WorkQuery` specification. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfosByTag(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html tag)` Gets a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work for a given tag. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfosByTagFlow(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html tag)` Gets a `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work for a given tag. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfosByTagLiveData(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html tag)` Gets a `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work for a given tag. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfosFlow(androidx.work.WorkQuery)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkQuery workQuery)` Gets the `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for all work referenced by the `https://developer.android.com/reference/androidx/work/WorkQuery` specification. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfosForUniqueWork(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName)` Gets a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work in a work chain with a given unique name. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfosForUniqueWorkFlow(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName)` Gets a `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work in a work chain with a given unique name. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfosForUniqueWorkLiveData(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName)` Gets a `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work in a work chain with a given unique name. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | `https://developer.android.com/reference/androidx/work/WorkManager#getWorkInfosLiveData(androidx.work.WorkQuery)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkQuery workQuery)` Gets the `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for all work referenced by the `https://developer.android.com/reference/androidx/work/WorkQuery` specification. |
| `static void` | `https://developer.android.com/reference/androidx/work/WorkManager#initialize(android.content.Context,androidx.work.Configuration)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Configuration configuration)` Used to do a one-time initialization of the `https://developer.android.com/reference/androidx/work/WorkManager` singleton with a custom `https://developer.android.com/reference/androidx/work/Configuration`. |
| `static boolean` | `https://developer.android.com/reference/androidx/work/WorkManager#isInitialized()()` Provides a way to check if `https://developer.android.com/reference/androidx/work/WorkManager` is initialized in this process. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | `https://developer.android.com/reference/androidx/work/WorkManager#pruneWork()()` Prunes all eligible finished work from the internal database. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkManager.UpdateResult>` | `https://developer.android.com/reference/androidx/work/WorkManager#updateWork(androidx.work.WorkRequest)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkRequest request)` Updates the work with the new specification. |
## Public methods
### beginUniqueWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public final @NonNull WorkContinuation beginUniqueWork(
@NonNull String uniqueWorkName,
@NonNull ExistingWorkPolicy existingWorkPolicy,
@NonNull OneTimeWorkRequest request
)
```
This method allows you to begin unique chains of work for situations where you only want one chain with a given name to be active at a time. For example, you may only want one sync operation to be active. If there is one pending, you can choose to let it run or replace it with your new work.
The `uniqueWorkName` uniquely identifies this set of work.
If this method determines that new work should be enqueued and run, all records of previous work with `uniqueWorkName` will be pruned. If this method determines that new work should NOT be run, then the entire chain will be considered a no-op.
If any work in the chain fails or is cancelled, all of its dependent work inherits that state and will never run. This is particularly important if you are using `APPEND` as your `https://developer.android.com/reference/androidx/work/ExistingWorkPolicy`.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | A unique name which for this chain of work |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingWorkPolicy existingWorkPolicy` | An `https://developer.android.com/reference/androidx/work/ExistingWorkPolicy` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest request` | The `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` to enqueue. `REPLACE` ensures that if there is pending work labelled with `uniqueWorkName`, it will be cancelled and the new work will run. `KEEP` will run the new sequence of work only if there is no pending work labelled with `uniqueWorkName`. `APPEND` will create a new sequence of work if there is no existing work with `uniqueWorkName`; otherwise, `work` will be added as a child of all leaf nodes labelled with `uniqueWorkName`. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkContinuation` | A `https://developer.android.com/reference/androidx/work/WorkContinuation` that allows further chaining |
### beginUniqueWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull WorkContinuation beginUniqueWork(
@NonNull String uniqueWorkName,
@NonNull ExistingWorkPolicy existingWorkPolicy,
@NonNull List<@NonNull OneTimeWorkRequest> requests
)
```
This method allows you to begin unique chains of work for situations where you only want one chain with a given name to be active at a time. For example, you may only want one sync operation to be active. If there is one pending, you can choose to let it run or replace it with your new work.
The `uniqueWorkName` uniquely identifies this set of work.
If this method determines that new work should be enqueued and run, all records of previous work with `uniqueWorkName` will be pruned. If this method determines that new work should NOT be run, then the entire chain will be considered a no-op.
If any work in the chain fails or is cancelled, all of its dependent work inherits that state and will never run. This is particularly important if you are using `APPEND` as your `https://developer.android.com/reference/androidx/work/ExistingWorkPolicy`.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | A unique name which for this chain of work |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingWorkPolicy existingWorkPolicy` | An `https://developer.android.com/reference/androidx/work/ExistingWorkPolicy`; see below for more information |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest> requests` | One or more `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` to enqueue. `REPLACE` ensures that if there is pending work labelled with `uniqueWorkName`, it will be cancelled and the new work will run. `KEEP` will run the new sequence of work only if there is no pending work labelled with `uniqueWorkName`. `APPEND` will create a new sequence of work if there is no existing work with `uniqueWorkName`; otherwise, `work` will be added as a child of all leaf nodes labelled with `uniqueWorkName`. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkContinuation` | A `https://developer.android.com/reference/androidx/work/WorkContinuation` that allows further chaining |
### beginWith
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public final @NonNull WorkContinuation beginWith(@NonNull OneTimeWorkRequest request)
```
Begins a chain with one or more `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest`s, which can be enqueued together in the future using `https://developer.android.com/reference/androidx/work/WorkContinuation#enqueue()`.
If any work in the chain fails or is cancelled, all of its dependent work inherits that state and will never run.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest request` | One or more `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` to start a chain of work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkContinuation` | A `https://developer.android.com/reference/androidx/work/WorkContinuation` that allows for further chaining of dependent `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` |
### beginWith
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull WorkContinuation beginWith(@NonNull List<@NonNull OneTimeWorkRequest> requests)
```
Begins a chain with one or more `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest`s, which can be enqueued together in the future using `https://developer.android.com/reference/androidx/work/WorkContinuation#enqueue()`.
If any work in the chain fails or is cancelled, all of its dependent work inherits that state and will never run.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest> requests` | One or more `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` to start a chain of work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkContinuation` | A `https://developer.android.com/reference/androidx/work/WorkContinuation` that allows for further chaining of dependent `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` |
### cancelAllWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull Operation cancelAllWork()
```
Cancels all unfinished work. **Use this method with extreme caution!** By invoking it, you will potentially affect other modules or libraries in your codebase. It is strongly recommended that you use one of the other cancellation methods at your disposal.
Upon cancellation, `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` returned by `https://developer.android.com/reference/androidx/work/ListenableWorker#startWork()` will be cancelled. Also `https://developer.android.com/reference/androidx/work/ListenableWorker#onStopped()` will be invoked for any affected workers.
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the cancelAllWork has completed |
### cancelAllWorkByTag
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull Operation cancelAllWorkByTag(@NonNull String tag)
```
Cancels all unfinished work with the given tag. Note that cancellation is a best-effort policy and work that is already executing may continue to run. Upon cancellation, `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` returned by `https://developer.android.com/reference/androidx/work/ListenableWorker#startWork()` will be cancelled. Also `https://developer.android.com/reference/androidx/work/ListenableWorker#onStopped()` will be invoked for any affected workers.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html tag` | The tag used to identify the work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the cancelAllWorkByTag has completed |
### cancelUniqueWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull Operation cancelUniqueWork(@NonNull String uniqueWorkName)
```
Cancels all unfinished work in the work chain with the given name. Note that cancellation is a best-effort policy and work that is already executing may continue to run. Upon cancellation, `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` returned by `https://developer.android.com/reference/androidx/work/ListenableWorker#startWork()` will be cancelled. Also `https://developer.android.com/reference/androidx/work/ListenableWorker#onStopped()` will be invoked for any affected workers.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | The unique name used to identify the chain of work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the cancelUniqueWork has completed |
### cancelWorkById
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull Operation cancelWorkById(@NonNull UUID id)
```
Cancels work with the given id if it isn't finished. Note that cancellation is a best-effort policy and work that is already executing may continue to run. Upon cancellation, `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` returned by `https://developer.android.com/reference/androidx/work/ListenableWorker#startWork()` will be cancelled. Also `https://developer.android.com/reference/androidx/work/ListenableWorker#onStopped()` will be invoked for any affected workers.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id` | The id of the work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the cancelWorkById has completed |
### createCancelPendingIntent
Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/work#2.3.0)
```
public abstract @NonNull PendingIntent createCancelPendingIntent(@NonNull UUID id)
```
Creates a `https://developer.android.com/reference/android/app/PendingIntent.html` which can be used to cancel a `https://developer.android.com/reference/androidx/work/WorkRequest` with the given `id`.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id` | The `https://developer.android.com/reference/androidx/work/WorkRequest` id. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/app/PendingIntent.html` | The `https://developer.android.com/reference/android/app/PendingIntent.html` that can be used to cancel the `https://developer.android.com/reference/androidx/work/WorkRequest`. |
### enqueue
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public final @NonNull Operation enqueue(@NonNull WorkRequest request)
```
Enqueues one item for background processing.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkRequest request` | The `https://developer.android.com/reference/androidx/work/WorkRequest` to enqueue |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the enqueue has completed |
### enqueue
```
public abstract @NonNull Operation enqueue(@NonNull List<@NonNull WorkRequest> requests)
```
Enqueues one or more items for background processing.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkRequest> requests` | One or more `https://developer.android.com/reference/androidx/work/WorkRequest` to enqueue |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the enqueue has completed |
### enqueueUniquePeriodicWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull Operation enqueueUniquePeriodicWork(
@NonNull String uniqueWorkName,
@NonNull ExistingPeriodicWorkPolicy existingPeriodicWorkPolicy,
@NonNull PeriodicWorkRequest request
)
```
This method allows you to enqueue a uniquely-named `https://developer.android.com/reference/androidx/work/PeriodicWorkRequest`, where only one PeriodicWorkRequest of a particular name can be active at a time. For example, you may only want one sync operation to be active. If there is one pending, you can choose to let it run or replace it with your new work.
The `uniqueWorkName` uniquely identifies this PeriodicWorkRequest.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | A unique name which for this operation |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingPeriodicWorkPolicy existingPeriodicWorkPolicy` | An `https://developer.android.com/reference/androidx/work/ExistingPeriodicWorkPolicy` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/PeriodicWorkRequest request` | A `https://developer.android.com/reference/androidx/work/PeriodicWorkRequest` to enqueue. `REPLACE` ensures that if there is pending work labelled with `uniqueWorkName`, it will be cancelled and the new work will run. `KEEP` will run the new PeriodicWorkRequest only if there is no pending work labelled with `uniqueWorkName`. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the enqueue has completed |
### enqueueUniqueWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public @NonNull Operation enqueueUniqueWork(
@NonNull String uniqueWorkName,
@NonNull ExistingWorkPolicy existingWorkPolicy,
@NonNull OneTimeWorkRequest request
)
```
This method allows you to enqueue `work` requests to a uniquely-named `https://developer.android.com/reference/androidx/work/WorkContinuation`, where only one continuation of a particular name can be active at a time. For example, you may only want one sync operation to be active. If there is one pending, you can choose to let it run or replace it with your new work.
The `uniqueWorkName` uniquely identifies this `https://developer.android.com/reference/androidx/work/WorkContinuation`.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | A unique name which for this operation |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingWorkPolicy existingWorkPolicy` | An `https://developer.android.com/reference/androidx/work/ExistingWorkPolicy`; see below for more information |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest request` | The `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest`s to enqueue. `REPLACE` ensures that if there is pending work labelled with `uniqueWorkName`, it will be cancelled and the new work will run. `KEEP` will run the new OneTimeWorkRequests only if there is no pending work labelled with `uniqueWorkName`. `APPEND` will append the OneTimeWorkRequests as leaf nodes labelled with `uniqueWorkName`. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the enqueue has completed |
### enqueueUniqueWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull Operation enqueueUniqueWork(
@NonNull String uniqueWorkName,
@NonNull ExistingWorkPolicy existingWorkPolicy,
@NonNull List<@NonNull OneTimeWorkRequest> requests
)
```
This method allows you to enqueue `work` requests to a uniquely-named `https://developer.android.com/reference/androidx/work/WorkContinuation`, where only one continuation of a particular name can be active at a time. For example, you may only want one sync operation to be active. If there is one pending, you can choose to let it run or replace it with your new work.
The `uniqueWorkName` uniquely identifies this `https://developer.android.com/reference/androidx/work/WorkContinuation`.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | A unique name which for this operation |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/ExistingWorkPolicy existingWorkPolicy` | An `https://developer.android.com/reference/androidx/work/ExistingWorkPolicy` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/OneTimeWorkRequest> requests` | `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest`s to enqueue. `REPLACE` ensures that if there is pending work labelled with `uniqueWorkName`, it will be cancelled and the new work will run. `KEEP` will run the new OneTimeWorkRequests only if there is no pending work labelled with `uniqueWorkName`. `APPEND` will append the OneTimeWorkRequests as leaf nodes labelled with `uniqueWorkName`. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the enqueue has completed |
### getConfiguration
Added in [2.8.0](https://developer.android.com/jetpack/androidx/releases/work#2.8.0)
```
public abstract @NonNull Configuration getConfiguration()
```
The `https://developer.android.com/reference/androidx/work/Configuration` instance that `https://developer.android.com/reference/androidx/work/WorkManager` was initialized with.
### getInstance
Added in [2.10.0](https://developer.android.com/jetpack/androidx/releases/work#2.10.0) Deprecated in [2.10.0](https://developer.android.com/jetpack/androidx/releases/work#2.10.0)
```
public static @NonNull WorkManager [getInstance](https://developer.android.com/reference/androidx/work/WorkManager#getInstance())()
```
> [!CAUTION]
> **This method is deprecated.**
> Use the overload receiving Context, use this instead:
>
> ```
> WorkManager.getContext(context)
> ```
Retrieves the `default` singleton instance of `https://developer.android.com/reference/androidx/work/WorkManager`.
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkManager` | The singleton instance of `https://developer.android.com/reference/androidx/work/WorkManager`; this may be `null` in unusual circumstances where you have disabled automatic initialization and have failed to manually call `https://developer.android.com/reference/androidx/work/WorkManager#initialize(android.content.Context,androidx.work.Configuration)`. |
| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | If WorkManager is not initialized properly as per the exception message. |
### getInstance
Added in [2.10.0](https://developer.android.com/jetpack/androidx/releases/work#2.10.0)
```
public static @NonNull WorkManager getInstance(@NonNull Context context)
```
Retrieves the `default` singleton instance of `https://developer.android.com/reference/androidx/work/WorkManager`.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | A `https://developer.android.com/reference/android/content/Context.html` for on-demand initialization. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkManager` | The singleton instance of `https://developer.android.com/reference/androidx/work/WorkManager`; this may be `null` in unusual circumstances where you have disabled automatic initialization and have failed to manually call `https://developer.android.com/reference/androidx/work/WorkManager#initialize(android.content.Context,androidx.work.Configuration)`. |
| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | If WorkManager is not initialized properly |
### getLastCancelAllTimeMillis
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull ListenableFuture<@NonNull Long> getLastCancelAllTimeMillis()
```
Gets a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the last time all work was cancelled. This method is intended for use by library and module developers who have dependent data in their own repository that must be updated or deleted in case someone cancels their work without their prior knowledge.
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Long.html>` | A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the timestamp (`System#getCurrentTimeMillis()`) when `https://developer.android.com/reference/androidx/work/WorkManager#cancelAllWork()` was last invoked; this timestamp may be `0L` if this never occurred |
### getLastCancelAllTimeMillisLiveData
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull LiveData<@NonNull Long> getLastCancelAllTimeMillisLiveData()
```
Gets a `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the last time all work was cancelled. This method is intended for use by library and module developers who have dependent data in their own repository that must be updated or deleted in case someone cancels their work without their prior knowledge.
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Long.html>` | A `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the timestamp (`System#getCurrentTimeMillis()`) when `https://developer.android.com/reference/androidx/work/WorkManager#cancelAllWork()` was last invoked; this timestamp may be `0L` if this never occurred |
### getWorkInfoById
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull ListenableFuture getWorkInfoById(@NonNull UUID id)
```
Gets a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for a given work id.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id` | The id of the work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` | A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` associated with `id`; note that this `https://developer.android.com/reference/androidx/work/WorkInfo` may be `null` if `id` is not known to WorkManager |
### getWorkInfoByIdFlow
Added in [2.9.0](https://developer.android.com/jetpack/androidx/releases/work#2.9.0)
```
public abstract @NonNull Flow getWorkInfoByIdFlow(@NonNull UUID id)
```
Gets a `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for a given work id.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id` | The id of the work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` | A `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` associated with `id`; note that this `https://developer.android.com/reference/androidx/work/WorkInfo` may be `null` if `id` is not known to WorkManager. |
### getWorkInfoByIdLiveData
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull LiveData getWorkInfoByIdLiveData(@NonNull UUID id)
```
Gets a `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for a given work id.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/UUID.html id` | The id of the work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData` | A `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://developer.android.com/reference/androidx/work/WorkInfo` associated with `id`; note that this `https://developer.android.com/reference/androidx/work/WorkInfo` may be `null` if `id` is not known to WorkManager. |
### getWorkInfos
Added in [2.4.0](https://developer.android.com/jetpack/androidx/releases/work#2.4.0)
```
public abstract @NonNull ListenableFuture<@NonNull List<@NonNull WorkInfo>> getWorkInfos(@NonNull WorkQuery workQuery)
```
Gets the `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for all work referenced by the `https://developer.android.com/reference/androidx/work/WorkQuery` specification.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkQuery workQuery` | The work query specification |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for work referenced by this `https://developer.android.com/reference/androidx/work/WorkQuery`. |
### getWorkInfosByTag
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull ListenableFuture<@NonNull List<@NonNull WorkInfo>> getWorkInfosByTag(@NonNull String tag)
```
Gets a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work for a given tag.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html tag` | The tag of the work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` list of `https://developer.android.com/reference/androidx/work/WorkInfo` for work tagged with `tag` |
### getWorkInfosByTagFlow
Added in [2.9.0](https://developer.android.com/jetpack/androidx/releases/work#2.9.0)
```
public abstract @NonNull Flow<@NonNull List<@NonNull WorkInfo>> getWorkInfosByTagFlow(@NonNull String tag)
```
Gets a `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work for a given tag.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html tag` | The tag of the work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` list of `https://developer.android.com/reference/androidx/work/WorkInfo` for work tagged with `tag` |
### getWorkInfosByTagLiveData
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull LiveData<@NonNull List<@NonNull WorkInfo>> getWorkInfosByTagLiveData(@NonNull String tag)
```
Gets a `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work for a given tag.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html tag` | The tag of the work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://developer.android.com/reference/androidx/lifecycle/LiveData` list of `https://developer.android.com/reference/androidx/work/WorkInfo` for work tagged with `tag` |
### getWorkInfosFlow
Added in [2.9.0](https://developer.android.com/jetpack/androidx/releases/work#2.9.0)
```
public abstract @NonNull Flow<@NonNull List<@NonNull WorkInfo>> getWorkInfosFlow(@NonNull WorkQuery workQuery)
```
Gets the `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for all work referenced by the `https://developer.android.com/reference/androidx/work/WorkQuery` specification.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkQuery workQuery` | The work query specification |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for work referenced by this `https://developer.android.com/reference/androidx/work/WorkQuery`. |
### getWorkInfosForUniqueWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull ListenableFuture<@NonNull List<@NonNull WorkInfo>> getWorkInfosForUniqueWork(@NonNull String uniqueWorkName)
```
Gets a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work in a work chain with a given unique name.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | The unique name used to identify the chain of work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for work in the chain named `uniqueWorkName` |
### getWorkInfosForUniqueWorkFlow
Added in [2.9.0](https://developer.android.com/jetpack/androidx/releases/work#2.9.0)
```
public abstract @NonNull Flow<@NonNull List<@NonNull WorkInfo>> getWorkInfosForUniqueWorkFlow(@NonNull String uniqueWorkName)
```
Gets a `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work in a work chain with a given unique name.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | The unique name used to identify the chain of work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for work in the chain named `uniqueWorkName` |
### getWorkInfosForUniqueWorkLiveData
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull LiveData<@NonNull List<@NonNull WorkInfo>> getWorkInfosForUniqueWorkLiveData(@NonNull String uniqueWorkName)
```
Gets a `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for all work in a work chain with a given unique name.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uniqueWorkName` | The unique name used to identify the chain of work |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://developer.android.com/reference/androidx/work/WorkInfo` for work in the chain named `uniqueWorkName` |
### getWorkInfosLiveData
Added in [2.4.0](https://developer.android.com/jetpack/androidx/releases/work#2.4.0)
```
public abstract @NonNull LiveData<@NonNull List<@NonNull WorkInfo>> getWorkInfosLiveData(@NonNull WorkQuery workQuery)
```
Gets the `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for all work referenced by the `https://developer.android.com/reference/androidx/work/WorkQuery` specification.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkQuery workQuery` | The work query specification |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/LiveData<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkInfo>>` | A `https://developer.android.com/reference/androidx/lifecycle/LiveData` of the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/androidx/work/WorkInfo` for work referenced by this `https://developer.android.com/reference/androidx/work/WorkQuery`. |
### initialize
Added in [2.10.0](https://developer.android.com/jetpack/androidx/releases/work#2.10.0)
```
public static void initialize(@NonNull Context context, @NonNull Configuration configuration)
```
Used to do a one-time initialization of the `https://developer.android.com/reference/androidx/work/WorkManager` singleton with a custom `https://developer.android.com/reference/androidx/work/Configuration`. By default, this method should not be called because WorkManager is automatically initialized. To initialize WorkManager yourself, please follow these steps:
- Disable `androidx.work.WorkManagerInitializer` in your manifest.
- Invoke this method in `Application#onCreate` or a `ContentProvider`. Note that this method **must** be invoked in one of these two places or you risk getting a `NullPointerException` in `https://developer.android.com/reference/androidx/work/WorkManager#getInstance()`.
This method throws an `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` when attempting to initialize in direct boot mode.
This method throws an exception if it is called multiple times.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | A `https://developer.android.com/reference/android/content/Context.html` object for configuration purposes. Internally, this class will call `https://developer.android.com/reference/android/content/Context.html#getApplicationContext()`, so you may safely pass in any Context without risking a memory leak. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Configuration configuration` | The `https://developer.android.com/reference/androidx/work/Configuration` for used to set up WorkManager. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/work/Configuration.Provider` | for on-demand initialization. |
### isInitialized
Added in [2.10.0](https://developer.android.com/jetpack/androidx/releases/work#2.10.0)
```
public static boolean isInitialized()
```
Provides a way to check if `https://developer.android.com/reference/androidx/work/WorkManager` is initialized in this process.
| Returns |
|---|---|
| `boolean` | `true` if `https://developer.android.com/reference/androidx/work/WorkManager` has been initialized in this process. |
### pruneWork
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
public abstract @NonNull Operation pruneWork()
```
Prunes all eligible finished work from the internal database. Eligible work must be finished (`https://developer.android.com/reference/androidx/work/WorkInfo.State#SUCCEEDED`, `https://developer.android.com/reference/androidx/work/WorkInfo.State#FAILED`, or `https://developer.android.com/reference/androidx/work/WorkInfo.State#CANCELLED`), with zero unfinished dependents.
**Use this method with caution** ; by invoking it, you (and any modules and libraries in your codebase) will no longer be able to observe the `https://developer.android.com/reference/androidx/work/WorkInfo` of the pruned work. You do not normally need to call this method - WorkManager takes care to auto-prune its work after a sane period of time. This method also ignores the `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest.Builder#keepResultsForAtLeast(kotlin.Long,java.util.concurrent.TimeUnit)` policy.
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/Operation` | An `https://developer.android.com/reference/androidx/work/Operation` that can be used to determine when the pruneWork has completed |
### updateWork
Added in [2.8.0](https://developer.android.com/jetpack/androidx/releases/work#2.8.0)
```
public abstract @NonNull ListenableFuture<@NonNull WorkManager.UpdateResult> updateWork(@NonNull WorkRequest request)
```
Updates the work with the new specification. A `https://developer.android.com/reference/androidx/work/WorkRequest` passed as parameter must have an id set with `https://developer.android.com/reference/androidx/work/WorkRequest.Builder#setId(java.util.UUID)` that matches an id of the previously enqueued work.
It preserves enqueue time, e.g. if a work was enqueued 3 hours ago and had 6 hours long initial delay, after the update it would be still eligible for run in 3 hours, assuming that initial delay wasn't updated.
If the work being updated is currently running the returned ListenableFuture will be completed with `https://developer.android.com/reference/androidx/work/WorkManager.UpdateResult#APPLIED_FOR_NEXT_RUN`. In this case the current run won't be interrupted and will continue to rely on previous state of the request, e.g. using old constraints, tags etc. However, on the next run, e.g. retry of one-time Worker or another iteration of periodic worker, the new worker specification will be used.
If the one time work that is updated is already finished the returned ListenableFuture will be completed with `https://developer.android.com/reference/androidx/work/WorkManager.UpdateResult#NOT_APPLIED`.
If update can be applied immediately, e.g. the updated work isn't currently running, the returned ListenableFuture will be completed with `https://developer.android.com/reference/androidx/work/WorkManager.UpdateResult#APPLIED_IMMEDIATELY`.
If the work with the given id (`request.getId()`) doesn't exist the returned ListenableFuture will be completed exceptionally with `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html`.
Worker type can't be changed, `https://developer.android.com/reference/androidx/work/OneTimeWorkRequest` can't be updated to `https://developer.android.com/reference/androidx/work/PeriodicWorkRequest` and otherwise, the returned ListenableFuture will be completed with `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html`.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkRequest request` | the new specification for the work. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/work/WorkManager.UpdateResult>` | a `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` that will be successfully completed if the update was successful. The future will be completed with an exception if the work is already running or finished. |