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)
.
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Cancel a job that is pending in the JobScheduler.
| |||||||||||
Cancel all jobs that have been registered with the JobScheduler by this package.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
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.
Returned from schedule(JobInfo)
if this application has made too many requests for
work over too short a time.
Cancel a job that is pending in the JobScheduler.
jobId | unique identifier for this job. Obtain this value from the jobs returned by
getAllPendingJobs() . |
---|
Cancel all jobs that have been registered with the JobScheduler by this package.
job | The job you wish scheduled. See
JobInfo.Builder for more detail on the sorts of jobs
you can schedule. |
---|