core/co.anitrend.arch.core.worker/SupportCoroutineWorker

SupportCoroutineWorker

abstract class SupportCoroutineWorker(context: Context, workerParameters: WorkerParameters) : CoroutineWorker

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

By default, CoroutineWorker runs on kotlinx.coroutines.Dispatchers.Default; this can be modified by wrapping the block of code in kotlinx.coroutines.withContext and providing the desired kotlinx.coroutines.Dispatchers

A CoroutineWorker is given a maximum of ten minutes to finish its execution and return a androidx.work.ListenableWorker.Result. After this time has expired, the worker will be signalled to stop.

Since

v0.9.X

Constructors

SupportCoroutineWorker

constructor(context: Context, workerParameters: WorkerParameters)

Properties

coroutineContext

open val ~~coroutineContext~~: CoroutineDispatcher

Functions

abstract suspend override fun doWork(): ListenableWorker.Result

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

getApplicationContext

fun getApplicationContext(): Context

getBackgroundExecutor

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open fun getBackgroundExecutor(): Executor

getForegroundInfo

open suspend fun getForegroundInfo(): ForegroundInfo

getForegroundInfoAsync

override fun getForegroundInfoAsync(): ListenableFuture<ForegroundInfo>

fun getId(): UUID

fun getInputData(): Data

@RequiresApi(value = 28)

fun getNetwork(): Network?

getRunAttemptCount

@IntRange(from = 0)

fun getRunAttemptCount(): Int

@RequiresApi(value = 31)

fun getStopReason(): Int

fun getTags(): MutableSet<String>

getTaskExecutor

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open fun getTaskExecutor(): TaskExecutor

getTriggeredContentAuthorities

@RequiresApi(value = 24)

fun getTriggeredContentAuthorities(): MutableList<String>

getTriggeredContentUris

@RequiresApi(value = 24)

fun getTriggeredContentUris(): MutableList<Uri>

getWorkerFactory

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open fun getWorkerFactory(): WorkerFactory

fun isStopped(): Boolean

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun isUsed(): Boolean

override fun onStopped()

suspend fun setForeground(foregroundInfo: ForegroundInfo)

setForegroundAsync

fun setForegroundAsync(@NonNull foregroundInfo: ForegroundInfo): ListenableFuture<Void>

suspend fun setProgress(data: Data)

setProgressAsync

open fun setProgressAsync(@NonNull data: Data): ListenableFuture<Void>

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

override fun startWork(): ListenableFuture<ListenableWorker.Result>

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun stop(reason: Int)