public abstract class JobScheduler extends Object
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.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)
.
Modifier and Type | Field and Description |
---|---|
static int |
RESULT_FAILURE
Returned from
schedule(JobInfo) when an invalid parameter was supplied. |
static int |
RESULT_SUCCESS
Returned from
schedule(JobInfo) if this job has been successfully scheduled. |
Constructor and Description |
---|
JobScheduler() |
Modifier and Type | Method and Description |
---|---|
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) |
abstract int |
scheduleAsPackage(JobInfo job,
String packageName,
int userId,
String tag) |
public static final int RESULT_FAILURE
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.public static final int RESULT_SUCCESS
schedule(JobInfo)
if this job has been successfully scheduled.public abstract int schedule(JobInfo job)
job
- The job you wish scheduled. See
JobInfo.Builder
for more detail on the sorts of jobs
you can schedule.RESULT_SUCCESS
or RESULT_FAILURE
).public abstract int scheduleAsPackage(JobInfo job, String packageName, int userId, String tag)
job
- The job to be scheduled.packageName
- The package on behalf of which the job is to be scheduled. This will be
used to track battery usage and appIdleState.userId
- User on behalf of whom this job is to be scheduled.tag
- Debugging tag for dumps associated with this job (instead of the service class)RESULT_SUCCESS
or RESULT_FAILURE
public abstract void cancel(int jobId)
jobId
- unique identifier for this job. Obtain this value from the jobs returned by
getAllPendingJobs()
.public abstract void cancelAll()
public abstract List<JobInfo> getAllPendingJobs()
public abstract JobInfo getPendingJob(int jobId)