:sync/dev.atick.sync.worker/DelegatingWorker

DelegatingWorker

class DelegatingWorker(appContext: Context, workerParams: WorkerParameters) : CoroutineWorker

A worker that delegates sync to another CoroutineWorker constructed with a HiltWorkerFactory.

This allows for creating and using CoroutineWorker instances with extended arguments without having to provide a custom WorkManager configuration that the app module needs to utilize.

In other words, it allows for custom workers in a library module without having to own configuration of the WorkManager singleton.

Constructors

DelegatingWorker

constructor(appContext: Context, workerParams: WorkerParameters)

Properties

applicationContext

val applicationContext: @NonNull Context

backgroundExecutor

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

open val backgroundExecutor: @NonNull Executor

coroutineContext

open val ~~coroutineContext~~: CoroutineDispatcher

foregroundInfoAsync

val foregroundInfoAsync: com/google/common/util/concurrent/ListenableFuture<androidx/work/ForegroundInfo>

val id: @NonNull UUID

inputData

val inputData: @NonNull Data

isStopped

val isStopped: Boolean

isUsed

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

val isUsed: Boolean

network

@get:RequiresApi(value = 28)

val network: @Nullable Network?

runAttemptCount

@get:IntRange(from = 0)

val runAttemptCount: Int

stopReason

@get:RequiresApi(value = 31)

val stopReason: Int

Functions

doWork

open suspend override fun doWork(): ListenableWorker.Result

Delegates the work to the delegate worker

getForegroundInfo

open suspend override fun getForegroundInfo(): ForegroundInfo

Retrieves the foreground info from the delegate worker

getForegroundInfoAsync

override fun getForegroundInfoAsync(): com/google/common/util/concurrent/ListenableFuture<androidx/work/ForegroundInfo>

onStopped

override fun onStopped()

setForeground

suspend fun setForeground(foregroundInfo: ForegroundInfo)

setForegroundAsync

fun setForegroundAsync(foregroundInfo: @NonNull ForegroundInfo): @EnhancedNullability @R|org/jspecify/annotations/NonNull|() com/google/common/util/concurrent/ListenableFuture

setProgress

suspend fun setProgress(data: Data)

setProgressAsync

open fun setProgressAsync(data: @NonNull Data): @EnhancedNullability @R|org/jspecify/annotations/NonNull|() com/google/common/util/concurrent/ListenableFuture

setUsed

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

fun setUsed()

startWork

override fun startWork(): com/google/common/util/concurrent/ListenableFuture<androidx/work/ListenableWorker.Result>

stop

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

fun stop(reason: Int)