ScheduleEventListener
@ExperimentalEventsApi
public 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 methods |
|
|---|---|
default void |
onCancelled(@NonNull WorkInfo workInfo)Called when a work request is canceled from the app e.g. |
default void |
onEnqueued(@NonNull WorkInfo workInfo)Called when a work request is enqueued from the app e.g. |
default void |
onPrerequisiteFailed(@NonNull WorkInfo workInfo)Called when a work request fails because a prerequisite work fails. |
default void |
onUnblocked(@NonNull WorkInfo workInfo)Called when a work request is no longer waiting on any of its prerequisite work. |
default void |
Called when a work request is updated from the app e.g. |
Public methods
onCancelled
default void onCancelled(@NonNull WorkInfo workInfo)
Called when a work request is canceled from the app e.g. WorkManager.cancelWorkById.
onEnqueued
default void onEnqueued(@NonNull WorkInfo workInfo)
Called when a work request is enqueued from the app e.g. WorkManager.enqueue.
onPrerequisiteFailed
default void onPrerequisiteFailed(@NonNull WorkInfo workInfo)
Called when a work request fails because a prerequisite work fails.
onUnblocked
default void onUnblocked(@NonNull WorkInfo workInfo)
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.
onUpdated
default void onUpdated(@NonNull WorkInfo oldWorkInfo, @NonNull WorkInfo updatedWorkInfo)
Called when a work request is updated from the app e.g. WorkManager.updateWork.