JobManager (library API)

java.lang.Object
- com.evernote.android.job.JobManager

```
public final class JobManager
extends java.lang.Object
```
Entry point for scheduling jobs. Depending on the platform and SDK version it uses different APIs to schedule jobs. The JobScheduler is preferred, if the OS is running Lollipop or above. Otherwise it uses the AlarmManager as fallback. It's also possible to use the GcmNetworkManager, if the manager can be found in your classpath, the Google Play Services are installed and the service was added in the manifest. Take a look at the README for more help.

Before you can use the JobManager you must call create(Context) first and add a JobCreator to map tags to your desired jobs with addJobCreator(JobCreator). It's recommended to do this in the Application.onCreate() method.

In order to schedule a job you must extend the Job class. A Job is a simple class with one abstract method which is invoked on a background thread. Thus a Job doesn't need to be registered in the manifest. Create a JobRequest with the corresponding JobRequest.Builder, set your desired parameters and call schedule(JobRequest). If you want to update a pending request, call JobRequest.cancelAndEdit() on the request, update your parameters and call schedule(JobRequest) again.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class JobManager.Config

Nested Classes
Modifier and Type	Class and Description
`class`	`JobManager.Config`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addJobCreator(JobCreator jobCreator)` Registers this instance to create jobs for a specific tag.
`boolean`	`cancel(int jobId)` Cancel either the pending `JobRequest` or the running `Job`.
`int`	`cancelAll()` Cancel all pending JobRequests and running jobs.
`int`	`cancelAllForTag(java.lang.String tag)` Cancel all pending JobRequests and running jobs.
`static JobManager`	`create(android.content.Context context)` Initializes the singleton.
`static JobManager`	`create(android.content.Context context, JobCreator jobCreator)` Deprecated. Use `create(Context)` instead and call `addJobCreator(JobCreator)` after that.
`void`	`forceApi(JobApi api)` WARNING: You shouldn't call this method.
`java.util.Set<JobRequest>`	`getAllJobRequests()`
`java.util.Set<JobRequest>`	`getAllJobRequestsForTag(java.lang.String tag)`
`java.util.Set<Job>`	`getAllJobs()` Jobs are cached in memory even if they already have finished.
`java.util.Set<Job>`	`getAllJobsForTag(java.lang.String tag)` Jobs are cached in memory even if they already have finished.
`JobApi`	`getApi()` WARNING: Don't rely your logic on a specific `JobApi`.
`JobManager.Config`	`getConfig()`
`Job`	`getJob(int jobId)` Jobs are cached in memory even if they already have finished.
`JobRequest`	`getJobRequest(int jobId)`
`static JobManager`	`instance()` Ensure that you've called `create(Context)` first.
`void`	`removeJobCreator(JobCreator jobCreator)` Remove the mapping to stop it from creating new jobs.
`void`	`schedule(JobRequest request)` Schedule a request which will be executed in the future.
`protected void`	`setJobProxy(JobApi api)`
`void`	`setVerbose(boolean verbose)` Deprecated. Use `JobManager.Config.setVerbose(boolean)` instead.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static JobManager create(android.content.Context context)
```
    Initializes the singleton. It's necessary to call this function before using the JobManager. Calling it multiple times has not effect.
    
    Parameters:
    
    context - Any Context to instantiate the singleton object.
    
    Returns:
    
    The new or existing singleton object.
  - create
```
@Deprecated
public static JobManager create(android.content.Context context,
                                            JobCreator jobCreator)
```
    Deprecated. Use create(Context) instead and call addJobCreator(JobCreator) after that.
    
    Initializes the singleton. It's necessary to call this function before using the JobManager. Calling it multiple times has not effect.
    
    Parameters:
    
    context - Any Context to instantiate the singleton object.
    
    jobCreator - The mapping between a specific job tag and the job class.
    
    Returns:
    
    The new or existing singleton object.
  - instance
```
public static JobManager instance()
```
    Ensure that you've called create(Context) first. Otherwise this method throws an exception.
    
    Returns:
    
    The JobManager object.
  - getConfig
```
public JobManager.Config getConfig()
```
    Returns:
    
    The current configuration for the job manager.
  - setJobProxy
```
protected void setJobProxy(JobApi api)
```
  - schedule
```
public void schedule(JobRequest request)
```
    Schedule a request which will be executed in the future. If you want to update an existing JobRequest, call JobRequest.cancelAndEdit(), update your parameters and call this method again. Note that after a JobRequest was updated, it has a new unique ID. JobRequest
    
    Parameters:
    
    request - The JobRequest which will be run in the future.
  - getJobRequest
