WorkMetricsInfoRepository

val DEFAULT_RETENTION_TIME_MILLIS: Long

The default retention time for finished work metrics (7 days).

val MAX_RETENTION_TIME_MILLIS: Long

The maximum allowed retention time for finished work metrics (30 days).

WorkMetricsInfoRepository(context: Context, dbExecutor: Executor? = null)

Creates an instance of WorkMetricsInfoRepository with a default retention of DEFAULT_RETENTION_TIME_MILLIS.

It is recommended that the Executor passed here is the same as the one passed into androidx.work.Configuration.Builder.setTaskExecutor. If no executor is provided, Room's default executors will be used instead.

Note that this executor is only used for database operations and not for running the event hooks themselves.

@RequiresApi(value = 26)
WorkMetricsInfoRepository(
    context: Context,
    retentionDuration: Duration,
    dbExecutor: Executor? = null
)

Creates an instance of WorkMetricsInfoRepository with a custom retention duration.

WorkMetricsInfoRepository(
    context: Context,
    retentionTime: Long,
    retentionTimeUnit: TimeUnit,
    dbExecutor: Executor? = null
)

Creates an instance of WorkMetricsInfoRepository with a custom retention time.

suspend fun getWorkMetricsInfoById(workId: UUID): List<WorkMetricsInfo>

Gets a list of WorkMetricsInfo snapshots for a given work id.

suspend fun getWorkMetricsInfos(query: WorkMetricsQuery): List<WorkMetricsInfo>

Gets a list of WorkMetricsInfo matching the query criteria.

open suspend fun onCancelled(workInfo: WorkInfo): Unit

Called when a work request is canceled from the app e.g. WorkManager.cancelWorkById.

open suspend fun onEnqueued(workInfo: WorkInfo): Unit

Called when a work request is enqueued from the app e.g. WorkManager.enqueue.

open suspend fun onException(throwable: Throwable, workInfo: WorkInfo): Unit

Called when the work request fails from an exception after it has started.

open suspend fun onFinished(result: ListenableWorker.Result, workInfo: WorkInfo): Unit

Called when the worker finishes and returns a value.

open suspend fun onPrerequisiteFailed(workInfo: WorkInfo): Unit

Called when a work request fails because a prerequisite work fails.

open suspend fun onStarted(workInfo: WorkInfo): Unit

Called when a work request starts executing i.e. ListenableWorker.startWork.

open suspend fun onStopped(stopReason: Int, workInfo: WorkInfo): Unit

Called when a work request is stopped by the system after it has started.

open suspend fun onUnblocked(workInfo: WorkInfo): Unit

Called when a work request is no longer waiting on any of its prerequisite work. If the work has no prerequisite work, this is called immediately after onEnqueued.

open suspend fun onUpdated(oldWorkInfo: WorkInfo, updatedWorkInfo: WorkInfo): Unit

Called when a work request is updated from the app e.g. WorkManager.updateWork.

val finishedWorkMetricsInfoFlow: Flow<WorkMetricsInfo>

A hot Flow that emits a WorkMetricsInfo whenever one finishes.

A WorkMetricsInfo is considered finished when the request period is complete or obsolete, either because the work finished or a new request period started (e.g. if the work request is updated or a periodic request completes a period).