WorkManager
Latest Update | Stable Release | Release Candidate | Beta Release | Alpha Release |
---|---|---|---|---|
October 2, 2024 | 2.9.1 | - | 2.10.0-beta01 | - |
Declaring dependencies
To add a dependency on WorkManager, you must add the Google Maven repository to your project:
Add the dependencies for the artifacts you need in the build.gradle
file for
your app or module:
Groovy
dependencies { def work_version = "2.9.1" // (Java only) implementation "androidx.work:work-runtime:$work_version" // Kotlin + coroutines implementation "androidx.work:work-runtime-ktx:$work_version" // optional - RxJava2 support implementation "androidx.work:work-rxjava2:$work_version" // optional - GCMNetworkManager support implementation "androidx.work:work-gcm:$work_version" // optional - Test helpers androidTestImplementation "androidx.work:work-testing:$work_version" // optional - Multiprocess support implementation "androidx.work:work-multiprocess:$work_version" }
Kotlin
dependencies { val work_version = "2.9.1" // (Java only) implementation("androidx.work:work-runtime:$work_version") // Kotlin + coroutines implementation("androidx.work:work-runtime-ktx:$work_version") // optional - RxJava2 support implementation("androidx.work:work-rxjava2:$work_version") // optional - GCMNetworkManager support implementation("androidx.work:work-gcm:$work_version") // optional - Test helpers androidTestImplementation("androidx.work:work-testing:$work_version") // optional - Multiprocess support implementation("androidx.work:work-multiprocess:$work_version") }
For information on using Kotlin extensions, see the ktx documentation.
For more information about dependencies, see Add Build Dependencies.
Feedback
Your feedback helps make Jetpack better. Let us know if you discover new issues or have ideas for improving this library. Please take a look at the existing issues in this library before you create a new one. You can add your vote to an existing issue by clicking the star button.
See the Issue Tracker documentation for more information.
Version 2.10
Version 2.10.0-beta01
October 2, 2024
androidx.work:work-*:2.10.0-beta01
is released. Version 2.10.0-beta01 contains these commits.
Version 2.10.0-alpha04
September 18, 2024
androidx.work:work-*:2.10.0-alpha04
is released. Version 2.10.0-alpha04 contains these commits.
API Changes
- Add the stop reason
STOP_REASON_FOREGROUND_SERVICE_TIMEOUT
for when a foreground worker is stopped due to execution timeout based on the foreground service type. (Ibd0af)
Version 2.10.0-alpha03
September 4, 2024
androidx.work:work-*:2.10.0-alpha03
is released. Version 2.10.0-alpha03 contains these commits.
New Features
- Added trace tags to Jobs from
WorkManager
which makes ‘adb shell dumpsys jobscheduler’ a lot simpler to understand since it will contain the name of the Worker being executed. Trace sections are also added around key areas ofWorkManager
.
API Changes
- WorkManager 2.10.0 is now compiled with SDK 35.
- Fix foreground workers of type ‘short service’ and ‘data sync’ timing out and causing an ANR when
WorkManager
didn’t callstopSelf()
. This fix only applies to devices with API 34 and 35 where foreground service types were introduced. (ca06b2, b/364508145) - New
WorkerParameters
APIs that make it possible to switch the remote process that theWorker
binds to when using aWorkerFactory
. (Ibdc8a, Ie8a90, I7373f)
Bug Fixes
- Fix a crash caused by
WorkManager
attempting to restart a long-running worker (i.e. a foreground worker) when the foreground type of the work had Android 14 prerequisite permissions that were revoked. (b/333957914) - Removed manual outlining of access to new platform APIs since this happens automatically via API modeling when using R8 with AGP 7.3 or later (e.g. R8 version 3.3) and for all builds when using AGP 8.1 or later (e.g. D8 version 8.1). Clients who are not using AGP are advised to update to D8 version 8.1 or later. See this article for more details. (Ia60e0, b/345472586)
Version 2.10.0-alpha02
April 17, 2024
androidx.work:work-*:2.10.0-alpha02
is released. Version 2.10.0-alpha02 contains these commits.
API Changes
- Added the ability to emit trace spans via a configurable
@RestrictTo
Tracer
inWorkManager
. (I17d7f, b/260214125) Configuration.workerCoroutineContext
was added to for control of dispatcher whereCoroutineWorker
is executed. It helps to completely avoid usage ofDispatchers.Default
inWorkManager
. (Icd1b7)- Add custom exception handlers for Workers (Ib1b74, b/261190695)
OneTimeWorkRequest.Builder
andPeriodicWorkRequest.Builder
can now be constructed withKClass
instead ofClass
:val request = OneTimeWorkRequest.Builder(Worker::class).setConstraints(...).build()
(Ib55f6)WorkManager
class was migrated to Kotlin. Now methods that returnLiveData
,ListenableFuture
orFlow
provides correct nullability information. It could require changes in clients' source code, if nullability assumptions in that code were incorrect. (If6757)
Version 2.10.0-alpha01
January 24, 2024
androidx.work:work-*:2.10.0-alpha01
is released. Version 2.10.0-alpha01 contains these commits.
New Features
- Developers can specify
NetworkRequest
as a constraint for a worker via theConstraints.setRequiredNetworkRequest
method. This enables more granular control over which network this worker should run.
API Changes
- Adding an ability to specify
NetworkRequest
as the constraint. (Id98a1, b/280634452)
Version 2.9
Version 2.9.1
August 7, 2024
androidx.work:work-*:2.9.1
is released. Version 2.9.1 contains these commits.
Bug Fixes
- Fix a crash caused by
WorkManager
attempting to restart a long-running worker (i.e. a foreground worker) when the foreground type of the work had Android 14 prerequisite permissions that were revoked. (b/333957914)
Version 2.9.0
November 29, 2023
androidx.work:work-*:2.9.0
is released. Version 2.9.0 contains these commits.
Important changes since 2.8.0
- Observability via
Flow
-s. Instead ofLiveData
, Worker's progress now can be observed via Flow’s viaWorkManager.getWorkInfosFlow
and similar methods. - Now
WorkManager
provides a hint on why a worker was previously stopped. It can be queried from a worker itself viagetStopReason()
method or fromWorkInfo
viagetStopReason()
. - Precise scheduling of periodic workers via
setNextScheduleTimeOverride
. This allows dynamic calculation of the next Periodic work schedule, which can be used to implement advanced features like adaptive refresh times, custom retry behavior, or making a newsfeed worker run before the user wakes up every morning without drift.ExistingPeriodicWorkPolicy.UPDATE
should be used with these techniques to avoid canceling a currently-running worker while scheduling the next one. - WorkManager’s testing with threading matching production.
ExecutorsMode.PRESERVE_EXECUTORS
can be used ininitializeTestWorkManager
to preserve executors set inConfiguration
and to use the real main thread. - Coroutines APIs such as
CoroutineWorker
have been moved from additional artifact work-runtime-ktx to the main artifact work-runtime. work-runtime-ktx is now empty.
API Changes
stopReason
was added toWorkInfo
. It makesstopReason
available after the worker has run. It could be helpful in the reportingstopReason
in a usable way, because once a worker has been stopped, an app itself could be killed very quickly. (I21386)- Allow
Clock
to be set via config and used to drive execution sequencing of Worker tests. (Ic586e) getStopReason()
method was added toListenableWorker
that gives a hint why the worker was stopped. (I07060)- Added
WorkManagerTestInitHelper#closeWorkDatabase()
to avoid Closeguard's warning about leaked resources. (Ia8d49) WorkInfo
's constructor is public now, which can be useful in testing. (Ia00b6, b/209145335)work-runtime-ktx
is now empty,CoroutineWorker
and other Kotlin specific utilities are now available in the main work-runtime artifact. (I71a9a)- Added
setNextScheduleTimeOverride
method, which allows accurate setting of periodic work schedules (I3b4da) - Added
getNextScheduleTimeMillis
to get scheduled run time info is added toWorkInfo
. (I797e4) - Initial delay and periodicity info are added to
WorkInfo
. (I52f2f) - Added method observe workers via Flows via methods
getWorkInfosByTagFlow
,getWorkInfoByIdFlow
,getWorkInfosForUniqueWorkFlow
,getWorkInfosFlow
(If122a) - Added missing
@RequiresApi(...)
annotations toConstraints
' constructors and properties. They are now aligned with corresponding annotations on setters inConstraints.Builder
that existed from early versions ofWorkManager
. (I6d7d2) WorkManager
now has a separate limit for content uri workers to give them guaranteed slots inJobScheduler
to prevent missing content updates under the high load. The limit can be configured viaConfiguration.Builder.setContentUriTriggerWorkersLimit
. (Ic128f)- Constraints are added to
WorkInfo
. (I162c0)
Version 2.9.0-rc01
October 18, 2023
androidx.work:work-*:2.9.0-rc01
is released. Version 2.9.0-rc01 contains these commits.
- No changes since the last beta release
Version 2.9.0-beta01
September 6, 2023
androidx.work:work-*:2.9.0-beta01
is released. Version 2.9.0-beta01 contains these commits.
API Changes
- Added constants for stop reasons returned by
WorkInfo.stopReason
andListenableWorker.stopReason
(I0cc00)
Version 2.9.0-alpha02
July 26, 2023
androidx.work:work-*:2.9.0-alpha02
is released. Version 2.9.0-alpha02 contains these commits.
New Features
- Now
WorkManager
provides a hint on why a worker was previously stopped. It can be queried from a worker itself viagetStopReason()
method or fromWorkInfo
viagetStopReason()
.
API Changes
stopReason
was added toWorkInfo
. It makes availablestopReason
after the worker ran. It could be helpful in the reportingstopReason
in usable way, because once a worker has been stopped, an app itself could be very quickly killed. (I21386)- Allow Clock to be set via config and used to drive execution sequencing of Worker tests. (Ic586e)
getStopReason()
method was added toListenableWorker
that gives a hint why the worker was stopped. (I07060)- Added
WorkManagerTestInitHelper#closeWorkDatabase()
to avoid Closeguard's warning about leaked resources. (Ia8d49)
Bug Fixes
- Added ability to bypass
overrideNextScheduleTime
usingTestDriver
and fixed issues with testability. (Ic2905)
Version 2.9.0-alpha01
June 7, 2023
androidx.work:work-*:2.9.0-alpha01
is released. Version 2.9.0-alpha01 contains these commits.
New Features
- Observability via
Flow
-s. Instead ofLiveData
, Worker's progress now can be observed via Flow’s viaWorkManager.getWorkInfosFlow
and similar methods. - Precise scheduling of periodic workers via
setNextScheduleTimeOverride
. This allows dynamic calculation of the next Periodic work schedule, which can be used to implement advanced features like adaptive refresh times, custom retry behavior, or making a newsfeed worker run before the user wakes up every morning without drift.ExistingPeriodicWorkPolicy.UPDATE
should be used with these techniques to avoid cancelling a currently-running worker while scheduling the next one. WorkManager
’s testing with threading matching production.ExecutorsMode.PRESERVE_EXECUTORS
can be used to preserve executors set inConfiguration
and to use the real main thread.- Coroutines APIs such as
CoroutineWorker
have been moved from additional artifactwork-runtime-ktx
to the main artifactwork-runtime
.work-runtime-ktx
is now empty.
API Changes
WorkInfo
's constructor is public now, that can be useful in testing. (Ia00b6, b/209145335)work-runtime-ktx
is now empty,CoroutineWorker
and other kotlin specific utilities are now available in the mainwork-runtime
artifact. (I71a9a)- Added
setNextScheduleTimeOverride
method, which allows accurate setting of periodic work schedules (I3b4da) - Renamed
getEarliestRunTimeMillis
togetNextScheduleTimeMillis
. (I2bd7a) - Next scheduled run time info is added to
WorkInfo
. (I797e4) - Initial delay and periodicity info are added to
WorkInfo
. (I52f2f) - Added method observe workers via Flows via methods
getWorkInfosByTagFlow
,getWorkInfoByIdFlow
,getWorkInfosForUniqueWorkFlow
,getWorkInfosFlow
(If122a) - Added missing
@RequiresApi(...)
annotations to Constraints' constructors and properties. They are now aligned with corresponding annotations on setters inConstraints.Builder
that existed from early versions ofWorkManager
. (I6d7d2) WorkManager
now has a separate limit for content uri workers to give them guaranteed slots inJobScheduler
to prevent missing content updates under the high load. Limit can be configured viaConfiguration.Builder.setContentUriTriggerWorkersLimit
. (Ic128f)- Constraints are added to
WorkInfo
. (I162c0)
Version 2.8
Version 2.8.1
March 22, 2023
androidx.work:work-*:2.8.1
is released. Version 2.8.1 contains these commits.
Bug Fixes
- Fixed ANR in
RescheduleReceiver
that previously didn’t correctly handle two simultaneous broadcasts. (b/236906724)
Version 2.8.0
February 8, 2023
androidx.work:work-*:2.8.0
is released. Version 2.8.0 contains these commits.
Important changes since 2.7.0
New Features
- An ability to update
WorkRequests
in a non-intrusive way was added, preserving original enqueue time, chaining etc. See detailed blogpost about this feature, as well as javadocs forWorkManager.updateWork
andExistingPeriodicWorkPolicy.UPDATE
for more details.
API Changes
WorkManager.updateWork
was added to update work preserving its original enqueue time and chaining.(I9a248, b/219446409)ExistingPeriodicWorkPolicy.UPDATE
was added. This policy allows updating a periodic work by the name. It is similar to the existingREPLACE
, but it is less intrusive: it doesn't cancel a worker if it is currently running and it preserves enqueue time - initial delay and period are calculated from original enqueue time, rather than update time.REPLACE
was deprecated to decrease a confusion between the very similarly namedREPLACE
andUPDATE
. If you still want to keep the previous semantics ofREPLACE
, the newly addedCANCEL_AND_REENQUEUE
, which is identical toREPLACE
, can be used. (I985ed, b/219446409)- Added the ability to intercept scheduling exceptions providing
Consumer<Throwable>
via setSchedulingExceptionHandler) - Added the ability to provide
Consumer<Throwable>
via setInitializationExceptionHandler to determine if there were issues when trying to initialize WorkManager. - Inline helpers for
OneTimeWorkRequest
&PeriodicWorkRequest
were moved fromandroidx.work:work-runtime-ktx
toandroidx.work:work-runtime
(I0010f, b/209145335) - Helper methods
WorkQuery.fromIds
,WorkQuery.fromStates
,WorkQuery.fromUniqueWorkNames
,WorkQuery.fromTags
were added to createWorkQuery
directly. (b/199919736) (If48f2, b/199919736) - Added
getForegroundInfo
toWorker
. (Ic1ead) RxWorker
both for RxJava 2 and RxJava 3 now hassetForeground
returningCompletable
that can be used instead ofsetForegroundInfoAsync
that returnsListenableFuture
RxWorker
both for RxJava 2 and RxJava 3 hasgetForegroundInfo
returningSingle
that can be used instead ofgetForegroundInfoAsync
that returnsListenableFuture
. (b/203851459)- Constraints can now be directly constructed rather than using
Constraints.Builder
, which is convenient for Kotlin users. (Idc390, b/137568653) - Added the ability to check if
WorkManager
has been initialized. Also, added a newgetConfiguration()
API for library developers to get the configuration thatWorkManager
was initialized with. (I6eff3, b/212300336)
Bug Fixes
- Fixed an issue with the greedy scheduler that would prevent workers from running immediately when under load. (I9686b, b/248111307)
- Added
@RequiresPermission
to APIs that require granting thePOST_NOTIFICATIONS
permission on SDK 33 and above. (Ie542e, b/238790278) - Propagate cancellations in the
CoroutineScope
to theListenableFuture
when usingsuspendCancellableCoroutine
.
Version 2.8.0-rc01
December 7, 2022
androidx.work:work-*:2.8.0-rc01
is released. Version 2.8.0-rc01 contains these commits.
New Features
- No new features on this release. This is mainly a version bump
Version 2.8.0-beta02
November 9, 2022
androidx.work:work-*:2.8.0-beta02
is released. Version 2.8.0-beta02 contains these commits.
Bug Fixes
- Fixed
equals
method inWorkInfo
, that previously didn’t take into account new generation information. (4977cc)
Version 2.8.0-beta01
October 5, 2022
androidx.work:work-*:2.8.0-beta01
is released. Version 2.8.0-beta01 contains these commits.
Bug Fixes
- Fixed an issue with the greedy scheduler that would prevent workers from running immediately when under load. (I9686b, b/248111307)
Version 2.8.0-alpha04
September 7, 2022
androidx.work:work-*:2.8.0-alpha04
is released. Version 2.8.0-alpha04 contains these commits.
API Changes
WorkerInfo.getGeneration()
andWorkerParameters.getGeneration()
were added that return the generation of a worker. A worker has multiple generations, if it was updated viaWorkManager.updateWork
orWorkManager.enqueueUniquePeriodicWork
usingExistingPeriodicWorkPolicy.UPDATE
. Note that If the worker is currently running, it is possible for this method to return a newer generation from that of the currently running worker if an update has happened during an execution of the worker. (I665c5, b/219446409) (I128a9, b/219446409)- Added
InitializationExceptionHandler
, an Exception Handler that can be used to determine if there were issues when trying to initializeWorkManager
. (I061de)
Version 2.8.0-alpha03
August 10, 2022
androidx.work:work-*:2.8.0-alpha03
is released. Version 2.8.0-alpha03 contains these commits.
New Features
- An ability to update
WorkRequests
in a non-intrusive way was added, preserving original enqueue time, chaining etc. SeeWorkManager.updateWork
andExistingPeriodicWorkPolicy.UPDATE
for more details.
API Changes
WorkManager.updateWork
was added to update work preserving its original enqueue time and chaining.(I9a248, b/219446409)ExistingPeriodicWorkPolicy.UPDATE
was added. This policy allows to update a periodic work by the name. It is similar to the existingREPLACE
, but it is less intrusive: it doesn't cancel a worker if it is currently running and it preserves enqueue time - initial delay and period are calculated from original enqueue time, rather than update time.REPLACE
was deprecated to decrease a confusion between very similarly namedREPLACE
andUPDATE
. If you still want to keep the previous semantics ofREPLACE
, the newly addedCANCEL_AND_REENQUEUE
, which is identical toREPLACE
, can be used. (I985ed, b/219446409)- Add the ability to intercept scheduling exceptions by defining a
SchedulingExceptionHandler
. (I033eb) - Inline helpers for
OneTimeWorkRequest
&PeriodicWorkRequest
were moved fromandroidx.work:work-runtime-ktx
toandroidx.work:work-runtime
(I0010f, b/209145335)
Bug Fixes
- Added
@RequiresPermission
to APIs that require granting the POST_NOTIFICATIONS permission on SDK 33 and above. (Ie542e, b/238790278)
Version 2.8.0-alpha02
April 6, 2022
androidx.work:work-*:2.8.0-alpha02
is released. Version 2.8.0-alpha02 contains these commits.
API Changes
- Constraints can now be directly constructed rather than using Builder, which is convenient for Kotlin users. (Idc390, b/137568653)
- Added the ability to check if
WorkManager
has been initialized. Also, added a newgetConfiguration()
API for library developers to get the configuration thatWorkManager
was initialized with. (I6eff3, b/212300336)
Version 2.8.0-alpha01
January 12, 2022
androidx.work:work-*:2.8.0-alpha01
is released. Version 2.8.0-alpha01 contains these commits.
API Changes
- Helper methods
WorkQuery.fromStates
,WorkQuery.fromUniqueWorkNames
,WorkQuery.fromTags
were added to create WorkQuery directly. (If48f2, b/199919736) - Adds experimental BuildCompat methods for future SDKs (Iafd82, b/207528937)
- Add
getForegroundInfo
toWorker
. (Ic1ead) - Helper methods
WorkQuery.fromIds
to create WorkQuery directly from ids were added. (Ie5bdf, b/199919736) - RxWorker now has
setForeground
returningCompletable
that can be used instead ofsetForegroundInfoAsync
that returnsListenableFuture
. (I85156) - RxWorker for RxJava 2 now has
getForegroundInfo
returningSingle
that can be used instead ofgetForegroundInfoAsync
that returnsListenableFuture
. (I21c91, b/203851459) - RxWorker for RxJava 3 now has
getForegroundInfo
returningSingle
that can be used instead ofgetForegroundInfoAsync
that returnsListenableFuture
. (I1ca8a) - RxWorker now has
setForeground
returningCompletable
that can be used instead ofsetForegroundInfoAsync
that returnsListenableFuture
. (I992a3, b/203851459)
Bug Fixes
- Propagate cancellations in the
CoroutineScope
to theListenableFuture
when usingsuspendCancellableCoroutine
. (I77e63)
Version 2.7
Version 2.7.1
November 17, 2021
androidx.work:work-*:2.7.1
is released. Version 2.7.1 contains these commits.
Bug Fixes
- Cancellations in the
CoroutineScope
are propagated to theListenableFuture
when usingsuspendCancellableCoroutine
. (I77e63) - An exception is thrown immediately when delayed work requests are marked as expedited. bef1762
Version 2.7.0
October 13, 2021
androidx.work:work-*:2.7.0
is released. Version 2.7.0 contains these commits.
Important changes since 2.6.0
WorkManager introduces a new
WorkRequest.Builder.setExpedited(...)
API to help with Foreground Service restrictions in Android 12.When using
setExpedited(...)
, WorkManager delegates to expedited jobs in JobScheduler starting Android 12, while providing backwards compatibility on prior versions of Android by delegating to a Foreground Service.
Version 2.7.0-rc01
September 29, 2021
androidx.work:work-*:2.7.0-rc01
is released. Version 2.7.0-rc01 contains these commits.
This version is identical to androidx.work:work-*:2.7.0-beta01
.
Version 2.7.0-beta01
September 1, 2021
androidx.work:work-*:2.7.0-beta01
is released. Version 2.7.0-beta01 contains these commits.
New Features
- Reduce multi-process SQLite contention when initializing WorkManager.
API Changes
- Remove
@ExperimentalExpeditedWork
APIs given the underlying platform APIs for Android 12 (S) are stable. (aosp/1792806)
Bug Fixes
- Provide a better error message for expedited workers that do not implement
getForegroundInfoAsync()
. (aosp/1809376)
Version 2.7.0-alpha05
July 21, 2021
androidx.work:work-*:2.7.0-alpha05
is released. Version 2.7.0-alpha05 contains these commits.
This release also contains bug fixes from the WorkManager 2.6.0-beta02
release.
Version 2.7.0-alpha04
June 2, 2021
androidx.work:work-*:2.7.0-alpha04
is released.
This release also contains the changes from the 2.6.0-beta01 release.
API Changes
ListenableWorker.setForegroundAsync()
is no longer deprecated.- We recommend using
WorkRequest.Builder.setExpedited(...)
API when possible. To better support situations when the app is not subject to foreground service restrictions, developers can use theListenableWorker.setForegroundAsync()
API. - If
ListenableWorker.setForegroundAsync()
is called, when the app is subject to foreground service restrictions, this will throw the ForegroundServiceStartNotAllowedException.
Bug Fixes
- When expedited jobs are rescheduled, they are no longer expedited. They become regular jobs.
Version 2.7.0-alpha03
April 21, 2021
androidx.work:work-*:2.7.0-alpha03
is released. Version 2.7.0-alpha03 contains these commits.
New Features
From WorkManager
2.6.0-alpha02
: Adds support for Workers that can run in any process. (Iaf200)From WorkManager
2.6.0-alpha02
: Added aRemoteCoroutineWorker
which is an implementation ofRemoteListenableWorker
that can bind to a remote process. (I30578)
API Changes
- From WorkManager
2.6.0-alpha02
:Added support forTEMPORARILY_UNMETERED
network constraint. (I08d5e) - From WorkManager
2.6.0-alpha02
:Multi-process worker support forsetProgressAsync()
. (Ib6d08) - From WorkManager
2.6.0-alpha02
:MakeWorkManagerInitializer
public so otherandroidx.startup.Initializer
s can use these as dependencies. (I5ab11)
Version 2.7.0-alpha02
March 10, 2021
androidx.work:work-*:2.7.0-alpha02
is released. Version 2.7.0-alpha02 contains these commits.
Bug Fixes
- Make
PendingIntent
mutability explicit, to fix a crash when targeting Android 12. (b/180884673)
Version 2.7.0-alpha01
February 18, 2021
androidx.work:work-*:2.7.0-alpha01
is released. Version 2.7.0-alpha01 contains these commits.
New Features
WorkManager introduces a new
WorkRequest.Builder.setExpedited(...)
API to take into account the foreground Service restrictions in Android 12.Applications can no longer launch a foreground service when they are in the background. Therefore, to better support long running work which was previously bound to the lifecycle of a foreground service, applications can mark
WorkRequest
s as expedited.This API is a replacement for the
setForegroundAsync(...)
/setForeground(...)
APIs which are now deprecated.When using
setExpedited(...)
, WorkManager delegates to expedited jobs inJobScheduler
starting Android 12, while providing backwards compatibility on prior versions of Android by delegating to foreground services,
API Changes
- Add support for expedited
WorkRequest
s.
Version 2.6.0
Version 2.6.0
September 1, 2021
androidx.work:work-*:2.6.0
is released. Version 2.6.0 contains these commits.
Important changes since 2.5.0
WorkManager now uses
androidx.startup
to initialize WorkManager. If you usedtools:node="remove"
theContentProvider
being used to initialize WorkManager in the past, then you need to do the following instead.<provider android:name="androidx.startup.InitializationProvider" android:authorities=\"${applicationId}.androidx-startup" android:exported="false" tools:node=\"merge"> <!-- If you are using androidx.startup to initialize other components --> <meta-data android:name="androidx.work.WorkManagerInitializer" android:value="androidx.startup" tools:node="remove" /> </provider>
<!-- If you want to disable android.startup completely. --> <provider android:name="androidx.startup.InitializationProvider" android:authorities="${applicationId}.androidx-startup" tools:node="remove" />
Added support for Workers that can run in any process. (Iaf200)
Added a
RemoteCoroutineWorker
which is an implementation of RemoteListenableWorker that can bind to a remote process. (I30578)
Version 2.6.0-rc01
August 4, 2021
androidx.work:work-*:2.6.0-rc01
is released. Version 2.6.0-rc01 contains these commits.
This version is identical to androidx.work:work-*:2.6.0-beta02
.
Version 2.6.0-beta02
July 21, 2021
androidx.work:work-*:2.6.0-beta02
is released. Version 2.6.0-beta02 contains these commits.
Bug Fixes
RemoteWorkManager
now correctly unbinds fromRemoteWorkManagerService
which allowsRemoteWorkManagerService
to clean up correctly. aosp/1730694RemoteListenableWorker
now correctly unbinds fromRemoteWorkerService
which allowsRemoteWorkerService
to clean up correctly. aosp/1743817ForceStopRunnable
now only runs in the primary app process. This is an optimization, and avoids resource contention for apps that use multiple processes. aosp/1749180, aosp/1761729
Version 2.6.0-beta01
June 2, 2021
androidx.work:work-*:2.6.0-beta01
is released. Version 2.6.0-beta01 contains these commits.
This release contains some minor documentation improvements. The release is largely identical to 2.6.0-alpha02.
Version 2.6.0-alpha02
April 21, 2021
androidx.work:work-*:2.6.0-alpha02
is released. Version 2.6.0-alpha02 contains these commits.
New Features
Adds support for Workers that can run in any process. (Iaf200)
Added a
RemoteCoroutineWorker
which is an implementation ofRemoteListenableWorker
that can bind to a remote process. (I30578)
API Changes
- Added support for
TEMPORARILY_UNMETERED
network constraint. (I08d5e) - Multi-process worker support for
setProgressAsync()
. (Ib6d08) - Make
WorkManagerInitializer
public so otherandroidx.startup.Initializer
s can use these as dependencies. (I5ab11)
Version 2.6.0-alpha01
March 24, 2021
androidx.work:work-*:2.6.0-alpha01
is released. Version 2.6.0-alpha01 contains these commits.
New Features
WorkManager
now usesandroidx.startup
to initialize WorkManager. Previously, this was being done byandroidx.work.impl.WorkManagerInitializer
. (aosp/1608813)If you used
tools:node="remove"
theContentProvider
being used to initialize process lifecycle in the past, then you need to do the following instead.<provider android:name="androidx.startup.InitializationProvider" android:authorities=\"${applicationId}.androidx-startup" android:exported="false" tools:node=\"merge"> <!-- If you are using androidx.startup to initialize other components --> <meta-data android:name="androidx.work.impl.WorkManagerInitializer" android:value="androidx.startup" tools:node="remove" /> </provider>
(or)
<!-- If you want to disable android.startup completely. --> <provider android:name="androidx.startup.InitializationProvider" android:authorities="${applicationId}.androidx-startup" tools:node="remove"> </provider>
API Changes
- Add a
Result.getOutputData()
API which returns the ListenableWorker'soutputData
. (Ie51e3)
Bug Fixes
- Add a workaround for an OEM bug which causes a
SecurityException
to be thrown when usingAlarmManager
APIs. (aosp/1587518)
Version 2.5.0
Version 2.5.0
January 27, 2021
androidx.work:work-*:2.5.0
is released. Version 2.5.0 contains these commits.
Major changes since 2.4.0
- A new
:work:work-multiprocess
artifact for apps that use multiple processes. This introduces performance gains by unifying work request scheduling to a single process.- To use
work-multiprocess
, define a dependency on:implementation "androidx.work:work-multiprocess:2.5.0"
- Designate a primary process using Configuration.Builder.setDefaultProcessName(String).
- When using
work-multiprocess
you also want to use RemoteWorkManager to manage yourWorkRequest
s. RemoteWorkManager always reaches out to the designated process. The in-process scheduler also runs in the designated process.
- To use
- Sometimes,
ActivityManager
cannot instantiate theJobService
instance, to start a job. This causes the underlying job to get silently dropped because of a platform bug.WorkManager
now ensures that there are backing jobs for every singleWorkRequest
when anApplication
is being initialized by reconciling jobs. This greatly improves job execution reliability. (b/172475041, aosp/1489577) WorkManager
limits database growth by reducing the buffer duration thatWorkRequest
s are tracked after aWorkRequest
is complete. The duration was7
days previously. It has been reduced to1
day + the keepResultsForAtLeast duration. (aosp/1419708)- The
TestListenableWorkerBuilder
now supports the reified class extendingListenableWorker
to make testing easier. (aosp/1443299, b/169787349) - WorkManager inspector is now available when using Android Studio Arctic Fox.
Version 2.5.0-rc01
January 13, 2021
androidx.work:work-*:2.5.0-rc01
is released. Version 2.5.0-rc01 contains these commits.
Bug Fixes
- Fixed a bug where
getWorkInfosLiveData
was not correctly getting invalidated after entities were updated when using theWorkQuery
based API. (aosp/1540566, b/173769028) - Fixed a bug where database transactions were not being marked as successful in some rare cases. This causes issues on some Motorola devices. (aosp/1535368, b/175944460)
- Fixed a bug to ignore
NoSuchElementException
s when trying to unbind from a dead process. (aosp/1530589) - Improve
ConstraintTrackingWorker
to only stop aListenableWorker
if it's not already been stopped. (aosp/1496844, b/172946965) - Update androidx.work libraries to target Java 8 (Ibd2f2)
Version 2.5.0-beta02
December 2, 2020
androidx.work:work-*:2.5.0-beta02
is released. Version 2.5.0-beta02 contains these commits.
Bug Fixes
- Fixed a bug in
androidx.work:work-multiprocess
where WorkManager inadvertently blocked the calling thread when trying to bind to the designated process. (aosp/1475538) - Fixed a bug where
PeriodicWorkRequest
s were not being reconciled correctly. (b/172475041, aosp/1489577) - Added a workaround for a platform bug when stopping the foreground service when using the
setForeground*
APIs. (b/170924044, aosp/1489901)
Version 2.5.0-beta01
October 28, 2020
androidx.work:work-*:2.5.0-beta01
is released. Version 2.5.0-beta01 contains these commits.
New Features
WorkManager
automatically throttles the number ofWorkRequest
s that can be picked up by the in-process scheduler. The requests are still executed in FIFO order. (aosp/1455228)WorkManager
attempts to recover when the application’s datastore is in a bad state. (aosp/1463103)
Bug Fixes
- When
ListenableWorker
s are interrupted, mark themENQUEUED
immediately so they can be subsequently rescheduled. (aosp/1455618, b/170273988)
Version 2.5.0-alpha03
October 14, 2020
androidx.work:work-*:2.5.0-alpha03
is released. Version 2.5.0-alpha03 contains these commits.
API Changes
TestListenableWorkerBuilder
andTestWorkerBuilder
do not use raw types. (I883ad, b/169787349)
Bug Fixes
- Use
ApplicationInfo
to determine the name of the default app process. (b/168716641, aosp/1429950) - Fix the visibility rules for
RemoteWorkManager
andRemoteWorkContinuation
. These APIs are no-longer marked as@Restricted
. (aosp/1432091) - Fix proguard rules for
:work:work-multiprocess
. (aosp/1432091) - Improve notification lifecycles for long running work bound to a foreground service. (b/168502234, aosp/1431331)
Version 2.5.0-alpha02
September 16, 2020
androidx.work:work-*:2.5.0-alpha02
is released. Version 2.5.0-alpha02 contains these commits.
New Features
- Add an API to WorkQuery to be able to use
id
s to queryWorkInfo
s. (aosp/1412372, b/157335295) - WorkManager better supports apps that use multiple processes with a new artifact (
androidx.work:work-multiprocess:*
). This new artifact helps solve a few problems that large apps encounter including:- WorkManager typically needs to be initialized in every app process. This is not great because there is increased SQLite contention which in turn causes other problems. WorkManager now has new APIs which can be used to designate a primary app process using
Configuration#setDefaultProcessName(processName)
. TheprocessName
is a fully qualified process name which looks likepackageName:processName
(e.g.com.example:remote
). - A set of new APIs:
RemoteWorkManager
andRemoteWorkContinuation
toenqueue
,cancel
andquery
work requests. These APIs do not includeLiveData
variants to avoid SQLite contention across multiple-processes. All calls toenqueue
,cancel
andquery
are forwarded to aprimary
app process using AIDL and return a fluentListenableFuture
. (aosp/1392657, aosp/1411210, aosp/1412215, aosp/1417713)
- WorkManager typically needs to be initialized in every app process. This is not great because there is increased SQLite contention which in turn causes other problems. WorkManager now has new APIs which can be used to designate a primary app process using
API Changes
- WorkManager now prunes completed
WorkRequest
s that have no incomplete dependencies more aggressively. The buffer duration changed from7
days to1
day. (aosp/1419708)
Bug Fixes
- WorkManager now reconciles jobs proactively so
WorkRequest
s andJobScheduler
jobs are in sync whenWorkManager
is initialized. (aosp/1412794, b/166292069)
Version 2.5.0-alpha01
August 19, 2020
androidx.work:work-*:2.5.0-alpha01
is released. Version 2.5.0-alpha01 contains these commits.
New Features
- Changes to internal APIs that allow us to provide better tooling with
WorkManager
going forward. Stay tuned for additional updates.
Bug Fixes
- Handle
SecurityException
s when tracking network state on some devices. (aosp/1396969)
External Contribution
- Fix documentation for
ArrayCreatingInputMerger
by Zac Sweers (github/43).
Version 2.4.0
Version 2.4.0
July 22, 2020
androidx.work:work-*:2.4.0
is released. Version 2.4.0 contains these commits.
Major changes since 2.3.0
WorkManager
s in-process scheduler is now more capable. Previously, the in-processScheduler
would only consider executing work that was not delayed and whose constraints were met. Now, the in-process scheduler tracksWorkRequest
s which might be executed in the future, including PeriodicWorkRequests. The in-processScheduler
also does not observe scheduling limits (but is still restricted to the size of theExecutor
being used by WorkManager). This means that the application can now execute a lot more WorkRequests when the app is in the foreground. To manage execution of delayed work in the foreground,WorkManager
also introduces a new configurableRunnableScheduler
. (aosp/1185778)- WorkManager now supports RxJava 3. To use RxJava 3, you should include the following dependency:
implementation "androidx.work:work-rxjava3:2.4.0"
. (aosp/1277904) - Added the ability to query for
WorkInfo
s by using aWorkQuery
. This is useful when developers want to queryWorkInfo
s by a combination of multiple attributes. For more information look atWorkQuery.Builder.fromStates(...)
,WorkQuery.Builder. fromTags(...)
orWorkQuery.Builder.fromUniqueWorkNames(...)
. (aosp/1253230, b/143847546) Add the ability to request diagnostic information from
WorkManager
using:adb shell am broadcast -a "androidx.work.diagnostics.REQUEST_DIAGNOSTICS" -p "<your_app_package_name>"
This provides a lot of useful information including:
- WorkRequests that were completed in the last 24 hours.
- WorkRequests that are currently RUNNING.
- Scheduled WorkRequests. (aosp/1235501)
Add
ExistingWorkPolicy.APPEND_OR_REPLACE
which is similar toAPPEND
, but replaces a chain that has cancelled or failed prerequisites. (b/134613984, aosp/1199640)Provide the ability to add a custom
RunnableScheduler
to track WorkRequests that need to be executed in the future. This is used by the in-process Scheduler. (aosp/1203944)Add support for dynamically adding factories to delegate to, when using a
DelegatingWorkerFactory
. (b/156289105, aosp/1309745)Align tracking for
BATTERY_NOT_LOW
constraints more closely with the platform. (aosp/1312583)The in-process scheduler now uses better APIs to determine the name of the process. This is useful to better support apps that use multiple-processes. (aosp/1324732)
New Lint rules which enforce:
- Use of the right
foregroundServiceType
when usingsetForegroundAsync()
APIs. (b/147873061, aosp/1215915) - Specifying JobScheduler ids that WorkManager should use when using JobService APIs directly. aosp/1223567
- Added a new lint rule that ensures that
ListenableWorker
implementations are nowpublic
when using the defaultWorkerFactory
. (aosp/1291262)
- Use of the right
Calls to
setForegroundAsync()
that do not complete before completion of aListenableWorker
will now be signalled via anIllegalStateException
on the returnedListenableFuture
. (aosp/1262743)Fix a bug where the
ForegroundService
is not stopped after a foregroundWorker
is interrupted. (b/155579898, aosp/1302153)Fix a bug where
WorkManager
attempts to execute multiple instances of aWorker
bound to a Foreground Service (b/156310133, aosp/1309853)
Version 2.4.0-rc01
June 24, 2020
androidx.work:work-*:2.4.0-rc01
is released. Version 2.4.0-rc01 contains these commits.
Bug Fixes
- The in-process scheduler now uses better APIs to determine the name of the process. This is useful to better support apps that use multiple-processes. (aosp/1324732)
Version 2.4.0-beta01
May 20, 2020
androidx.work:work-gcm:2.4.0-beta01
, androidx.work:work-runtime:2.4.0-beta01
, androidx.work:work-runtime-ktx:2.4.0-beta01
, androidx.work:work-rxjava2:2.4.0-beta01
, and androidx.work:work-testing:2.4.0-beta01
are released. Version 2.4.0-beta01 contains these commits.
Bug Fixes
- Fix a bug where the
ForegroundService
is not stopped after a foregroundWorker
is interrupted. (b/155579898, aosp/1302153) - Fix a bug where
WorkManager
attempts to execute multiple instances of aWorker
bound to a Foreground Service (b/156310133, aosp/1309853) - Add support for dynamically adding factories to delegate to, when using a
DelegatingWorkerFactory
. (b/156289105, aosp/1309745) - Align tracking for
BATTERY_NOT_LOW
constraints more closely with the platform. (aosp/1312583)
Version 2.4.0-alpha03
April 29, 2020
androidx.work:work-*:2.4.0-alpha03
is released. Version 2.4.0-alpha03 contains these commits.
New Features
- WorkManager now supports RxJava 3. To use RxJava 3, you should include the following dependency:
implementation "androidx.work:work-rxjava3:2.4.0-alpha03"
. (aosp/1277904) - Added a new lint rule that ensures that
ListenableWorker
implementations are nowpublic
when using the defaultWorkerFactory
. (aosp/1291262)
API Changes
- Calling
setProgressAsync()
after aListenableWorker
has finished execution will now signal anException
via theListenableFuture
. (aosp/1285494) WorkQuery.Builder
is now markedfinal
. (aosp/1275037)WorkQuery.Builder
factory methodswithStates
,withTags
andwithUniqueWorkNames
have been renamed tofromStates
,fromTags
andfromUniqueWorkNames
respectively. (aosp/1280287)
Bug Fixes
- Ignore
SecurityException
s when tracking network state of a device. (b/153246136, aosp/1280813)
Version 2.4.0-alpha02
April 1, 2020
androidx.work:work-*:2.4.0-alpha02
is released. Version 2.4.0-alpha02 contains these commits.
New Features
- Added a new Lint rule that warns when
WorkRequest
s requires bothConstraints.setRequiresCharging(...)
andConstraints.setRequiresDeviceIdle(...)
. Some devices are never charging and idle at the same time. So such requests would run less frequently than expected. (aosp/1253840)
API Changes
Added the ability to query for
WorkInfo
s by using aWorkQuery
. This is useful when developers want to queryWorkInfo
s by a combination of multiple attributes. For more information look atWorkQuery.Builder withStates(...)
,WorkQuery.Builder withTags(...)
orWorkQuery.Builder withUniqueWorkNames(...)
. (aosp/1253230, b/143847546)Calls to
setForegroundAsync()
that do not complete before completion of aListenableWorker
will now be signalled via anIllegalStateException
on the returnedListenableFuture
. (aosp/1262743)
Bug Fixes
- Fixed the lint rule that checks for invalid interval durations for
PeriodicWorkRequest
s. (aosp/1254846, b/152606442)
Version 2.4.0-alpha01
March 4, 2020
androidx.work:work-*:2.4.0-alpha01
is released. Version 2.4.0-alpha01 contains these commits.
New Features
WorkManager
s in-process scheduler is now more capable. Previously, the in-process Scheduler would only consider executing work that was not delayed and whose constraints were met. Now, the in-process scheduler tracksWorkRequest
s which might be executed in the future, includingPeriodicWorkRequest
s. The in-process Scheduler also does not observe scheduling limits (but is still restricted to the size of theExecutor
being used by WorkManager). This means that the application can now execute a lot moreWorkRequest
s when the app is in the foreground. (aosp/1185778)Added the ability to request diagnostic information from WorkManager using
adb shell am broadcast -a "androidx.work.diagnostics.REQUEST_DIAGNOSTICS" -p "<your_app_package_name>"
. This provides a lot of useful information including:- WorkRequests that were completed in the last 24 hours.
- WorkRequests that are currently RUNNING.
- Scheduled WorkRequests. (aosp/1235501)
New Lint rules which enforce:
- Use of the right
foregroundServiceType
when usingsetForegroundAsync()
APIs. (b/147873061, aosp/1215915) - Specifying
JobScheduler
ids thatWorkManager
should use when usingJobService
APIs directly. (aosp/1223567)
- Use of the right
API Changes
Add
ExistingWorkPolicy.APPEND_OR_REPLACE
which is similar toAPPEND
, but replaces a chain that has cancelled or failed prerequisites. (b/134613984, aosp/1199640)Provide the ability to add a custom
RunnableScheduler
to trackWorkRequest
s that need to be executed in the future. This is used by the in-process Scheduler. (aosp/1203944)
Bug Fixes
- Deprecated
setProgress()
inRxWorker
because it previously returned aSingle<Void>
which is an impossible type. Added a new APIsetCompletableProgress()
which returns aCompletable
instead; and added new Lint rules which help migrate to the new APIs. (b/150080946, aosp/1242665)
Version 2.3.4
Version 2.3.4
March 18, 2020
androidx.work:work-*:2.3.4
is released. Version 2.3.4 contains these commits.
Bug Fixes
- Fixed a bug which would cause multiple instances of a long running
Worker
s to run, after exceeding the 10 minute execution window. (aosp/1247484, b/150553353) - Fix for WorkManager’s lint
IssueRegistry
. Thank you @ZacSweers from Slack, for the contribution. (aosp/1217923)
Version 2.3.3
Version 2.3.3
March 4, 2020
androidx.work:work-*:2.3.3
is released. Version 2.3.3 contains these commits.
Bug Fixes
- Fixed a bug where if a
Worker
was interrupted, it would not get rescheduled correctly. (b/150325687, aosp/1246571)
Version 2.3.2
Version 2.3.2
February 19, 2020
androidx.work:work-*:2.3.2
are released. Version 2.3.2 contains these commits.
Bug Fixes
- Fixes an issue where WorkManager exceeds the 100 job limit in JobScheduler in rare cases. (aosp/1226859, b/149092520)
- Fix for a race condition in ConstraintControllers. (aosp/1220100)
- Improved the management foreground Service lifecycle for long running Workers. (aosp/1226295)
- Improved the management of cancellation of Notifications for long running Workers upon Worker cancellation. (aosp/1228346)
Version 2.3.1
Version 2.3.1
February 5, 2020
androidx.work:work-*:2.3.1
is released. Version 2.3.1 contains these commits.
Bug fixes
- Better manage the lifecycle of
Notification
s for long runningWorker
s that run when a foregroundService
is active. (aosp/1218539, b/147249312) WorkManager
now depends onandroidx.sqlite:sqlite-framework:2.1.0
stable. (aosp/1217729)- Added lint rules to ensure that a
foregroundServiceType
is specified in theAndroidManifest.xml
when usingforegroundServiceType
s inForegroundInfo
. (aosp/1214207, b/147873061)
Version 2.3.0
Version 2.3.0
January 22, 2020
androidx.work:work-*:2.3.0
is released with no changes since 2.3.0-rc01
. Version 2.3.0 contains these commits.
Important changes since 2.2.0
- Support for long running or important work via
ListenableWorker#setForegroundAsync()
. - Support for Worker Progress via
ListenableWorker#setProgressAsync()
. - WorkManager now packages additional lint rules as part of the library which helps catch bugs early.
Version 2.3.0-rc01
January 8, 2020
androidx.work:work-*:2.3.0-rc01
is released. Version 2.3.0-rc01 contains these commits.
This release is identical to 2.3.0-beta02
Bug fixes
- The
work-testing
artifact now defines anapi
dependency onwork-runtime-ktx
. (aosp/1194410)
Version 2.3.0-beta02
December 18, 2019
androidx.work:work-*:2.3.0-beta02
is released. Version 2.3.0-beta02 contains these commits.
New features
- Added a better error message for non-recoverable SQLite exceptions. (aosp/1185777)
- Added a lint rule which ensures that the content provider
androidx.work.impl.WorkManagerInitializer
is removed from theAndroidManifest.xml
when using on demand initialization. (aosp/1167007) - Added a lint warning when
enqueue()
is used for aPeriodicWorkRequest
instead ofenqueueUniquePeriodicWork()
. (aosp/1166032)
API changes
ForegroundInfo
now requires you to specify thenotificationId
to be used when usingListenableWorker.setForegroundAsync()
. This is a breaking change. This allows you to run multiple long runningWorker
s in parallel.WorkManager
also better manages lifetimes of the providedNotification
s. (b/145473554, aosp/1181208, asop/1181216, asop/1183577)
Bug fixes
- Fixed a bug in the AlarmManager implementation where alarms were not being cleaned up correctly. (aosp/1156444)
- Fixed a bug where an empty list of
WorkRequest
s would cause an incorrectWorkContinuation
chain to be built. (b/142835274, aosp/1157051)
Dependency changes
- WorkManager now uses Room 2.2.2.
Version 2.3.0-beta01
November 20, 2019
androidx.work:work-*:2.3.0-beta01
is released. Version 2.3.0-beta01 contains these commits.
New features
- Added a new lint rule which prevents developer errors due to incorrect implementation of
androidx.work.Configuration.Provider
when using on-demand initialization. aosp/1164559
Version 2.3.0-alpha03
October 23, 2019
androidx.work:work-*:2.3.0-alpha03
is released. Version 2.3.0-alpha03 contains these commits.
New features
- Added
WorkManager.createCancelPendingIntent()
API which makes it easy to cancelWorkRequest
s without having to register another component in theAndroidManifest.xml
. This API makes it especially easy to cancelWorkRequest
s fromNotification
s. We expect this to be paired with the new foreground APIs in 2.3.0. - WorkManager now depends on
androidx.room:*:2.2.0
stable.
API changes
- Renamed
ForegroundInfo.getNotificationType()
toForegroundInfo.getForegroundServiceType()
to be more consistent with the underlying platform APIs. (b/142729893, aosp/1143316)
Bug fixes
- Fixed a bug which is caused by an unnecessary call to
setTransactionSuccessful()
outside of a transaction. This happens for rare migrations. (b/142580433, aosp/1141737)
Version 2.3.0-alpha02
October 9, 2019
androidx.work:work-*:2.3.0-alpha02
is released. Version 2.3.0-alpha02 contains these commits.
New features
- WorkManager now supports running long running or important work that should be kept alive by the OS. For more information look at
ListenableWorker#setForegroundAsync()
(orCoroutineWorker#setForeground()
for Kotlin). (aosp/1133636)
API changes
- The
containsKey
API inData
is renamed tohasKeyWithValueOfType
. The corresponding extension method in thektx
library has also been renamed. (b/141916545)
Bug fixes
- WorkManager schedules work fairly when the number of
WorkRequest
s enqueued approach scheduling limits. (aosp/1105766) - WorkManager calls
ListenableWorker#onStopped()
only if the work is not already completed. (b/140055777) - WorkManager now removes progress information when a worker gets interrupted or reaches its terminal state. (aosp/1114572)
Data
now has a much more usefultoString()
representation. (b/140945323)Data
now has a betterequals()
method. It also supportsdeepEquals
forArray
types. (b/140922528)- WorkManager now stores its internal database and preference files in a no backup directory. (b/114808216)
Version 2.3.0-alpha01
August 22, 2019
androidx.work:work-*:2.3.September 5, 20190-alpha01
is released. The commits included in this version can be found here.
New features
ListenableWorker
s can now set progress via thesetProgressAsync()
API. Also added a correspondingsuspend
-ingsetProgress
API inCoroutineWorker
and asetProgress
inRxWorker
which returns aSingle<Void>
. With these new APIs Workers can convey progress information viaWorkInfo
which has a correspondinggetProgress
API. (b/79481554)Data
has acontainsKey()
API which can be used to validate that input data toWorker
s has keys with the expected type. (b/117136838)Data
can now be serialized usingData.toByteArray()
andData.fromByteArray()
. Note that there are no versioning guarantees withData
so you should not persist it or use it for IPC between applications. They are only safe to be used between multiple processes of the same application.- Added the ability to specify an
InputMergerFactory
viaConfiguration.setInputMergerFactory
. (b/133273159)
API changes
- WorkManager will throw an instance of
IllegalStateException
if aWorkerFactory
returns an instance ofListenableWorker
which has been previously invoked. (b/139554406) - Documentation updates around
ListenableFuture
cancellation and theonStopped()
callback inListenableWorker
. (b/138413671)
Bug fixes
- The in-process Scheduler now ignores
WorkRequest
s with theidle
constraint. These requests are now only picked up byJobScheduler
when the device is actuallyidle
. (aosp/1089779) TestScheduler
now correctly uses the specifiedExecutor
for its internal task executor in tests. (aosp/1090749)
Version 2.2.0
Version 2.2.0
August 15, 2019
androidx.work:work-*:2.2.0
is released. The commits included in this version can be found here.
This release is identical to androidx.work:work-*:2.2.0-rc01
.
Important Changes in 2.2.0 from 2.1.0
androidx.work:work-gcm:2.2.0
is a new Maven artifact which supports the use of GCMNetworkManager as a scheduler when Google Play Services is available for API levels <= 22. This is an optional dependency that helps with more reliable and performant background processing on older API versions. If your app uses Google Play Services, add this dependency to your gradle file to automatically get GCMNetworkManager support. If Play Services is not available, WorkManager will continue to fall back to AlarmManager on older devices.
Version 2.2.0-rc01
July 30, 2019
androidx.work:work-*:2.2.0-rc01
is released. The commits included in this version can be found here.
Bug fixes
- Fixed a bug in the AlarmManager implementation that causes the Service to shutdown prematurely and resulting in a
RejectedExecutionException
in rare cases. (aosp/1092374) (b/138238197). - Added a workaround for a
NullPointerException
when usingJobScheduler
APIs on some devices. (aosp/1091020) (b/138364061), (b/138441699)
Version 2.2.0-beta02
July 19, 2019
androidx.work:work-*:2.2.0-beta02
is released. The commits included in this version can be found here.
Bug fixes
- Removed unintentional jacoco dependency that was introduced in
2.2.0-beta01
.
Version 2.2.0-beta01
July 17, 2019
androidx.work:work-*:2.2.0-beta01
is released. The commits included in this version can be found here.
New features
androidx.work:work-gcm:2.2.0-beta01
is a new Maven artifact which supports the use of GCMNetworkManager as a scheduler when Google Play Services is available for API levels <= 22. This is an optional dependency that helps with more reliable and performant background processing on older API versions. If your app uses Google Play Services, add this dependency to your gradle file to automatically get GCMNetworkManager support. If Play Services is not available, WorkManager will continue to fall back to AlarmManager on older devices.
Bug fixes
- Fix for
IllegalArgumentException
when tracking network state on Nvidia Shield K1 tablets. (aosp/1010188)
Version 2.1.0
Version 2.1.0
July 11, 2019
androidx.work:work-*:2.1.0
is released. This release is identical to androidx.work:work-*:2.1.0-rc01
.
Important changes since 2.0.1
work-runtime-ktx
now requires Java 8. If you run into any issues, you can add the following to yourbuild.gradle
:kotlinOptions { jvmTarget = "1.8" }
- Added on-demand initialization for WorkManager, which will create WorkManager
only when referenced. b/127497100 To set up your project for on-demand initialization:
- Disable the automatic initializer.
- Implement
Configuration.Provider
on your customApplication
object. - Change all references of
WorkManager.getInstance()
toWorkManager.getInstance(Context)
. As part of this change, we have deprecatedWorkManager.getInstance()
. It is always safer to call the newWorkManager.getInstance(Context)
replacement, even if you're not doing on-demand initialization.
PeriodicWorkRequest
s now support initial delays. You can use thesetInitialDelay
method onPeriodicWorkRequest.Builder
to set an initial delay. b/111404867- Added the ability to delegate to one or more registered
WorkerFactory
s usingDelegatingWorkerFactory
. b/131435993 - Added the ability to customize the
Executor
used by WorkManager for all its internal book-keeping viaConfiguration.Builder.setTaskExecutor
. - Added the ability to create unit testable
Worker
andListenableWorker
classes by usingTestWorkerBuilder
andTestListenableWorkerBuilder
in thework-testing
artifact.- Note that
work-testing
now pulls in Kotlin as a dependency and includes several Kotlin extensions by default.
- Note that
- Added run attempt count to
WorkInfo
. b/127290461 Data
types can now store and retrieve bytes and byte arrays. This does NOT change the maximum size ofData
objects.- WorkManager now depends on
Room 2.1.0
, which should fix some database issues.
Version 2.1.0-rc01
June 27, 2019
androidx.work:work-*:2.1.0-rc01
is released. The commits included in this version can be found here.
Bug fixes
- Fixed a bug which would cause an application to crash when executing jobs with
JobScheduler
while a backup was in progress b/135858602.
Version 2.1.0-beta02
June 20, 2019
androidx.work:work-*:2.1.0-beta02
is released. The commits included in this version can be found here.
Bug fixes
TestListenableWorkerBuilder
now uses the correctWorkerFactory
when creating instances ofListenableWorker
. b/135275844- Fixed a bug which caused drifts in the execution windows for
WorkRequest
s due to process death. b/135272196
Version 2.1.0-beta01
June 13, 2019
androidx.work:work-*:2.1.0-beta01
is released. The commits included in this version can be found here.
Bug fixes
- WorkManager now depends on
Room 2.1.0
, which should fix some database issues. - Removed some startup disk I/O on the main thread.
- Fixed a potential deadlock in constraint tracking. b/134361006
- Preemptively cancelled invalid jobs attributed to WorkManager. b/134058261
- Added some defensive calls to JobScheduler APIs for misbehaving devices.
Version 2.1.0-alpha03
June 5, 2019
androidx.work:*:2.1.0-alpha03
is released.
Bug fixes
- Improved documentation for
PeriodicWorkRequest
s. WorkManagerTestInitHelper
now uses the correct background executor for tests.- Fixes for SQLite issues when dealing with large transactions on some devices. (b/130182503)
- WorkManager’s dependencies are now more granular. (b/133169148).
- Workaround OEM specific bugs in the implementation of
JobScheduler
when scheduling jobs using WorkManager. - Improvements in the AlarmManager based scheduler around service lifetimes that previously caused rare crashes. (b/133313734)
Version 2.1.0-alpha02
May 16, 2019
WorkManager 2.1.0-alpha02 is released. This version contains several new APIs.
API Changes
PeriodicWorkRequest
s now support initial delays. You can use thesetInitialDelay
method onPeriodicWorkRequest.Builder
to set an initial delay. b/111404867Added the ability to delegate to one or more registered
WorkerFactory
s usingDelegatingWorkerFactory
. b/131435993Added the ability to customize the
Executor
used by WorkManager for all its internal book-keeping viaConfiguration.Builder.setTaskExecutor
.Improved documentation around
WorkRequest.keepResultsForAtLeast
(b/130638001), on-demand initialization, andPeriodicWorkRequest.Builder
(b/131711394).
Version 2.1.0-alpha01
April 24, 2019
WorkManager 2.1.0-alpha01 is released. This version contains several new APIs. Please note that starting with this version, there will be new features that won't get backported to the 1.x release. We recommend switching to 2.x.
API Changes
- Added on-demand initialization for WorkManager, which will create WorkManager
only when referenced. b/127497100 To set up your project for on-demand initialization:
- Disable the automatic initializer.
- Implement
Configuration.Provider
on your customApplication
object. - Change all references of
WorkManager.getInstance()
toWorkManager.getInstance(Context)
. As part of this change, we have deprecatedWorkManager.getInstance()
. It is always safer to call the newWorkManager.getInstance(Context)
replacement, even if you're not doing on-demand initialization.
- Added the ability to create unit testable
Worker
andListenableWorker
classes by usingTestWorkerBuilder
andTestListenableWorkerBuilder
in thework-testing
artifact.- Note that
work-testing
now pulls in Kotlin as a dependency, but also includes several Kotlin extensions by default.
- Note that
- Added run attempt count to
WorkInfo
. b/127290461 Data
types can now store and retrieve bytes and byte arrays. This does NOT change the maximum size ofData
objects.- Deprecated
CoroutineWorker.coroutineContext
. This field was incorrectly typed as aCoroutineDispatcher
; you should no longer need it as you can go to the desired coroutineContext yourself in the body of the suspending function. RxWorker.createWork()
andRxWorker.getBackgroundScheduler()
are now annotated with@NonNull
return types.
Version 2.0.1
Version 2.0.1
April 9, 2019
WorkManager 2.0.1 is released. This release is identical to 2.0.1-rc01.
Version 2.0.1-rc01
April 3, 2019
WorkManager 2.0.1-rc01 is released. This version contains some bug fixes. For legacy 1.x users, some of these changes also appear in 1.0.1-rc01.
Bug Fixes
- Robolectric tests now operate properly with WorkManager. b/122553577
- Fixed an edge case crash with constraints tracking not being cleaned up on pre-JobScheduler APIs. b/129226383
- Fixed a
StackOverflowError
dealing with long chains of work. b/129091233 - Updated documentation for
PeriodicWorkRequest
s to indicate that flex time is not supported on API 23. - Fixed some broken links in the Kotlin documentation.
Version 2.0.0
Version 2.0.0
March 20, 2019
WorkManager 2.0.0 is released. This version is identical to 2.0.0-rc01 and is the AndroidX version of 1.0.0 stable with AndroidX dependencies. We recommend targeting this version instead of the legacy 1.x versions. All active development will target 2.x and 1.x will only receive critical bug fixes for a limited time.
Version 2.0.0-rc01
March 7, 2019
WorkManager 2.0.0-rc01 is released. This version is identical to 1.0.0 stable but has AndroidX dependencies. Once this reaches 2.0.0 stable, you should include this version and the legacy 1.x versions will only receive some critical bug fixes. All active development will target 2.x.
Pre-AndroidX Dependencies
Reference docs: Java
Groovy
dependencies { def work_version = "1.0.1" // (Java only) implementation "android.arch.work:work-runtime:$work_version" // Kotlin + coroutines implementation "android.arch.work:work-runtime-ktx:$work_version" // optional - RxJava2 support implementation "android.arch.work:work-rxjava2:$work_version" // optional - Test helpers androidTestImplementation "android.arch.work:work-testing:$work_version" }
Kotlin
dependencies { val work_version = "1.0.1" // (Java only) implementation("android.arch.work:work-runtime:$work_version") // Kotlin + coroutines implementation("android.arch.work:work-runtime-ktx:$work_version") // optional - RxJava2 support implementation("android.arch.work:work-rxjava2:$work_version") // optional - Test helpers androidTestImplementation("android.arch.work:work-testing:$work_version") }
Version 1.0.1
Version 1.0.1
April 9, 2019
WorkManager 1.0.1 is released. This release is identical to 1.0.1-rc01.
Please note that we strongly encourage users to update to WorkManager 2.x, as there will be very few updates to the 1.x branch moving forward. New APIs will also not be released for the 1.x library.
Version 1.0.1-rc01
April 2, 2019
WorkManager 1.0.1-rc01 is released. This version contains some bug fixes.
Bug Fixes
- Robolectric tests now operate properly with WorkManager. b/122553577
- Fixed an edge case crash with constraints tracking not being cleaned up on pre-JobScheduler APIs. b/129226383
- Fixed a
StackOverflowError
dealing with long chains of work. b/129091233
Version 1.0.0
Version 1.0.0
March 05, 2019
This is WorkManager's 1.0.0 stable release. This version of WorkManager is identical to 1.0.0-rc02.
Version 1.0.0-rc02
February 21, 2019
This is the second release candidate for WorkManager's 1.0.0 stable release. This release contains two bug fixes.
Bug Fixes
Worker
s are now correctly scheduled after an application crash. b/124546316Worker
s that throw an uncheckedException
are now correctly marked asFAILED
and no longer crash the app process.
Version 1.0.0-rc01
February 14, 2019
This is a release candidate for WorkManager's 1.0.0 stable release. This release contains one bug fix.
Bug Fixes
- The AlarmManager based implementation now correctly respects
flex
windows for PeriodicWorkRequests. b/124274584
Version 1.0.0-beta05
February 6, 2019
This release contains some bug fixes.
Bug Fixes
- Fixed a case where
JobScheduler.getPendingJob(...)
was used on API 23. b/123893059 - Fixed a
NullPointerException
on devices running Android 5.1 (API level 22) or lower. b/123835104
Version 1.0.0-beta04
February 4, 2019
This release contains some bug fixes.
Bug Fixes
- Improved scheduling of PeriodicWork for the AlarmManager based implementation.
- Fixed a case where WorkManager failed to correctly track constraints when using the AlarmManager based implementation. b/123379508
- Fixed a case when WorkManager failed to retry work on process death when using the AlarmManager based implementation. b/123329850
- Fixed a case which would cause WorkManager to leak Wakelocks when using the AlarmManager based implementation.
Version 1.0.0-beta03
January 25, 2019
This release contains some bug fixes.
Bug Fixes
- We introduced a regression
1.0.0-beta02
that was causing work to not execute properly in some situations. b/123211993 - Fixed a case where work wasn't properly honoring backoff timing. b/122881597
- Fixed a
ConcurrentModificationException
on devices running Android 5.1 (API or) or lower. This is a continuation of the fix in1.0.0-beta02
. b/121345393 - Added
exported=false
for some components in our manifest that were missing this annotation. - Included information about how WorkManager interacts with the OS in the package-level documentation.
Version 1.0.0-beta02
January 15, 2019
This release contains some bug fixes.
Bug Fixes
- Fixed an edge case where periodic work could run more than once per interval on devices running Android 6.0 (API level 23). b/121998363
- Fixed a
ConcurrentModificationException
on devices running Android 5.1 (API level 22) or lower. b/121345393 - Fixed erroneous execution of work when Constraints aren't met on devices running Android 5.1 (API level 22) or lower. b/122578012
- Optimized work completion handling to be faster in some edge cases. b/122358129
- Added a change to address potential race conditions among multiple instances
of
LiveData
that WorkManager uses. - Moved to use
Room
dependency1.1.1
instead of1.1.1-rc01
; these versions are identical. b/122578011
Version 1.0.0-beta01
December 19, 2018
This release contains no API changes; moving forward, WorkManager is expected to stay API stable until the next version unless there is a critical problem. This release contains some bug fixes.
Bug Fixes
- Previously-cancelled children of successfully completed parent work will no longer run. b/120811767
- Properly initialized logging classes (primarily surfaced during tests).
Version 1.0.0-alpha13
December 12, 2018
This release contains a minor API change that will be helpful for some Kotlin users.
API Changes
androidx.work.Result
has been moved to be an inner class ofListenableWorker
. This prevents refactoring conflicts with Kotlin's top-levelResult
class. This is a breaking API change. b/120564418
Breaking API Changes
androidx.work.Result
has been moved to be an inner class ofListenableWorker
.
Version 1.0.0-alpha12
December 5, 2018
This release contains some breaking API changes; please see the Breaking API Changes section below. This version is likely to be released as our first beta. alpha12
also contains extensive documentation updates.
API Changes
- A new artifact,
work-rxjava2
, introducesRxWorker
. This is aListenableWorker
that expects aSingle<Payload>
. - Support for Firebase JobDispatcher has been removed because of its impending deprecation. This means that the
work-firebase
artifact will no longer be updated as we head into beta. We will be looking into adding an alternative in the future. - Combined
Payload
intoResult
.Result
is now a "sealed class" with three concrete implementations, which you can obtain viaResult.success()
(orResult.success(Data)
),Result.failure()
(orResult.failure(Data)
), andResult.retry()
. YourListenableFuture
s now resultResult
instead ofPayload
.Worker
s don't have getter and setter methods for outputData
. This is a breaking change. - Added
Constraints.Builder.setTriggerContentMaxDelay(long, TimeUnit)
andConstraints.Builder.setTriggerContentUpdateDelay(long, TimeUnit)
and variants to better support slow triggering content URIs. b/119919774 - Added
WorkRequest.Builder.setBackoffCriteria(BackoffPolicy, Duration)
variant. This method requires API 26. - Added
Operation.await()
andListenableFuture.await()
Kotlin extension methods. - Renamed
Operation.getException()
toOperation.getThrowable()
. This is a breaking change. - The
ContentUriTriggers
class and methods referencing it are no longer available for public usage. This is a breaking change. - Removed the rest of the varargs methods in
WorkManager
,WorkContinuation
, andOneTimeWorkRequest
to streamline the API. To fix any build problems, you can wrap your existing varargs withArrays.asList(...)
. We still include single-argument versions of each method. This is a breaking change. - Removed
WorkContinuation.combine(OneTimeWorkRequest, *)
variants. They were presenting a confusing API; the existingcombine
methods are more understandable. This is a breaking change.
Bug Fixes
- Pre-Marshmallow implementations are now more reliable in recovering from process death of an already-executing task.
LiveData
that is observed viaobserveForever
is tracked via WorkManager. This is a backport of a Room library fix. b/74477406Data.Builder.build()
now throws an exception if the serialized object exceeds its maximum size. This previously would only happen on a background thread where you couldn't properly handle it.- Further distinguished stopped vs. cancelled work;
getWorkInfoById()
will return aWorkInfo
with theCANCELLED
State
duringListenableWorker.onStopped()
. - Treat
null
Result
s as failures inListenableWorker
. b/120362353 - Speculative fix for Shield Tablets running API 24 that sometimes threw an
IllegalArgumentException
. b/119484416
Breaking API Changes
- Support for Firebase JobDispatcher has been removed because of its impending deprecation. This means that the
work-firebase
artifact will no longer be updated as we head into beta. We will be looking into adding an alternative in the future. - Combined
Payload
intoResult
.Result
is now a "sealed class" with three concrete implementations, which you can obtain viaResult.success()
(orResult.success(Data)
),Result.failure()
(orResult.failure(Data)
), andResult.retry()
. YourListenableFuture
s now resultResult
instead ofPayload
.Worker
s don't have getter and setter methods for outputData
. - Added
Operation.await()
andListenableFuture.await()
Kotlin extension methods. - Renamed
Operation.getException()
toOperation.getThrowable()
. - The
ContentUriTriggers
class and methods referencing it are no longer available for public usage. - Removed the rest of the varargs methods in
WorkManager
,WorkContinuation
, andOneTimeWorkRequest
to streamline the API. To fix any build problems, you can wrap your existing varargs withArrays.asList(...)
. We still include single-argument versions of each method. - Removed
WorkContinuation.combine(OneTimeWorkRequest, *)
variants. They were presenting a confusing API; the existingcombine
methods are more understandable.
Version 1.0.0-alpha11
November 8, 2018
This release contains many changes that will become stable API at beta
.
There are breaking API changes in this release; please see the Breaking API Changes section below.
API Changes
work-runtime-ktx
introduces a newCoroutineWorker
.WorkStatus
has been renamed toWorkInfo
. All correspondinggetStatus
method variants have been renamed to the correspondinggetWorkInfo
variants. This is a breaking change.ListenableWorker.onStopped()
no longer accepts has a boolean argument representing if theWorkRequest
was cancelled.WorkManager
no longer makes this distinction. This is a breaking change.androidx.work.test
package has been renamed toandroidx.work.testing
package. This is a breaking change.- Setters on
Constraints
are no longer a part of the public API. This is a breaking change. WorkerParameters.getTriggeredContentUris()
andWorkerParameters.getTriggeredContentAuthorities()
previously returned arrays. Now these methods return Collections. This is a breaking change.ListenableWorker.onStartWork()
is renamed toListenableWorker.startWork()
. This is a breaking change.- The constructor for
WorkStatus
is no longer a part of the public API. This is a breaking change. Configuration.getMaxJobSchedulerID()
andConfiguration.getMinJobSchedulerID()
are renamed toConfiguration.getMinJobSchedulerId()
andConfiguration.getMaxJobSchedulerId()
respectively. This is a breaking change.- Added a lot of
@NonNull
annotations to the public API to improve ergonomics of the API. - Add
WorkManager.enqueueUniqueWork()
API to enqueue uniqueOneTimeWorkRequest
s without having to create aWorkContinuation
. - All variants of
enqueue
andcancel
methods onWorkManager
now return a newOperation
type. This is a breaking change. - All variants of
enqueue
no longer accept varargs forWorkRequest
s. This is a breaking change. Use Collections instead. You can useArrays.asList()
to modify existing code. We did this to reduce the API surface and method count. - Attempting to
initialize
WorkManager
more than once per process will now result in anIllegalStateException
. This is a breaking change.
Bug Fixes
WorkRequest.Builder
s in thework-runtime-ktx
artifact now useListenableWorker
s. Fixes b/117666259- Ensure the next run time for
PeriodicWork
is in the future. Fixes b/118204399 - Remove potential disk I/O when using WorkManager on app startup. Fixes b/117796731
- Fix a race condition in
WorkConstraintsTracker
. Fixes android-workmanager/issues/56
Breaking API Changes
WorkStatus
has been renamed toWorkInfo
. All correspondinggetStatus
method variants have been renamed to the correspondinggetWorkInfo
variants.ListenableWorker.onStopped()
no longer accepts has a boolean argument representing if theWorkRequest
was cancelled.WorkManager
no longer makes this distinction.androidx.work.test
package has been renamed toandroidx.work.testing
package.- Setters on
Constraints
are no longer a part of the public API. WorkerParameters.getTriggeredContentUris()
andWorkerParameters.getTriggeredContentAuthorities()
previously returned arrays. Now these methods return Collections.ListenableWorker.onStartWork()
is renamed toListenableWorker.startWork()
.- The constructor for
WorkStatus
is no longer a part of the public API. Configuration.getMaxJobSchedulerID()
andConfiguration.getMinJobSchedulerID()
are renamed toConfiguration.getMinJobSchedulerId()
andConfiguration.getMaxJobSchedulerId()
respectively.- All variants of
enqueue
andcancel
methods onWorkManager
now return a newOperation
type. - All variants of
enqueue
no longer accept varargs forWorkRequest
s. - Attempting to
initialize
WorkManager
more than once per process will now result in anIllegalStateException
.
Version 1.0.0-alpha10
October 11, 2018
This release supports developer-controlled asynchronous work. There are breaking API changes in this release; please see the Breaking API Changes section below.
We anticipate that WorkManager is entering the final phases of its alpha period. We expect to be API stable in beta, so please take some time to file your feedback on our issue tracker.
API Changes
- Removed all previously
deprecated
methods and classes, notably the defaultWorker
constructor. This is a breaking API change. - Renamed
NonBlockingWorker
toListenableWorker
, which is now an unhidden public class and ready for usage.ListenableWorker
provides access to one abstract method,ListenableFuture<Payload> onStartWork()
which is called on the main thread. It is up to you to start and process work asynchronously. When finished, you should update theListenableFuture
appropriately. Reference implementations ofListenableFuture
s are provided in theFutures
package inalpha02
(see below theWorkManager
section).Worker
extendsListenableWorker
and still operates as before, with an abstractResult doWork()
method.- Shuffled some methods and members from
Worker
toListenableWorker
. - We shall soon provide reference implementations for
ListenableWorker
s that use Kotlin coroutines (once the stable versions are released) and RxJava2.
- The interface
WorkerFactory
and the concrete implementationDefaultWorkerFactory
have been merged into an abstract class calledWorkerFactory
. The implementation ensures that the default reflection-based behavior is called as a last-ditch effort for any user-createdWorkerFactory
instances. This is a breaking change. - Removed
WorkManager.synchronous()
andWorkContinuation.synchronous()
and all related methods. AddedListenableFuture<Void>
as the return type of many methods in the API. This is a breaking API change.- You can now synchronously get and observe by using
ListenableFuture
s. For example,WorkManager.enqueue()
used to returnvoid
; it now returns aListenableFuture<Void>
. You can callListenableFuture.addListener(Runnable, Executor)
orListenableFuture.get()
to run code once the operation is complete. - Note that these
ListenableFuture
s do not tell you if the operation succeeded or failed; only that they finished. You will still need to chain WorkManager methods to find out this information. - We ignore
cancel()
calls on these objects, as they are confusing and hard to reason about (are you cancelling the operation or the resulting work?). This is within theFuture
s contract. - To maintain parity with the synchronous
getStatus*
methods, we have providedListenableFuture
variants, and renamed the existing ones that returnedLiveData
to explicitly have "LiveData" as part of the name (for example,getStatusesByIdLiveData(UUID)
). This is a breaking API change.
- You can now synchronously get and observe by using
Bug Fixes
- Fixed the known issue from alpha09 regarding duplicate
androidx-annotations.pro
files. You may remove the workaround from the previous release notes by deletingexclude 'META-INF/proguard/androidx-annotations.pro'
from your gradle file. - Added proguard configurations to keep new
Worker
constructor. b/116296569 - Fix potential
NullPointerException
in a race condition where work wasREPLACE
d. b/116253486 and b/116677275 WorkContinuation.combine()
now accepts one or moreWorkContinuation
s instead of two or more. b/117266752
Breaking API Changes
- Removed all previously
deprecated
methods and classes, notably the defaultWorker
constructor. - The interface
WorkerFactory
and the concrete implementationDefaultWorkerFactory
have been merged into an abstract class calledWorkerFactory
. - Removed
WorkManager.synchronous()
andWorkContinuation.synchronous()
. WorkManager.getStatus*()
methods now returnListenableFuture
s.WorkManager.getStatus*LiveData()
returnLiveData
s.
Version 1.0.0-alpha09
September 19, 2018
Known Issue
If you run into the following issue: "More than one file was found with OS independent path 'META-INF/proguard/androidx-annotations.pro'", please put the following in your gradle file as a temporary workaround while we fix the issue in alpha10:
Groovy
android { packagingOptions { exclude 'META-INF/proguard/androidx-annotations.pro' } }
Kotlin
android { packagingOptions { exclude("META-INF/proguard/androidx-annotations.pro") } }
Bug Fixes
- Added another fix that was needed for the "100 jobs" error. b/115560696
- Added some fixes for foreign key constraint errors due to race conditions. b/114705286
- Delegated
ConstraintTrackingWorker.onStopped(boolean)
calls to the underlyingWorker
. b/114125093 - Enforce correct minimum backoff delay for Firebase JobDispatcher. b/113304626
- Improved threading guarantees internal to the library.
- Correct potential issue with deduping of
LiveData
internally.
API Changes
- You can now create your own
Worker
instances at runtime by specifying aWorkerFactory
as part of theWorkManager.Configuration
. The fallback factory isDefaultWorkerFactory
, which matches behavior of previous versions of WorkManager.- The default constructors for
Worker
andNonBlockingWorker
are now marked as deprecated. Please use the new constructor (Worker(Context, WorkerParameters)
) and callsuper(Context, WorkerParameters)
; future versions of WorkManager will remove the default constructor.
- The default constructors for
- We have started using the new
ListenableFuture
artifact internally (free of Guava dependencies). We will introduce ListenableFutures to the API in upcoming releases. This change will support the eventual unhiding ofNonBlockingWorker
. - Add ability to trigger timed work in
TestDriver
viaTestDriver.setInitialDelayMet(UUID)
andTestDriver.setPeriodDelayMet(UUID)
. b/113360060
Breaking Changes
- The default
Worker
andNonBlockingWorker
constructors are deprecated. Please migrate to the new constructor ASAP. Future versions will remove the default constructor.
Version 1.0.0-alpha08
August 27, 2018
Bug Fixes
- Explicitly labelled WorkManager components as direct boot unaware so they don't fire up during direct boot. In the future, we will provide a version of WorkManager that is direct boot-aware. b/112665532
- Fixed an issue where retried work was not running. b/112604021
- Fixed periodic work not executing repeatedly (related to the above issue). b/112859683
- Honored backoff policies when the app process is already running.
- Corrected exception messages in
Data
to indicate the limit is 10KB. - Lowered maximum value of
Configuration.setMaxSchedulerLimit(int)
to 50 to account for some latency inJobScheduler
processing completion. b/112817355
Version 1.0.0-alpha07
August 16, 2018
Bug Fixes
- Fixed a potential SQL query with negative limits that could return an unbounded number of results.
- Work that has finished execution now correctly cancels all pending copies of that work in other Schedulers. This led to exceeding the
JobScheduler
jobs limit. b/111569265 - Fixed a
ConcurrentModificationException
inConstraintTracker
. b/112272753 - Changed return type annotations of
Data.getBooleanArray(String)
andData.getIntArray(String)
to@Nullable
instead of@NonNull
. b/112275229
API Changes
Worker
now extends a new class,NonBlockingWorker
. This does not affect any current usage. In the future,NonBlockingWorker
will become a fully supported entity for custom threading solutions.- Changed return type annotations of
Data.getBooleanArray(String)
andData.getIntArray(String)
to@Nullable
instead of@NonNull
. b/112275229 - Kotlin extensions: deprecated
Map.toWorkData()
and added a top-levelworkDataOf(vararg Pair<String, Any?>)
to be more consistent with existing APIs.
Version 1.0.0-alpha06
August 1, 2018
Bug Fixes
- Prevent a database lock when scheduling work. b/111801342
- Fix a bug which causes
PeriodicWork
to not run on schedule when in Doze mode. b/111469837 - Fix a race condition when tracking constraints which causes
WorkManager
to crash. googlecodelabs/android-workmanager/issues/56 - Create unique
WorkRequest
s when usingWorkRequest.Builder#build()
. b/111408337 - Enable the use of
RescheduleReceiver
only when there areWorkRequest
s that need it. b/111765853
Version 1.0.0-alpha05
July 24, 2018
API Changes
WorkManager.getInstance()
is now annotated with@NonNull
instead of@Nullable
. Instead, if the singleton isn't properly initialized in cases of manual initialization, the method will throw anIllegalStateException
. This is a breaking API change.- Added a new API,
Configuration.Builder.setMinimumLoggingLevel(int)
, which can control WorkManager verbosity. By default, WorkManager logsLog.INFO
and above. - Changed signature of
Data.getString()
so it no longer takes a default value (it is implicitlynull
). This is a breaking API change. - Marked some methods needed only for internal usage as
@hide
. This includes theConstraints
constructor,Data.toByteArray()
, andData.fromByteArray(byte[])
. This is a breaking API change.
Bug Fixes
- WorkManager no longer executes work during known cases of auto-backup. This could have resulted in a crash. b/110564377
- Fixed double-scheduling of
PeriodicWorkRequest
s when usingJobScheduler
. b/110798652 - Fixed an issue with
PeriodicWorkRequest
s not executing correctly after device doze. b/111469837 - Fixed an issue with initial delays when using Firebase JobDispatcher. b/111141023
- Fixed some potential race conditions and timing issues.
- Correctly freed up
BroadcastReceiver
s that were no longer needed. - Optimized rescheduling performance when apps restart after being force closed.
- Allowed
TestScheduler.setAllConstraintsMet(UUID)
to be called before or after enqueuing the givenWorkRequest
. b/111238024
Breaking Changes
WorkManager.getInstance()
is now annotated with@NonNull
instead of@Nullable
.- Changed signature of
Data.getString()
so it no longer takes a default value (it is implicitlynull
). - Marked some methods needed only for internal usage as
@hide
. This includes theConstraints
constructor,Data.toByteArray()
, andData.fromByteArray(byte[])
.
Version 1.0.0-alpha04
June 26, 2018
Bug Fixes
PeriodicWorkRequest
s are now correctly rescheduled when using theAlarmManager
based implementation.- Fixed a potential ANR when rescheduling all workers after a force stop or a reboot. b/110507716
- Added nullability annotations to various WorkManager APIs. b/110344065
- Log uncaught exceptions that occur during Worker execution. b/109900862
- Allowed destructive database migrations in case you decide to roll back to an older version of WorkManager. b/74633270
- Fixed a migration crash if creating duplicate implicit tags. This is a very rare issue that occurred only if you used the same implicit tag format yourself.
Version 1.0.0-alpha03
June 19, 2018
Bug Fixes
Fixed a race condition in the
AlarmManager
based implementation. b/80346526.Fixed duplicate jobs when using
JobScheduler
after a device reboot.Jobs with Content URI triggers now persist across reboots. b/80234744
Documentation updates. b/109827628, b/109758949, b/80230748
Fixed a crash when re-enqueuing a
WorkRequest
. b/109572353.Fixed Kotlin compiler warnings when using the
work-runtime-ktx
dependency.WorkManager now uses
Room
version1.1.1-rc1
.
API Changes
- Added
getStatusesSync()
, the synchronous version ofWorkContinuation.getStatuses()
. Worker
has the ability to distinguish between user-initiated cancellation and temporary os-requested stopping.Worker.isStopped()
returnstrue
if any kind of stop has been requested.Worker.isCancelled()
returnstrue
when the work has been explicitly cancelled. b/79632247- Add support for JobParameters#getNetwork() on API 28. This is exposed via
Worker.getNetwork()
. - Added
Configuration.Builder.setMaxSchedulerLimit(int maxSchedulerLimit)
so you can enforce how many jobs can be sent toJobScheduler
orAlarmManager
. This helps preventWorkManager
from taking all your availableJobScheduler
slots. - Added
Configuration.setJobSchedulerJobIdRange(int minJobSchedulerId, int maxJobSchedulerId)
which helps define a range ofJobScheduler
job ids safe forWorkManager
to use. b/79996760 Worker.getRunAttemptCount()
returns the current run count for a givenWorker
. b/79716516WorkManager.enqueueUniquePeriodicWork(String uniqueWorkName, ExistingPeriodicWorkPolicy existingPeriodicWorkPolicy, PeriodicWorkRequest periodicWork)
allows you to enqueue a uniquePeriodicWorkRequest
s. b/79600647WorkManager.cancelAllWork()
cancels allWorker
s. Libraries that depend onWorkManager
can query when this method was called last by usingWorkManager.getLastCancelAllTimeMillis()
for additional cleanup of internal state.- Added
WorkManager.pruneWork()
to remove completed jobs from the internal database. b/79950952, b/109710758
Behavior Changes
- Added an implicit tag for all
WorkRequest
s, which is the fully qualified class name for theWorker
. This allows the ability to removeWorkRequest
s withouttag
s or when theid
is not available. b/109572351
Breaking Changes
- Renamed
Worker.WorkerResult
toWorker.Result
. Worker.onStopped
now has an additionalisCancelled
parameter which is set totrue
when theWorker
has explicitly been cancelled.
Version 1.0.0-alpha02
May 24, 2018
Bug Fixes
- Fixed a
NullPointerException
onState.isFinished()
. b/79550068 - Fixed an issue which caused
Worker
s to be rescheduled onApplication.onCreate()
. b/79660657 - Fixed an issue where you could schedule more work than is allowed by the OS. b/79497378
- Moved cleanup of wake locks associated with
Worker
s to the background thread. - The
AlarmManager
implementation now correctly cleans up when all pending work is complete. - Fixed cleanup SQL queries which affected non-English locales. b/80065360
- Added support for
float
s inData
. b/79443878 Data.Builder.putAll()
now returns an instance of theBuilder
. b/79699162- More javadoc and fixes in documentation. b/79691663
API Changes
Worker
s can react to being stopped.Worker.isStopped()
can be used to check if aWorker
has been stopped.Worker.onStopped()
can be used to perform lightweight cleanup operations.Worker.getTags()
API returns aSet
of tags associated with theWorker
.- Added
javax.time.Duration
overloads for APIs which take a combination of duration andTimeUnit
s. This is guarded by@RequiresApi(26)
. WorkManager
extensions have moved from theandroidx.work.ktx
package to theandroidx.work
package. The old extensions are deprecated and will be removed in a future version.Configuration.withExecutor()
is deprecated. UseConfiguration.setExecutor()
instead.
Version 1.0.0-alpha01
May 8, 2018
WorkManager simplifies scheduling and execution of
guaranteed, constraint-aware background work. This initial release is 1.0.0-alpha01
.