{"id":55895,"date":"2022-11-30T10:25:16","date_gmt":"2022-11-30T04:55:16","guid":{"rendered":"https:\/\/www.tothenew.com\/blog\/?p=55895"},"modified":"2022-12-06T10:38:18","modified_gmt":"2022-12-06T05:08:18","slug":"using-work-managers-periodic-work-for-less-than-15-minutes","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/using-work-managers-periodic-work-for-less-than-15-minutes\/","title":{"rendered":"Using work manager\u2019s periodic work for less than 15 minutes"},"content":{"rendered":"

\"\"<\/p>\n

During our development journey, we do face situations where we require to perform some periodic and background tasks.<\/p>\n

So, to do so, we have multiple ways, but if it comes to the best way to perform these types of tasks in the context of clean code and optimized device resources usages, then we need to think twice before implementation.<\/p>\n

And after considering above mentioned things, we can go with the WorkManager.<\/p>\n

We can use WorkManager to trigger the OneTimeWorkRequest<\/em><\/strong> and PeriodicWorkRequest<\/em><\/strong> as per the requirements. We can create and enqueue multiple requests and can start conditionally.<\/p>\n

In this blog, we’ll be covering the OneTimeWorkRequest and use it as a periodic request for less than 15 min.<\/p>\n

\n

Why OneTimeWorkRequest<\/em><\/strong> as periodic request for 0\u201314 min?<\/p>\n

Because PeriodicWorkRequest <\/em>allows us to schedule tasks for minimum 15 min but if our requirement is to create it for less time, then what.<\/p>\n<\/blockquote>\n

Lets code and achieve it<\/strong><\/p>\n

Add the required dependency in app level gradle:<\/p>\n

\/\/work manager\r\nimplementation 'androidx.work:work-runtime-ktx:2.7.1'<\/span><\/span><\/pre>\n
Create a class MyWorker and extend Worker:<\/p>\n
package<\/span> com.myworkmanager\r\n\r\nimport<\/span> android.content.Context\r\nimport<\/span> android.util.Log\r\nimport<\/span> androidx.work.Worker\r\nimport<\/span> androidx.work.WorkerParameters\r\n\r\nclass<\/span> MyWorker<\/span>(appContext: Context, workerParams: WorkerParameters) :\r\n    Worker(appContext, workerParams) {\r\n    \/**\r\n     * it will be called after the specified delay\r\n     *\/<\/span>\r\n    override<\/span> fun<\/span> doWork<\/span>()<\/span><\/span>: Result {\r\n        Log.i(\"MyWorker\"<\/span>, \"doWork\"<\/span>)\r\n\r\n        \/\/you can notify back to user<\/span>\r\n        WorkHandler.onDoWork()\r\n\r\n        \/\/or if you need to do some background task e.g., upload or download<\/span>\r\n        \/\/then pass the reference of the required resources in MyWorker()<\/span>\r\n        doFurtherTask()\r\n\r\n        return<\/span> Result.success()\r\n    }\r\n\r\n    \/**\r\n     * or if you need to do some background task e.g., upload or download\r\n     * then pass the reference of the required resources in MyWorker()\r\n     *\/<\/span>\r\n    private<\/span> fun<\/span> doFurtherTask<\/span>()<\/span><\/span> {\r\n        Log.i(\"MyWorker\"<\/span>, \"doFurtherTask\"<\/span>)\r\n        \/\/ do your background work here if required<\/span>\r\n    }\r\n}<\/span><\/pre>\n
Create WorkHandler:<\/p>\n
package<\/span> com.myworkmanager\r\n\r\nimport<\/span> android.util.Log\r\nimport<\/span> androidx.lifecycle.Lifecycle\r\nimport<\/span> androidx.work.Constraints\r\nimport<\/span> androidx.work.NetworkType\r\nimport<\/span> androidx.work.OneTimeWorkRequestBuilder\r\nimport<\/span> androidx.work.WorkManager\r\nimport<\/span> java.util.concurrent.TimeUnit\r\n\r\n\r\nobject<\/span> WorkHandler {\r\n    private<\/span> const<\/span> val<\/span> tag = \"WorkHandler\"<\/span>\r\n    private<\/span> val<\/span> workManager = WorkManager.getInstance(MyWorkManagerApplication.appInstance)\r\n\r\n    \/**\r\n     * create work request\r\n     *\r\n     * @param<\/span> delay\r\n     *\/<\/span>\r\n    fun<\/span> createWork<\/span>(delay: Long<\/span>)<\/span><\/span> {\r\n        val<\/span> constraints = Constraints.Builder()\r\n            .setRequiresBatteryNotLow(true<\/span>)\r\n            .setRequiredNetworkType(NetworkType.CONNECTED)\r\n            .setRequiresBatteryNotLow(true<\/span>)\r\n            .build()\r\n\r\n        val<\/span> request = OneTimeWorkRequestBuilder<MyWorker>()\r\n\r\n        val<\/span> work = request.setConstraints(constraints)\r\n            .addTag(tag)\r\n            .setInitialDelay(delay, TimeUnit.MINUTES)\r\n            .build()\r\n\r\n        workManager.enqueue(work)\r\n\r\n        Log.i(tag, \"work created\"<\/span>)\r\n    }\r\n\r\n    \/**\r\n     * do UI related work because this method is supporting foreground work\r\n     * If you have any other requirement then please update the conditions\r\n     *\/<\/span>\r\n    fun<\/span> onDoWork<\/span>()<\/span><\/span> {\r\n        try<\/span> {\r\n            val<\/span> activity = BaseActivity.currentActivityInstance.get<\/span>()\r\n\r\n            if<\/span> (activity?.lifecycle?.currentState?.isAtLeast(Lifecycle.State.RESUMED) == true<\/span>) {\r\n                \/\/if current activity is active<\/span>\r\n                \/\/do UI related work<\/span>\r\n                Log.i(tag, \"app is active, do UI work\"<\/span>)\r\n\r\n                \/\/recreate the work if required<\/span>\r\n                Log.i(tag, \"recreateWork\"<\/span>)\r\n\r\n                createWork(WORK_DELAY_IN_MIN)\r\n\r\n            } else<\/span> if<\/span> (activity?.lifecycle?.currentState?.isAtLeast(Lifecycle.State.DESTROYED) == true<\/span>) {\r\n                \/\/if current activity is in background for any reason then<\/span>\r\n                \/\/recreate the work if required<\/span>\r\n                Log.i(tag, \"recreateWork\"<\/span>)\r\n\r\n                createWork(WORK_DELAY_IN_MIN)\r\n\r\n            } else<\/span> {\r\n                \/\/cancel work if app got killed, if you want to continue then remove this condition<\/span>\r\n                \/\/and, keep recreate work logic<\/span>\r\n                Log.i(tag, \"safe: cancel work if any\"<\/span>)\r\n                cancelWork()\r\n            }\r\n\r\n        } catch<\/span> (ex: Exception) {\r\n            Log.e(tag, ex.toString())\r\n        }\r\n    }\r\n\r\n    \/**\r\n     * cancel enqueued work by the given tag\r\n     *\/<\/span>\r\n    fun<\/span> cancelWork<\/span>()<\/span><\/span> {\r\n        workManager.cancelAllWorkByTag(tag)\r\n        \r\n        Log.i(tag, \"work canceled\"<\/span>)\r\n    }\r\n}<\/span><\/pre>\n
Work initiator MyWorkManagerApplication:<\/p>\n
package<\/span> com.myworkmanager\r\n\r\nimport<\/span> android.app.Application\r\n\r\nclass<\/span> MyWorkManagerApplication<\/span> : Application<\/span>() {\r\n\r\n    init<\/span> {\r\n        appInstance = this<\/span>\r\n    }\r\n\r\n    companion<\/span> object<\/span> {\r\n        lateinit<\/span> var<\/span> appInstance: MyWorkManagerApplication\r\n    }\r\n\r\n    override<\/span> fun<\/span> onCreate<\/span>()<\/span><\/span> {\r\n        super<\/span>.onCreate()\r\n\r\n        \/\/start work on application start<\/span>\r\n        \/\/or you can start work as per your need<\/span>\r\n        \/\/e.g., from MainActivity, SplashActivity, via user action, etc.<\/span>\r\n        WorkHandler.createWork(WORK_DELAY_IN_MIN)\r\n    }\r\n}<\/span><\/pre>\n
Rest of the files to support the complete flow:<\/p>\n
package<\/span> com.myworkmanager\r\n\r\nimport<\/span> androidx.appcompat.app.AppCompatActivity\r\nimport<\/span> java.lang.ref.WeakReference\r\n\r\nopen<\/span> class<\/span> BaseActivity<\/span> : AppCompatActivity<\/span>() {\r\n    companion<\/span> object<\/span> {\r\n        var<\/span> currentActivityInstance: WeakReference<AppCompatActivity?> =\r\n            WeakReference<AppCompatActivity?>(null<\/span>)\r\n    }\r\n\r\n    override<\/span> fun<\/span> onResume<\/span>()<\/span><\/span> {\r\n        super<\/span>.onResume()\r\n\r\n        \/\/keep current activity instance and use to perform any UI related task on work completion<\/span>\r\n        currentActivityInstance = WeakReference(this<\/span>)\r\n    }\r\n}<\/span><\/pre>\n
package<\/span> com.myworkmanager\r\n\r\nimport<\/span> android.content.Intent\r\nimport<\/span> android.os.Bundle\r\nimport<\/span> android.util.Log\r\nimport<\/span> android.widget.Button\r\n\r\nclass<\/span> MainActivity<\/span> : BaseActivity<\/span>() {\r\n    override<\/span> fun<\/span> onCreate<\/span>(savedInstanceState: Bundle<\/span>?)<\/span><\/span> {\r\n        super<\/span>.onCreate(savedInstanceState)\r\n        setContentView(R.layout.activity_main)\r\n\r\n        Log.i(\"MainActivity\"<\/span>, \"launched\"<\/span>)\r\n\r\n        findViewById<Button>(R.id.go_to_next_screen_button)?.setOnClickListener {\r\n            startActivity(Intent(this<\/span>, YourActivity::class<\/span>.java))\r\n        }\r\n\r\n        findViewById<Button>(R.id.cancel_work_button)?.setOnClickListener {\r\n            \/\/cancel on going work anytime<\/span>\r\n            WorkHandler.cancelWork()\r\n        }\r\n    }\r\n}<\/span><\/pre>\n
Constants.kt\r\n\r\npackage<\/span> com.myworkmanager\r\n\r\nconst<\/span> val<\/span> WORK_DELAY_IN_MIN: Long<\/span> = 7<\/span><\/span><\/pre>\n
activity_main.xml\r\n\r\n<?xml version=\"1.0\"<\/span> encoding=\"utf-8\"<\/span>?><\/span>\r\n<androidx.constraintlayout.widget.ConstraintLayout<\/span> xmlns:android<\/span>=\"http:\/\/schemas.android.com\/apk\/res\/android\"<\/span>\r\n    xmlns:app<\/span>=\"http:\/\/schemas.android.com\/apk\/res-auto\"<\/span>\r\n    xmlns:tools<\/span>=\"http:\/\/schemas.android.com\/tools\"<\/span>\r\n    android:layout_width<\/span>=\"match_parent\"<\/span>\r\n    android:layout_height<\/span>=\"match_parent\"<\/span>\r\n    tools:context<\/span>=\".MainActivity\"<\/span>><\/span>\r\n\r\n\r\n    <Button<\/span>\r\n        android:id<\/span>=\"@+id\/go_to_next_screen_button\"<\/span>\r\n        android:layout_width<\/span>=\"wrap_content\"<\/span>\r\n        android:layout_height<\/span>=\"wrap_content\"<\/span>\r\n        android:layout_marginStart<\/span>=\"157dp\"<\/span>\r\n        android:layout_marginTop<\/span>=\"215dp\"<\/span>\r\n        android:layout_marginEnd<\/span>=\"160dp\"<\/span>\r\n        android:text<\/span>=\"@string\/go_to_next_screen\"<\/span>\r\n        app:layout_constraintEnd_toEndOf<\/span>=\"parent\"<\/span>\r\n        app:layout_constraintStart_toStartOf<\/span>=\"parent\"<\/span>\r\n        app:layout_constraintTop_toTopOf<\/span>=\"parent\"<\/span>\r\n        tools:ignore<\/span>=\"DuplicateSpeakableTextCheck\"<\/span> \/><\/span>\r\n\r\n    <Button<\/span>\r\n        android:id<\/span>=\"@+id\/cancel_work_button\"<\/span>\r\n        android:layout_width<\/span>=\"wrap_content\"<\/span>\r\n        android:layout_height<\/span>=\"wrap_content\"<\/span>\r\n        android:layout_marginStart<\/span>=\"160dp\"<\/span>\r\n        android:layout_marginTop<\/span>=\"91dp\"<\/span>\r\n        android:layout_marginEnd<\/span>=\"157dp\"<\/span>\r\n        android:layout_marginBottom<\/span>=\"330dp\"<\/span>\r\n        android:text<\/span>=\"@string\/cancel_work\"<\/span>\r\n        app:layout_constraintBottom_toBottomOf<\/span>=\"parent\"<\/span>\r\n        app:layout_constraintEnd_toEndOf<\/span>=\"parent\"<\/span>\r\n        app:layout_constraintStart_toStartOf<\/span>=\"parent\"<\/span>\r\n        app:layout_constraintTop_toBottomOf<\/span>=\"@+id\/go_to_next_screen_button\"<\/span> \/><\/span>\r\n\r\n    <TextView<\/span>\r\n        android:id<\/span>=\"@+id\/textView\"<\/span>\r\n        android:layout_width<\/span>=\"wrap_content\"<\/span>\r\n        android:layout_height<\/span>=\"wrap_content\"<\/span>\r\n        android:layout_marginStart<\/span>=\"177dp\"<\/span>\r\n        android:layout_marginTop<\/span>=\"36dp\"<\/span>\r\n        android:layout_marginEnd<\/span>=\"176dp\"<\/span>\r\n        android:text<\/span>=\"@string\/screen_one\"<\/span>\r\n        app:layout_constraintEnd_toEndOf<\/span>=\"parent\"<\/span>\r\n        app:layout_constraintStart_toStartOf<\/span>=\"parent\"<\/span>\r\n        app:layout_constraintTop_toTopOf<\/span>=\"parent\"<\/span> \/><\/span>\r\n<\/androidx.constraintlayout.widget.ConstraintLayout<\/span>><\/span><\/span><\/pre>\n
So far, we have looked into the code and achieved the periodic work behavior using OneTimeWorkRequest. <\/em>We can modify the logic according to our use cases.<\/p>\n
During your development, if you find any other use case, please feel free to comment, and we can resolve the issues together.<\/p>\n
<\/em>Read more:\u00a0 Android Katha: onActivityResult is Deprecated. Now What?<\/a><\/p>\n
<\/div>","protected":false},"excerpt":{"rendered":"
During our development journey, we do face situations where we require to perform some periodic and background tasks. So, to do so, we have multiple ways, but if it comes to the best way to perform these types of tasks in the context of clean code and optimized device resources usages, then we need to […]<\/p>\n","protected":false},"author":1476,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":436},"categories":[518],"tags":[5048],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55895"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/1476"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=55895"}],"version-history":[{"count":3,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55895\/revisions"}],"predecessor-version":[{"id":55929,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55895\/revisions\/55929"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=55895"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=55895"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=55895"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}