android/dev.kindling.android.natif/KWorker

KWorker

class KWorker(ctx: Context, params: WorkerParameters) : CoroutineWorker(source)

Generic CoroutineWorker used internally by BackgroundHelper. Register your task via BackgroundHelper.registerWorker before scheduling.

Constructors

KWorker

constructor(ctx: Context, params: WorkerParameters)

Types

Companion

object Companion

Properties

applicationContext

@get:NonNull

val applicationContext: Context

backgroundExecutor

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

@get:NonNull

open val backgroundExecutor: Executor

coroutineContext

open val ~~coroutineContext~~: CoroutineDispatcher

foregroundInfoAsync

val foregroundInfoAsync: ListenableFuture<ForegroundInfo>

@get:NonNull

val id: UUID

inputData

@get:NonNull

val inputData: Data

isStopped

val isStopped: Boolean

isUsed

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

val isUsed: Boolean

network

@get:RequiresApi(value = 28)

@get:Nullable

val network: 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

getForegroundInfo

open suspend fun getForegroundInfo(): ForegroundInfo

getForegroundInfoAsync

override fun getForegroundInfoAsync(): ListenableFuture<ForegroundInfo>

onStopped

override fun onStopped()

setForeground

suspend fun setForeground(foregroundInfo: ForegroundInfo)

setForegroundAsync

@NonNull

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

setProgress

suspend fun setProgress(data: Data)

setProgressAsync

@NonNull

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

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)