com.firebase.jobdispatcher

Interface JobParameters

All Known Implementing Classes:

Job, Job.Builder

public interface JobParameters

JobParameters represents anything that can describe itself in terms of Job components.

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.

Method Detail

getService

@NonNull
java.lang.String getService()

Returns the name of the backing JobService class.

getTag

@NonNull
java.lang.String getTag()

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

getTrigger

@NonNull
JobTrigger getTrigger()

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

getLifetime

int getLifetime()

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

isRecurring

boolean isRecurring()

Whether the Job should repeat.

getConstraints

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.

getExtras

@Nullable
android.os.Bundle getExtras()

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

getRetryStrategy

@NonNull
RetryStrategy getRetryStrategy()

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

shouldReplaceCurrent

boolean shouldReplaceCurrent()

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