Background Sync via WorkManager
Background Sync via WorkManager
Google’s WorkManager library is the typical means that Android developers schedule and manage background tasks in a way that is compatible with a wide range of Android versions.
Here we provide some boilerplate for setting up a WorkManager job to run Judo’s sync opportunistically in the background.
Add WorkManager Dependency
Add the following the dependencies block in your build.gradle:
Groovy:
implementation 'androidx.work:work-runtime:2.5.0'
Kotlin KTS:
implementation("androidx.work:work-runtime:2.5.0")
Define Worker
Create a PeriodicWorkRequest that runs the Judo SDK’s sync:
import androidx.work.*
import java.util.concurrent.CountDownLatch
import java.util.concurrent.TimeUnit
import app.judo.sdk.api.Judo
class JudoSyncWorker(appContext: Context, workerParameters: WorkerParameters): Worker(appContext, workerParameters) {
companion object {
private const val TAG = "JudoSyncWorker"
}
override fun doWork(): Result {
val latch = CountDownLatch(1)
Judo.performSync {
latch.countDown()
}
try {
latch.await()
} catch (error: Exception) {
Log.e(TAG, "Unable to complete background Judo sync")
return Result.failure()
}
return Result.success()
}
}
## Register Task
Finally, in your Application class’ onCreate, create and register a work request:
val judoWorkRequest = PeriodicWorkRequest.Builder(JudoSyncWorker::class.java, 1, TimeUnit.HOURS)
.setConstraints(
Constraints.Builder()
// some recommended constraints in order to be considerate about the user's battery and network.
.setRequiredNetworkType(NetworkType.UNMETERED)
.setRequiresCharging(true)
.build(),
)
.build()
WorkManager.getInstance(this).enqueueUniquePeriodicWork("judo-sync", ExistingPeriodicWorkPolicy.REPLACE, judoWorkRequest)
You’ve completed the initial integration! However, other optional steps remain for for more advanced features, namely User Identification and Personalization, handling both Integrating with Analytics.