Android Implement LifecycleOwner for WorkManager

May 13, 2019

WorkManager runs in background thread, while LifecycleOwner/LiveData require main/ui thread, thus it is highly not recommended.

If you really must …

The sample below utilize CoroutineWorker

class ReminderWorker(appContext: Context, workerParams: WorkerParameters): CoroutineWorker(appContext, workerParams), LifecycleOwner {
    companion object {
        fun run() : LiveData<WorkInfo> {
            val work = OneTimeWorkRequestBuilder<ReminderWorker>().build()
            WorkManager.getInstance().enqueue(work)

            return WorkManager.getInstance().getWorkInfoByIdLiveData(work.id)
        }
    }


    private lateinit var lifecycleRegistry: LifecycleRegistry

    override fun getLifecycle(): Lifecycle {
        return lifecycleRegistry
    }

    override suspend fun doWork(): Result = coroutineScope {
        val worker = this@ReminderWorker

        lifecycleRegistry = LifecycleRegistry(worker)
        lifecycleRegistry.currentState = Lifecycle.State.CREATED

        val lifecyclerOwner = work
        // test if Lifecycle.Event.ON_DESTROY is called
        lifecycle.addObserver(object : LifecycleObserver {
            @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
            fun onDestroy() {
                Timber.d("onDestroy")
            }
        })

        lifecycleRegistry.currentState = Lifecycle.State.STARTED

        // do something

        lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
        Result.success()
    }
}

References:

❤️ Is this article helpful?

Buy me a coffee☕ or support my work to keep this space 🖖 and ad-free.
If you can't, do send some 💖 to @d_luaz or help to share this article.

👶 Apps I built

Pixtory App (Alpha) - easily organize photos on your phone into a blog.
COVID-19 - data, chart, information & news.
暖心芽 (WIP) 🌞❤️🌱 - reminder of hope, warmth, thoughts and feelings.
Travelopy - travel discovery and journal
LuaPass - offline password manager
WhatIDoNow - a public log of things I am working on now

By Desmond Lua

A dream boy who enjoys making apps, travelling and gardening. Follow me on @d_luaz.

Tags:

Android Schedule Daily Repeating/Reminder Alarm at Specific Time With WorkManager

Use WorkManager for Android Background Processing

Android Data Binding for RecyclerView With LiveData (Kotlin)

Android WorkManager Update Progress UI (Kotlin)

Android Inspect WorkManager Database

Android WorkManager Check if Work Is in Queue or Running

CoroutineWorker: Use Kotlin Coroutines in WorkManager

Android Firebase Auth AuthStateListener as LiveData (lifecycle-aware)

Android Firestore Query addSnapshotListener as LiveData (lifecycle aware)