Android APIs
public abstract class

JobScheduler

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

Class Overview

Class for scheduling various types of jobs with the scheduling framework on the device.

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 application has made too many requests for work over too short a time.
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()
abstract int schedule(JobInfo job)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final 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)

public static final int RESULT_SUCCESS

Returned from schedule(JobInfo) if this application has made too many requests for work over too short a time.

Constant Value: 1 (0x00000001)

Public Constructors

public JobScheduler ()

Public Methods

public abstract void cancel (int jobId)

Cancel a job that is pending in the JobScheduler.

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

public abstract void cancelAll ()

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

public abstract List<JobInfo> getAllPendingJobs ()

Returns
  • a list of all the jobs registered by this package that have not yet been executed.

public abstract int schedule (JobInfo job)

Parameters
job The job you wish scheduled. See JobInfo.Builder for more detail on the sorts of jobs you can schedule.
Returns
  • If >0, this int returns the jobId of the successfully scheduled job. Otherwise you have to compare the return value to the error codes defined in this class.