core/java/android/app/job/JobScheduler.java

   1 /*
   2  * Copyright (C) 2014 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License
  15  */
  16
  17 package android.app.job;
  18
  19 import java.util.List;
  20
  21 import android.content.Context;
  22
  23 /**
  24  * This is an API for scheduling various types of jobs against the framework that will be executed
  25  * in your application's own process.
  26  * <p>
  27  * See {@link android.app.job.JobInfo} for more description of the types of jobs that can be run
  28  * and how to construct them. You will construct these JobInfo objects and pass them to the
  29  * JobScheduler with {@link #schedule(JobInfo)}. When the criteria declared are met, the
  30  * system will execute this job on your application's {@link android.app.job.JobService}.
  31  * You identify which JobService is meant to execute the logic for your job when you create the
  32  * JobInfo with {@link android.app.job.JobInfo.Builder#Builder(int, android.content.ComponentName)}.
  33  * </p>
  34  * <p>
  35  * The framework will be intelligent about when you receive your callbacks, and attempt to batch
  36  * and defer them as much as possible. Typically if you don't specify a deadline on your job, it
  37  * can be run at any moment depending on the current state of the JobScheduler's internal queue,
  38  * however it might be deferred as long as until the next time the device is connected to a power
  39  * source.
  40  * </p>
  41  * <p>You do not
  42  * instantiate this class directly; instead, retrieve it through
  43  * {@link android.content.Context#getSystemService
  44  * Context.getSystemService(Context.JOB_SCHEDULER_SERVICE)}.
  45  */
  46 public abstract class JobScheduler {
  47     /**
  48      * Returned from {@link #schedule(JobInfo)} when an invalid parameter was supplied. This can occur
  49      * if the run-time for your job is too short, or perhaps the system can't resolve the
  50      * requisite {@link JobService} in your package.
  51      */
  52     public static final int RESULT_FAILURE = 0;
  53     /**
  54      * Returned from {@link #schedule(JobInfo)} if this application has made too many requests for
  55      * work over too short a time.
  56      */
  57     // TODO: Determine if this is necessary.
  58     public static final int RESULT_SUCCESS = 1;
  59
  60     /**
  61      * @param job The job you wish scheduled. See
  62      * {@link android.app.job.JobInfo.Builder JobInfo.Builder} for more detail on the sorts of jobs
  63      * you can schedule.
  64      * @return If >0, this int returns the jobId of the successfully scheduled job.
  65      * Otherwise you have to compare the return value to the error codes defined in this class.
  66      */
  67     public abstract int schedule(JobInfo job);
  68
  69     /**
  70      * Cancel a job that is pending in the JobScheduler.
  71      * @param jobId unique identifier for this job. Obtain this value from the jobs returned by
  72      * {@link #getAllPendingJobs()}.
  73      * @return
  74      */
  75     public abstract void cancel(int jobId);
  76
  77     /**
  78      * Cancel all jobs that have been registered with the JobScheduler by this package.
  79      */
  80     public abstract void cancelAll();
  81
  82     /**
  83      * @return a list of all the jobs registered by this package that have not yet been executed.
  84      */
  85     public abstract List<JobInfo> getAllPendingJobs();
  86
  87 }