Android Periodic Work Request Start and Stop when the app is starting and closing

Question

When my app is starting, I created a periodic work request using WorkManager to fetch the data from the server and its working fine. My problem is, I want to cancel the work request when my app is closing.

How to cancel the work request when my app is closing or how to detect the app is closing?

I would appreciate any suggestions.

[1](https://android.jlelse.eu/how-to-detect-android-application-open-and-close-background-and-foreground-events-1b4713784b57) [2](https://stackoverflow.com/questions/27865016/why-manage-lifecycle-through-application-class) — denvercoder9, Sep 05 '19 at 06:15

Rahul Khurana · Accepted Answer · 2019-09-06T03:31:46.887

4

As mentioned in the Android Documentation.

In Kotlin

WorkManager.cancelWorkById(workRequest.id)

In Java

WorkManager.cancelWorkById(workRequest.getId());

You can also cancel WorkRequests by tag using WorkManager.cancelAllWorkByTag(String). Note that this method cancels all work with this tag. Additionally, you can cancel all work with a unique name using WorkManager.cancelUniqueWork(String).

EDIT

To check help in app closing events, check the ProcessLifecycleOwner.

Kotlin example

https://github.com/jshvarts/AppLifecycleDemo

edited Sep 06 '19 at 03:31

answered Sep 05 '19 at 06:08

Rahul Khurana

8,577
7
33
60

Yes. I know that. I want to know how to detect when the app is closing? – stay_hungry Sep 05 '19 at 06:10
1

@stay_hungry are you using multiple activities? – Rahul Khurana Sep 05 '19 at 06:14
1

https://stackoverflow.com/questions/42576734/android-checking-whether-the-app-is-closed – Zafer Celaloglu Sep 05 '19 at 06:15
@Rahul Khurana, Yes..I have several activities. – stay_hungry Sep 05 '19 at 06:17
1

@RahulKhurana ,@ZaferCelaloglu... I think ProcessLifecycleOwner works for me.. I will check let you guy. Thanks – stay_hungry Sep 05 '19 at 06:30
@stay_hungry did you got the chance to check the output? – Rahul Khurana Sep 05 '19 at 07:51
@RahulKhurana, not yet.I will let u know once I check.. cheers – stay_hungry Sep 05 '19 at 08:34
@RahulKhurana, I checked s ProcessLifecycleOwner. Its working fine.thanks – stay_hungry Sep 06 '19 at 03:19

score 0 · Answer 2 · answered Sep 05 '19 at 06:24

To can work on app close, override Activity's onDestroy() method and then cancel the current work. There are mainly two types of work

Enqueued Work

If you no longer need your previously-enqueued work to run, you can ask for it to be cancelled. The simplest way to do this is by cancelling a single WorkRequest using its id and calling

WorkManager.cancelWorkById(workRequest.getId());

OR you can also cancel work by tag.

WorkManager.cancelAllWorkByTag(String)

Running Work

There are a few different reasons your running worker may be stopped by WorkManager:

You explicitly asked for it to be cancelled (by calling WorkManager.cancelWorkById(UUID), for example).
In the case of unique work, you explicitly enqueued a new WorkRequest with an ExistingWorkPolicy of REPLACE. The old WorkRequest is immediately considered terminated.
Your work's constraints are no longer met.
The system instructed your app to stop your work for some reason. This can happen if you exceed the execution deadline of 10 minutes. The work is scheduled for retry at a later time.

Under these conditions, your worker will receive a call to ListenableWorker.onStopped().

According to your requirements, you explicitly asked for it to be cancelled (1st Point). You need to override onStopped() in your worker class and perform cleanup.

@Override
public void onStopped() {
    super.onStopped();
    //Perform cleanup
}

And in your activity onDestroy() method, stop work by either id or tag.

@Override
protected void onDestroy() {
    super.onDestroy();
    WorkManager.cancelWorkById(UUID);
}

Hope this will work. Thanks

Android Periodic Work Request Start and Stop when the app is starting and closing

2 Answers2