0.1.0-beta04

android/io.neuralheads.kmpworker.android/AndroidTaskScheduler

AndroidTaskScheduler

class AndroidTaskScheduler(context: Context) : TaskScheduler

Android implementation of TaskScheduler backed by WorkManager.

Constraint mapping: | KMPWorker Constraint | WorkManager Equivalent | |-------------------------|--------------------------------| | requiresInternet = true | NetworkType.CONNECTED | | requiresCharging = true | setRequiresCharging(true) | | batteryNotLow = true | setRequiresBatteryNotLow(true) |

RetryPolicy mapping: | KMPWorker Policy | WorkManager BackoffPolicy | |-------------------------|--------------------------------| | RetryPolicy.Linear | BackoffPolicy.LINEAR | | RetryPolicy.Exponential | BackoffPolicy.EXPONENTIAL |

Tasks are enqueued as unique work so duplicate IDs replace or keep existing work.

Constructors

AndroidTaskScheduler

constructor(context: Context)

Functions

open suspend override fun cancel(taskId: String)

open suspend fun cancelBatch(taskIds: List<String>)

open suspend override fun cancelByTag(tag: String)

clearExecutionHistory

open suspend fun clearExecutionHistory()

open suspend override fun enqueue(request: TaskRequest)

open suspend fun enqueueBatch(requests: List<TaskRequest>)

open suspend fun enqueueChain(chain: TaskChain)

open suspend override fun enqueueChain(chain: TaskChain, policy: ChainPolicy): Nothing

getExecutionHistory

open suspend fun getExecutionHistory(limit: Int): List<ExecutionRecord>

open override fun observe(taskId: String): Flow<TaskState>

open override fun observeAll(): Flow<Pair<String, TaskState>>

open override fun observeChain(chainId: String): Flow<TaskState>

open override fun register(taskId: String, block: suspend () -> Unit)

registerWithContext

open override fun registerWithContext(taskId: String, block: suspend TaskExecutionContext.() -> Unit)