com.firebase.jobdispatcher

Class Job

java.lang.Object

com.firebase.jobdispatcher.Job

All Implemented Interfaces:

JobParameters

public final class Job
extends java.lang.Object
implements JobParameters

Job is the embodiment of a unit of work and an associated set of triggers, settings, and runtime constraints.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Job.Builder A class that understands how to build a Job.

Method Summary

Modifier and Type	Method and Description
int[]	getConstraints() The runtime constraints applied to this Job.
android.os.Bundle	getExtras() The optional set of user-supplied extras associated with this Job.
int	getLifetime() The Job's lifetime; how long it should persist for.
RetryStrategy	getRetryStrategy() The RetryStrategy for the Job.
java.lang.String	getService() Returns the name of the backing JobService class.
java.lang.String	getTag() Returns a string identifier for the Job.
JobTrigger	getTrigger() The Job's Trigger, which decides when the Job is ready to run.
boolean	isRecurring() Whether the Job should repeat.
boolean	shouldReplaceCurrent() Whether the Job should replace a pre-existing Job with the same tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConstraints

@NonNull
public int[] getConstraints()

The runtime constraints applied to this Job. A Job is not run until the trigger is activated and all the runtime constraints are satisfied.

Specified by:

getConstraints in interface JobParameters

getExtras

@Nullable
public android.os.Bundle getExtras()

The optional set of user-supplied extras associated with this Job.

Specified by:

getExtras in interface JobParameters

getRetryStrategy

@NonNull
public RetryStrategy getRetryStrategy()

The RetryStrategy for the Job. Used to determine how to handle failures.

Specified by:

getRetryStrategy in interface JobParameters

shouldReplaceCurrent

public boolean shouldReplaceCurrent()

Whether the Job should replace a pre-existing Job with the same tag.

Specified by:

shouldReplaceCurrent in interface JobParameters

getTag

@NonNull
public java.lang.String getTag()

Returns a string identifier for the Job. Used when cancelling Jobs and displaying debug messages.

Specified by:

getTag in interface JobParameters

getTrigger

@NonNull
public JobTrigger getTrigger()

The Job's Trigger, which decides when the Job is ready to run.

Specified by:

getTrigger in interface JobParameters

getLifetime

public int getLifetime()

The Job's lifetime; how long it should persist for.

Specified by:

getLifetime in interface JobParameters

isRecurring

public boolean isRecurring()

Whether the Job should repeat.

Specified by:

isRecurring in interface JobParameters

getService

@NonNull
public java.lang.String getService()

Returns the name of the backing JobService class.

Specified by:

getService in interface JobParameters