Interfaces
- JobInfo.BackoffPolicy
- JobInfo.NetworkType
Classes

public abstract class

JobService

extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.app.job.JobService

Class Overview

Entry point for the callback from the JobScheduler.

This is the base class that handles asynchronous requests that were previously scheduled. You are responsible for overriding onStartJob(JobParameters), which is where you will implement your job logic.

This service executes each incoming job on a Handler running on your application's main thread. This means that you must offload your execution logic to another thread/handler/AsyncTask of your choosing. Not doing so will result in blocking any future callbacks from the JobManager - specifically onStopJob(android.app.job.JobParameters), which is meant to inform you that the scheduling requirements are no longer being met.

Summary

Constants
String	PERMISSION_BIND	Job services must be protected with this permission: ...

[Expand]

Inherited Constants

From class android.app.Service

From class android.content.Context

From interface android.content.ComponentCallbacks2

Public Constructors
	JobService()

Public Methods
final void	jobFinished(JobParameters params, boolean needsReschedule) Callback to inform the JobManager you've finished executing.
abstract boolean	onStartJob(JobParameters params) Override this method with the callback logic for your job.
abstract boolean	onStopJob(JobParameters params) This method is called if the system has determined that you must stop execution of your job even before you've had a chance to call `jobFinished(JobParameters, boolean)`.

[Expand]

Inherited Methods

From class android.app.Service

void	dump(FileDescriptor fd, PrintWriter writer, String[] args) Print the Service's state into the given stream.
final Application	getApplication() Return the application that owns this service.
abstract IBinder	onBind(Intent intent) Return the communication channel to the service.
void	onConfigurationChanged(Configuration newConfig) Called by the system when the device configuration changes while your component is running.
void	onCreate() Called by the system when the service is first created.
void	onDestroy() Called by the system to notify a Service that it is no longer used and is being removed.
void	onLowMemory() This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
void	onRebind(Intent intent) Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its `onUnbind(Intent)`.
void	onStart(Intent intent, int startId) This method was deprecated in API level 5. Implement `onStartCommand(Intent, int, int)` instead.
int	onStartCommand(Intent intent, int flags, int startId) Called by the system every time a client explicitly starts the service by calling `startService(Intent)`, providing the arguments it supplied and a unique integer token representing the start request.
void	onTaskRemoved(Intent rootIntent) This is called if the service is currently running and the user has removed a task that comes from the service's application.
void	onTrimMemory(int level) Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
boolean	onUnbind(Intent intent) Called when all clients have disconnected from a particular interface published by the service.
final void	startForeground(int id, Notification notification) Make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state.
final void	stopForeground(boolean removeNotification) Remove this service from foreground state, allowing it to be killed if more memory is needed.
final void	stopSelf() Stop the service, if it was previously started.
final void	stopSelf(int startId) Old version of `stopSelfResult(int)` that doesn't return a result.
final boolean	stopSelfResult(int startId) Stop the service if the most recent time it was started was `startId`.

From class android.content.ContextWrapper

From class android.content.Context

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.content.ComponentCallbacks

From interface android.content.ComponentCallbacks2

Constants

public static final String PERMISSION_BIND

Job services must be protected with this permission:

...

If a job service is declared in the manifest but not protected with this permission, that service will be ignored by the OS.

Constant Value: "android.permission.BIND_JOB_SERVICE"

Public Constructors

public JobService ()

Public Methods

public final void jobFinished (JobParameters params, boolean needsReschedule)

Callback to inform the JobManager you've finished executing. This can be called from any thread, as it will ultimately be run on your application's main thread. When the system receives this message it will release the wakelock being held.

You can specify post-execution behaviour to the scheduler here with needsReschedule . This will apply a back-off timer to your job based on the default, or what was set with setBackoffCriteria(long, int). The original requirements are always honoured even for a backed-off job. Note that a job running in idle mode will not be backed-off. Instead what will happen is the job will be re-added to the queue and re-executed within a future idle maintenance window.

Parameters

params	Parameters specifying system-provided info about this job, this was given to your application in `onStartJob(JobParameters)`.
needsReschedule	True if this job is complete, false if you want the JobManager to reschedule you.

public abstract boolean onStartJob (JobParameters params)

Override this method with the callback logic for your job. Any such logic needs to be performed on a separate thread, as this function is executed on your application's main thread.

Parameters

params	Parameters specifying info about this job, including the extras bundle you optionally provided at job-creation time.

Returns

True if your service needs to process the work (on a separate thread). False if there's no more work to be done for this job.

public abstract boolean onStopJob (JobParameters params)

This method is called if the system has determined that you must stop execution of your job even before you've had a chance to call jobFinished(JobParameters, boolean).

This will happen if the requirements specified at schedule time are no longer met. For example you may have requested WiFi with setRequiredNetworkCapabilities(int), yet while your job was executing the user toggled WiFi. Another example is if you had specified setRequiresDeviceIdle(boolean), and the phone left its idle maintenance window. You are solely responsible for the behaviour of your application upon receipt of this message; your app will likely start to misbehave if you ignore it. One immediate repercussion is that the system will cease holding a wakelock for you.

Parameters

params	Parameters specifying info about this job.

Returns

True to indicate to the JobManager whether you'd like to reschedule this job based on the retry criteria provided at job creation-time. False to drop the job. Regardless of the value returned, your job must stop executing.

Results

Interfaces

Classes

JobService

Class Overview

Summary

Constants

public static final String PERMISSION_BIND

Public Constructors

public JobService ()

Public Methods

public final void jobFinished (JobParameters params, boolean needsReschedule)

Parameters

public abstract boolean onStartJob (JobParameters params)

Parameters

Returns

public abstract boolean onStopJob (JobParameters params)

Parameters

Returns