: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

coroutineContext

open val ~~coroutineContext~~: CoroutineDispatcher

Functions

doWork

open suspend override fun doWork(): ListenableWorker.Result

Delegates the work to the delegate worker

getApplicationContext

@NonNull

fun getApplicationContext(): Context

getBackgroundExecutor

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

@NonNull

open fun getBackgroundExecutor(): Executor

getForegroundInfo

open suspend override fun getForegroundInfo(): ForegroundInfo

Retrieves the foreground info from the delegate worker

getForegroundInfoAsync

override fun getForegroundInfoAsync(): ListenableFuture<ForegroundInfo>

fun getId(): UUID

fun getInputData(): Data

getNetwork

@RequiresApi(value = 28)

@Nullable

fun getNetwork(): Network?

getRunAttemptCount

@IntRange(from = 0)

fun getRunAttemptCount(): Int

getStopReason

@RequiresApi(value = 31)

fun getStopReason(): Int

getTags

@NonNull

fun getTags(): MutableSet<String>

getTaskExecutor

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

@NonNull

open fun getTaskExecutor(): TaskExecutor

getTriggeredContentAuthorities

@RequiresApi(value = 24)

@NonNull

fun getTriggeredContentAuthorities(): MutableList<String>

getTriggeredContentUris

@RequiresApi(value = 24)

@NonNull

fun getTriggeredContentUris(): MutableList<Uri>

getWorkerFactory

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

@NonNull

open fun getWorkerFactory(): WorkerFactory

isStopped

fun isStopped(): Boolean

isUsed

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

fun isUsed(): Boolean

onStopped

override fun onStopped()

setForeground

suspend fun setForeground(foregroundInfo: ForegroundInfo)

setForegroundAsync

@NonNull

fun setForegroundAsync(@NonNull foregroundInfo: ForegroundInfo): ListenableFuture

setProgress

suspend fun setProgress(data: Data)

setProgressAsync

@NonNull

open fun setProgressAsync(@NonNull data: Data): ListenableFuture

setUsed

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

fun setUsed()

startWork

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

stop

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

fun stop(reason: Int)