JobIntentService

abstract class JobIntentService : Service
kotlin.Any
   ↳ android.content.Context
   ↳ android.content.ContextWrapper
   ↳ android.app.Service
   ↳ androidx.core.app.JobIntentService

Helper for processing work that has been enqueued for a job/service. When running on Android O or later, the work will be dispatched as a job via JobScheduler.enqueue. When running on older versions of the platform, it will use Context.startService.

You must publish your subclass in your manifest for the system to interact with. This should be published as a android.app.job.JobService, as described for that class, since on O and later platforms it will be executed that way.

Use enqueueWork(Context, Class, int, Intent) to enqueue new work to be dispatched to and handled by your service. It will be executed in onHandleWork(Intent).

You do not need to use androidx.legacy.content.WakefulBroadcastReceiver when using this class. When running on Android O, the JobScheduler will take care of wake locks for you (holding a wake lock from the time you enqueue work until the job has been dispatched and while it is running). When running on previous versions of the platform, this wake lock handling is emulated in the class here by directly calling the PowerManager; this means the application must request the android.Manifest.permission#WAKE_LOCK permission.

There are a few important differences in behavior when running on Android O or later as a Job vs. pre-O:

  • When running as a pre-O service, the act of enqueueing work will generally start the service immediately, regardless of whether the device is dozing or in other conditions. When running as a Job, it will be subject to standard JobScheduler policies for a Job with a android.app.job.JobInfo.Builder#setOverrideDeadline(long) of 0: the job will not run while the device is dozing, it may get delayed more than a service if the device is under strong memory pressure with lots of demand to run jobs.
  • When running as a pre-O service, the normal service execution semantics apply: the service can run indefinitely, though the longer it runs the more likely the system will be to outright kill its process, and under memory pressure one should expect the process to be killed even of recently started services. When running as a Job, the typical android.app.job.JobService execution time limit will apply, after which the job will be stopped (cleanly, not by killing the process) and rescheduled to continue its execution later. Job are generally not killed when the system is under memory pressure, since the number of concurrent jobs is adjusted based on the memory state of the device.

Here is an example implementation of this class:

Summary

Public constructors

Default empty constructor.

Public methods
open static Unit
enqueueWork(@NonNull context: Context, @NonNull cls: Class<*>, jobId: Int, @NonNull work: Intent)

Call this to enqueue work for your subclass of JobIntentService.
open static Unit
enqueueWork(@NonNull context: Context, @NonNull component: ComponentName, jobId: Int, @NonNull work: Intent)

Like enqueueWork(Context, Class, int, Intent), but supplies a ComponentName for the service to interact with instead of its class.
open Boolean

Returns true if onStopCurrentWork() has been called.
open IBinder!
onBind(@NonNull intent: Intent)

Returns the IBinder for the android.app.job.JobServiceEngine when running as a JobService on O and later platforms.
open Unit

open Unit

open Int
onStartCommand(@Nullable intent: Intent?, flags: Int, startId: Int)

Processes start commands when running as a pre-O service, enqueueing them to be later dispatched in onHandleWork(Intent).
open Boolean

This will be called if the JobScheduler has decided to stop this job.
open Unit
setInterruptIfStopped(interruptIfStopped: Boolean)

Control whether code executing in onHandleWork(Intent) will be interrupted if the job is stopped.

Protected methods
abstract Unit
onHandleWork(@NonNull intent: Intent)

Called serially for each work dispatched to and processed by the service.

Public constructors

<init>

JobIntentService()

Default empty constructor.

Public methods

enqueueWork

open static fun enqueueWork(
    @NonNull context: Context, 
    @NonNull cls: Class<*>, 
    jobId: Int, 
    @NonNull work: Intent
): Unit

Call this to enqueue work for your subclass of JobIntentService. This will either directly start the service (when running on pre-O platforms) or enqueue work for it as a job (when running on O and later). In either case, a wake lock will be held for you to ensure you continue running. The work you enqueue will ultimately appear at onHandleWork(Intent).

Parameters
context Context: Context this is being called from.
cls Class<*>: The concrete class the work should be dispatched to (this is the class that is published in your manifest).
jobId Int: A unique job ID for scheduling; must be the same value for all work enqueued for the same class.
work Intent: The Intent of work to enqueue.

enqueueWork

open static fun enqueueWork(
    @NonNull context: Context, 
    @NonNull component: ComponentName, 
    jobId: Int, 
    @NonNull work: Intent
): Unit

Like enqueueWork(Context, Class, int, Intent), but supplies a ComponentName for the service to interact with instead of its class.

Parameters
context Context: Context this is being called from.
component ComponentName: The published ComponentName of the class this work should be dispatched to.
jobId Int: A unique job ID for scheduling; must be the same value for all work enqueued for the same class.
work Intent: The Intent of work to enqueue.

isStopped

open fun isStopped(): Boolean

Returns true if onStopCurrentWork() has been called. You can use this, while executing your work, to see if it should be stopped.

onBind

open fun onBind(@NonNull intent: Intent): IBinder!

Returns the IBinder for the android.app.job.JobServiceEngine when running as a JobService on O and later platforms.

onCreate

open fun onCreate(): Unit

onDestroy

open fun onDestroy(): Unit

onStartCommand

open fun onStartCommand(
    @Nullable intent: Intent?, 
    flags: Int, 
    startId: Int
): Int

Processes start commands when running as a pre-O service, enqueueing them to be later dispatched in onHandleWork(Intent).

onStopCurrentWork

open fun onStopCurrentWork(): Boolean

This will be called if the JobScheduler has decided to stop this job. The job for this service does not have any constraints specified, so this will only generally happen if the service exceeds the job's maximum execution time.

Return
Boolean: True to indicate to the JobManager whether you'd like to reschedule this work, false to drop this and all following work. Regardless of the value returned, your service must stop executing or the system will ultimately kill it. The default implementation returns true, and that is most likely what you want to return as well (so no work gets lost).

setInterruptIfStopped

open fun setInterruptIfStopped(interruptIfStopped: Boolean): Unit

Control whether code executing in onHandleWork(Intent) will be interrupted if the job is stopped. By default this is false. If called and set to true, any time onStopCurrentWork() is called, the class will first call AsyncTask.cancel(true) to interrupt the running task.

Parameters
interruptIfStopped Boolean: Set to true to allow the system to interrupt actively running work.

Protected methods

onHandleWork

protected abstract fun onHandleWork(@NonNull intent: Intent): Unit

Called serially for each work dispatched to and processed by the service. This method is called on a background thread, so you can do long blocking operations here. Upon returning, that work will be considered complete and either the next pending work dispatched here or the overall service destroyed now that it has nothing else to do.

Be aware that when running as a job, you are limited by the maximum job execution time and any single or total sequential items of work that exceeds that limit will cause the service to be stopped while in progress and later restarted with the last unfinished work. (There is currently no limit on execution duration when running as a pre-O plain Service.)

Parameters
intent Intent: The intent describing the work to now be processed.