Skip to content

Most visited

Recently visited

navigation

JobScheduler

public abstract class JobScheduler
extends Object

java.lang.Object
   ↳ android.app.job.JobScheduler


This is an API for scheduling various types of jobs against the framework that will be executed in your application's own process.

See JobInfo for more description of the types of jobs that can be run and how to construct them. You will construct these JobInfo objects and pass them to the JobScheduler with schedule(JobInfo). When the criteria declared are met, the system will execute this job on your application's JobService. You identify which JobService is meant to execute the logic for your job when you create the JobInfo with JobInfo.Builder(int, android.content.ComponentName).

The framework will be intelligent about when you receive your callbacks, and attempt to batch and defer them as much as possible. Typically if you don't specify a deadline on your job, it can be run at any moment depending on the current state of the JobScheduler's internal queue, however it might be deferred as long as until the next time the device is connected to a power source.

You do not instantiate this class directly; instead, retrieve it through Context.getSystemService(Context.JOB_SCHEDULER_SERVICE).

Summary

Constants

int RESULT_FAILURE

Returned from schedule(JobInfo) when an invalid parameter was supplied.

int RESULT_SUCCESS

Returned from schedule(JobInfo) if this job has been successfully scheduled.

Public constructors

JobScheduler()

Public methods

abstract void cancel(int jobId)

Cancel a job that is pending in the JobScheduler.

abstract void cancelAll()

Cancel all jobs that have been registered with the JobScheduler by this package.

abstract int enqueue(JobInfo job, JobWorkItem work)

Similar to schedule(JobInfo), but allows you to enqueue work for a new or existing job.

abstract List<JobInfo> getAllPendingJobs()

Retrieve all jobs for this package that are pending in the JobScheduler.

abstract JobInfo getPendingJob(int jobId)

Retrieve a specific job for this package that is pending in the JobScheduler.

abstract int schedule(JobInfo job)

Schedule a job to be executed.

Inherited methods

From class java.lang.Object

Constants

RESULT_FAILURE

added in API level 21
int RESULT_FAILURE

Returned from schedule(JobInfo) when an invalid parameter was supplied. This can occur if the run-time for your job is too short, or perhaps the system can't resolve the requisite JobService in your package.

Constant Value: 0 (0x00000000)

RESULT_SUCCESS

added in API level 21
int RESULT_SUCCESS

Returned from schedule(JobInfo) if this job has been successfully scheduled.

Constant Value: 1 (0x00000001)

Public constructors

JobScheduler

added in API level 21
JobScheduler ()

Public methods

cancel

added in API level 21
void cancel (int jobId)

Cancel a job that is pending in the JobScheduler.

Parameters
jobId int: unique identifier for this job. Obtain this value from the jobs returned by getAllPendingJobs().

cancelAll

added in API level 21
void cancelAll ()

Cancel all jobs that have been registered with the JobScheduler by this package.

enqueue

int enqueue (JobInfo job, 
                JobWorkItem work)

Similar to schedule(JobInfo), but allows you to enqueue work for a new or existing job. If a job with the same ID is already scheduled, it will be replaced with the new JobInfo, but any previously enqueued work will remain and be dispatched the next time it runs. If a job with the same ID is already running, the new work will be enqueued for it.

The work you enqueue is later retrieved through JobParameters.dequeueWork. Be sure to see there about how to process work; the act of enqueueing work changes how you should handle the overall lifecycle of an executing job.

It is strongly encouraged that you use the same JobInfo for all work you enqueue. This will allow the system to optimally schedule work along with any pending and/or currently running work. If the JobInfo changes from the last time the job was enqueued, the system will need to update the associated JobInfo, which can cause a disruption in execution. In particular, this can result in any currently running job that is processing previous work to be stopped and restarted with the new JobInfo.

It is recommended that you avoid using setExtras(PersistableBundle) or setTransientExtras(Bundle) with a JobInfo you are using to enqueue work. The system will try to compare these extras with the previous JobInfo, but there are situations where it may get this wrong and count the JobInfo as changing. (That said, you should be relatively safe with a simple set of consistent data in these fields.) You should never use setClipData(ClipData, int) with work you are enqueue, since currently this will always be treated as a different JobInfo, even if the ClipData contents are exactly the same.

Parameters
job JobInfo: The job you wish to enqueue work for. See JobInfo.Builder for more detail on the sorts of jobs you can schedule.

This value must never be null.

work JobWorkItem: New work to enqueue. This will be available later when the job starts running.

This value must never be null.

Returns
int the result of the enqueue request.

Value is RESULT_FAILURE or RESULT_SUCCESS.

getAllPendingJobs

added in API level 21
List<JobInfo> getAllPendingJobs ()

Retrieve all jobs for this package that are pending in the JobScheduler.

Returns
List<JobInfo> a list of all the jobs registered by this package that have not yet been executed.

This value will never be null.

getPendingJob

added in API level 24
JobInfo getPendingJob (int jobId)

Retrieve a specific job for this package that is pending in the JobScheduler.

Parameters
jobId int

Returns
JobInfo job registered by this package that has not yet been executed.

This value may be null.

schedule

added in API level 21
int schedule (JobInfo job)

Schedule a job to be executed. Will replace any currently scheduled job with the same ID with the new information in the JobInfo. If a job with the given ID is currently running, it will be stopped.

Parameters
job JobInfo: The job you wish scheduled. See JobInfo.Builder for more detail on the sorts of jobs you can schedule.

This value must never be null.

Returns
int the result of the schedule request.

Value is RESULT_FAILURE or RESULT_SUCCESS.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.