CoroutineWorker

Kotlin |Java

abstract class CoroutineWorker : ListenableWorker

kotlin.Any
↳	androidx.work.ListenableWorker
	↳	androidx.work.CoroutineWorker

A ListenableWorker implementation that provides interop with Kotlin Coroutines. Override the doWork function to do your suspending work.

Summary

Public constructors
`<init>(appContext: Context, params: WorkerParameters)` A ListenableWorker implementation that provides interop with Kotlin Coroutines.

Public methods
abstract suspend ListenableWorker.Result	`doWork()` A suspending method to do your work.
Unit	`onStopped()`
suspend Unit	`setForeground(foregroundInfo: ForegroundInfo)` Makes the CoroutineWorker run in the context of a foreground android.app.Service.
suspend Unit	`setProgress(data: Data)` Updates the progress for the CoroutineWorker.
ListenableFuture<ListenableWorker.Result>	`startWork()`

Inherited functions

From class ListenableWorker

`Context`	`getApplicationContext()` Gets the application `android.content.Context`.
`UUID`	`getId()` Gets the ID of the `WorkRequest` that created this Worker.
`Data`	`getInputData()` Gets the input data. Note that in the case that there are multiple prerequisites for this Worker, the input data has been run through an `InputMerger`.
`Network?`	`getNetwork()` Gets the `android.net.Network` to use for this Worker. This method returns `null` if there is no network needed for this work request.
`Int`	`getRunAttemptCount()` Gets the current run attempt count for this work. Note that for periodic work, this value gets reset between periods.
`MutableSet<String!>`	`getTags()` Gets a `java.util.Set` of tags associated with this Worker's `WorkRequest`.
`MutableList<String!>`	`getTriggeredContentAuthorities()` Gets the list of content authorities that caused this Worker to execute. See `JobParameters#getTriggeredContentAuthorities()` for relevant `JobScheduler` code.
`MutableList<Uri!>`	`getTriggeredContentUris()` Gets the list of content `android.net.Uri`s that caused this Worker to execute. See `JobParameters#getTriggeredContentUris()` for relevant `JobScheduler` code.
`Boolean`	`isStopped()` Returns `true` if this Worker has been told to stop. This could be because of an explicit cancellation signal by the user, or because the system has decided to preempt the task. In these cases, the results of the work will be ignored by WorkManager and it is safe to stop the computation. WorkManager will retry the work at a later time if necessary.
`ListenableFuture<Void!>`	`setForegroundAsync(@NonNull foregroundInfo: ForegroundInfo)` This specifies that the `WorkRequest` is long-running or otherwise important. In this case, WorkManager provides a signal to the OS that the process should be kept alive if possible while this work is executing. Calls to `setForegroundAsync` must complete before a `ListenableWorker` signals completion by returning a `Result`. Under the hood, WorkManager manages and runs a foreground service on your behalf to execute this WorkRequest, showing the notification provided in `ForegroundInfo`.
`ListenableFuture<Void!>`	`setProgressAsync(@NonNull data: Data)` Updates `ListenableWorker` progress.

Properties
open CoroutineDispatcher	`coroutineContext` The coroutine context on which doWork will run.

Public constructors

<init>

CoroutineWorker(
    appContext: Context, 
    params: WorkerParameters)

A ListenableWorker implementation that provides interop with Kotlin Coroutines. Override the doWork function to do your suspending work.

Public methods

doWork

abstract suspend fun doWork(): ListenableWorker.Result

A suspending method to do your work. This function runs on the coroutine context specified by coroutineContext.

Return
The	ListenableWorker.Result of the result of the background work; note that dependent work will not execute if you return ListenableWorker.Result.failure

onStopped

fun onStopped(): Unit

setForeground

suspend fun setForeground(foregroundInfo: ForegroundInfo): Unit

Makes the CoroutineWorker run in the context of a foreground android.app.Service. This is a suspending function unlike the setForegroundAsync API which returns a ListenableFuture.

Parameters
foregroundInfo: ForegroundInfo	The ForegroundInfo

setProgress

suspend fun setProgress(data: Data): Unit

Updates the progress for the CoroutineWorker. This is a suspending function unlike the setProgressAsync API which returns a ListenableFuture.

Parameters
data: Data	The progress Data

startWork

fun startWork(): ListenableFuture<ListenableWorker.Result>

Properties

coroutineContext

open val coroutineContext: CoroutineDispatcher

Deprecated.

The coroutine context on which doWork will run. By default, this is Dispatchers.Default.