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 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)

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.

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.

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.

schedule

Added in API level 21
int schedule (JobInfo job)

Parameters
job JobInfo: The job you wish scheduled. See JobInfo.Builder for more detail on the sorts of jobs you can schedule.
Returns
int An int representing (RESULT_SUCCESS or RESULT_FAILURE).
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

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.