```
public JobRequest getJobRequest(int jobId)
```
    Parameters:
    
    jobId - The unique ID of the pending JobRequest.
    
    Returns:
    
    The JobRequest if it's pending or null otherwise.
  - getAllJobRequests
```
public java.util.Set<JobRequest> getAllJobRequests()
```
    Returns:
    
    A duplicate Set containing all pending JobRequests or an empty set. Never returns null. The set may be modified without direct effects to the actual backing store.
    
    See Also:
    
    getJobRequest(int)
  - getAllJobRequestsForTag
```
public java.util.Set<JobRequest> getAllJobRequestsForTag(java.lang.String tag)
```
    Parameters:
    
    tag - The tag of the pending requests.
    
    Returns:
    
    A duplicate Set containing all pending JobRequests associated with this tag or an empty set. Never returns null. The set may be modified without direct effects to the actual backing store.
  - getJob
```
public Job getJob(int jobId)
```
    Jobs are cached in memory even if they already have finished. But finished jobs are never restored after the app has launched.
    
    Parameters:
    
    jobId - The unique ID of the running or finished Job.
    
    Returns:
    
    The Job if it's running or has been finished and is still cached. Returns null otherwise.
  - getAllJobs
```
public java.util.Set<Job> getAllJobs()
```
    Jobs are cached in memory even if they already have finished. But finished jobs are never restored after the app has relaunched.
    
    Returns:
    
    A duplicate Set containing all running and cached finished jobs or an empty set. Never returns null. The set may be modified without direct effects to the actual backing store.
  - getAllJobsForTag
```
public java.util.Set<Job> getAllJobsForTag(java.lang.String tag)
```
    Jobs are cached in memory even if they already have finished. But finished jobs are never restored after the app has relaunched.
    
    Parameters:
    
    tag - The tag of the running or finished jobs.
    
    Returns:
    
    A duplicate Set containing all running and cached finished jobs associated with this tag or an empty set. Never returns null. The set may be modified without direct effects to the actual backing store.
  - forceApi
```
public void forceApi(JobApi api)
```
    WARNING: You shouldn't call this method. It only exists for testing and debugging purposes. The JobManager automatically decides which API suits best for a Job.
    
    Parameters:
    
    api - The JobApi which will be used for future scheduled JobRequests.
  - getApi
```
public JobApi getApi()
```
    WARNING: Don't rely your logic on a specific JobApi. You shouldn't be worrying about it.
    
    Returns:
    
    The current JobApi which will be used for future schedules JobRequests.
  - cancel
```
public boolean cancel(int jobId)
```
    Cancel either the pending JobRequest or the running Job.
    
    Parameters:
    
    jobId - The unique ID of the JobRequest or running Job.
    
    Returns:
    
    true if a request or job were found and canceled.
  - cancelAll
```
public int cancelAll()
```
    Cancel all pending JobRequests and running jobs.
    
    Returns:
    
    The count of canceled requests and running jobs.
  - cancelAllForTag
```
public int cancelAllForTag(java.lang.String tag)
```
    Cancel all pending JobRequests and running jobs.
    
    Parameters:
    
    tag - The tag of the pending job requests and running jobs.
    
    Returns:
    
    The count of canceled requests and running jobs.
  - setVerbose
```
@Deprecated
public void setVerbose(boolean verbose)
```
    Deprecated. Use JobManager.Config.setVerbose(boolean) instead.
    
    Global switch to enable or disable logging.
    
    Parameters:
    
    verbose - Whether or not to print log messages.
  - addJobCreator
```
public void addJobCreator(JobCreator jobCreator)
```
    Registers this instance to create jobs for a specific tag. It's possible to have multiple JobCreators with a first come first serve order.
    
    Parameters:
    
    jobCreator - The mapping between a specific job tag and the job class.
  - removeJobCreator
```
public void removeJobCreator(JobCreator jobCreator)
```
    Remove the mapping to stop it from creating new jobs.
    
    Parameters:
    
    jobCreator - The mapping between a specific job tag and the job class.

Class JobManager

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

instance

getConfig

setJobProxy

schedule

getJobRequest

getAllJobRequests

getAllJobRequestsForTag

getJob

getAllJobs

getAllJobsForTag

forceApi

getApi

cancel

cancelAll

cancelAllForTag

setVerbose

addJobCreator

removeJobCreator