ScheduleEventListener
@ExperimentalEventsApi
interface ScheduleEventListener
WorkMetricsInfoRepository |
Repository class that calculates and stores metrics info and analytics about workers. |
Listener interface that is called for events related to a worker's scheduling.
Summary
Public functions |
|
|---|---|
open suspend Unit |
onCancelled(workInfo: WorkInfo)Called when a work request is canceled from the app e.g. |
open suspend Unit |
onEnqueued(workInfo: WorkInfo)Called when a work request is enqueued from the app e.g. |
open suspend Unit |
onPrerequisiteFailed(workInfo: WorkInfo)Called when a work request fails because a prerequisite work fails. |
open suspend Unit |
onUnblocked(workInfo: WorkInfo)Called when a work request is no longer waiting on any of its prerequisite work. |
open suspend Unit |
Called when a work request is updated from the app e.g. |
Public functions
onCancelled
open suspend fun onCancelled(workInfo: WorkInfo): Unit
Called when a work request is canceled from the app e.g. WorkManager.cancelWorkById.
| Parameters | |
|---|---|
workInfo: WorkInfo |
Snapshot of the work info |
onEnqueued
open suspend fun onEnqueued(workInfo: WorkInfo): Unit
Called when a work request is enqueued from the app e.g. WorkManager.enqueue.
| Parameters | |
|---|---|
workInfo: WorkInfo |
Snapshot of the work info |
onPrerequisiteFailed
open suspend fun onPrerequisiteFailed(workInfo: WorkInfo): Unit
Called when a work request fails because a prerequisite work fails.
| Parameters | |
|---|---|
workInfo: WorkInfo |
Snapshot of the work info |
onUnblocked
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.
| Parameters | |
|---|---|
workInfo: WorkInfo |
Snapshot of the work info |
onUpdated
open suspend fun onUpdated(oldWorkInfo: WorkInfo, updatedWorkInfo: WorkInfo): Unit
Called when a work request is updated from the app e.g. WorkManager.updateWork.