A B C D E F G H I J L M N O R S T U V

A

addConstraint(int) - Method in class com.firebase.jobdispatcher.Job.Builder

Adds the provided constraint to the current list of runtime constraints.

B

build() - Method in class com.firebase.jobdispatcher.Job.Builder

Builds the Job, using the settings provided so far.

C

cancel(String) - Method in interface com.firebase.jobdispatcher.Driver

Cancels the job with the provided tag and class.

cancel(String) - Method in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Attempts to cancel the Job that matches the provided tag and endpoint.

cancel(String) - Method in class com.firebase.jobdispatcher.GooglePlayDriver

CANCEL_RESULT_NO_DRIVER_AVAILABLE - Static variable in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Indicates the cancel request failed because the driver was unavailable.

CANCEL_RESULT_SUCCESS - Static variable in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Indicates the cancel request seems to have been successful.

CANCEL_RESULT_UNKNOWN_ERROR - Static variable in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Indicates the cancel request encountered an unknown error.

cancelAll() - Method in interface com.firebase.jobdispatcher.Driver

Cancels all jobs registered with this Driver.

cancelAll() - Method in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Attempts to cancel all Jobs registered for this package.

cancelAll() - Method in class com.firebase.jobdispatcher.GooglePlayDriver

com.firebase.jobdispatcher - package com.firebase.jobdispatcher

Constraint - Class in com.firebase.jobdispatcher

A Constraint is a runtime requirement for a job.

Constraint.JobConstraint - Annotation Type in com.firebase.jobdispatcher

A tooling type-hint for any of the valid constraint values.

contentUriTrigger(List<ObservedUri>) - Static method in class com.firebase.jobdispatcher.Trigger

Creates a new ContentUriTrigger based on the provided list of ObservedUri.

createBatchCancelRequest() - Method in class com.firebase.jobdispatcher.GooglePlayDriver

createCancelRequest(String) - Method in class com.firebase.jobdispatcher.GooglePlayDriver

D

DEFAULT_EXPONENTIAL - Static variable in class com.firebase.jobdispatcher.RetryStrategy

Expected schedule is: [30s, 60s, 120s, 240s, ..., 3600s]

DEFAULT_LINEAR - Static variable in class com.firebase.jobdispatcher.RetryStrategy

Expected schedule is: [30s, 60s, 90s, 120s, ..., 3600s]

DefaultJobValidator - Class in com.firebase.jobdispatcher

Validates Jobs according to some safe standards.

DefaultJobValidator(Context) - Constructor for class com.firebase.jobdispatcher.DefaultJobValidator

DEVICE_CHARGING - Static variable in class com.firebase.jobdispatcher.Constraint

Only run the job when the device is currently charging.

DEVICE_IDLE - Static variable in class com.firebase.jobdispatcher.Constraint

Only run the job when the device is idle.

Driver - Interface in com.firebase.jobdispatcher

Driver represents a component that understands how to schedule, validate, and execute jobs.

dump(FileDescriptor, PrintWriter, String[]) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

E

ensureValid(JobParameters) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

Throws a RuntimeException if the provided JobParameters is invalid.

ensureValid(JobTrigger) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

Throws a RuntimeException if the provided JobTrigger is invalid.

ensureValid(RetryStrategy) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

Throws a RuntimeException if the provided RetryStrategy is invalid.

equals(Object) - Method in class com.firebase.jobdispatcher.ObservedUri

executionWindow(int, int) - Static method in class com.firebase.jobdispatcher.Trigger

Creates a new ExecutionWindow based on the provided time interval.

F

FirebaseJobDispatcher - Class in com.firebase.jobdispatcher

Deprecated.

Firebase Job Dispatcher is deprecated. Apps should migrate to WorkManager before Apr 7, 2020. Please see FJD's README.md file for more information.

FirebaseJobDispatcher(Driver) - Constructor for class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Instantiates a new FirebaseJobDispatcher using the provided Driver.

FirebaseJobDispatcher.CancelResult - Annotation Type in com.firebase.jobdispatcher

Deprecated.

Results that can legally be returned from FirebaseJobDispatcher.cancel(String) or FirebaseJobDispatcher.cancelAll() calls.

FirebaseJobDispatcher.ScheduleFailedException - Exception in com.firebase.jobdispatcher

Deprecated.

Thrown when a FirebaseJobDispatcher.schedule(com.firebase.jobdispatcher.Job) call fails.

FirebaseJobDispatcher.ScheduleResult - Annotation Type in com.firebase.jobdispatcher

Deprecated.

Results that can legally be returned from FirebaseJobDispatcher.schedule(Job) calls.

FLAG_NOTIFY_FOR_DESCENDANTS - Static variable in annotation type com.firebase.jobdispatcher.ObservedUri.Flags

Triggers if any descendants of the given URI change.

FOREVER - Static variable in class com.firebase.jobdispatcher.Lifetime

The Job should be preserved "forever."

G

getConstraints() - Method in class com.firebase.jobdispatcher.Job.Builder

The runtime constraints applied to this Job.

getConstraints() - Method in class com.firebase.jobdispatcher.Job

The runtime constraints applied to this Job.

getConstraints() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

The runtime constraints applied to this Job.

getErrors() - Method in exception com.firebase.jobdispatcher.ValidationEnforcer.ValidationException

getExtras() - Method in class com.firebase.jobdispatcher.Job.Builder

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

getExtras() - Method in class com.firebase.jobdispatcher.Job

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

getExtras() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

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

getFlags() - Method in class com.firebase.jobdispatcher.ObservedUri

getInitialBackoff() - Method in class com.firebase.jobdispatcher.RetryStrategy

Returns the initial backoff (i.e.

getLifetime() - Method in class com.firebase.jobdispatcher.Job.Builder

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

getLifetime() - Method in class com.firebase.jobdispatcher.Job

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

getLifetime() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

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

getMaximumBackoff() - Method in class com.firebase.jobdispatcher.RetryStrategy

Returns the maximum backoff duration in seconds.

getPolicy() - Method in class com.firebase.jobdispatcher.RetryStrategy

Returns the backoff policy in place.

getReceiverClass() - Method in class com.firebase.jobdispatcher.GooglePlayDriver

getRetryStrategy() - Method in class com.firebase.jobdispatcher.Job.Builder

The RetryStrategy for the Job.

getRetryStrategy() - Method in class com.firebase.jobdispatcher.Job

The RetryStrategy for the Job.

getRetryStrategy() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

The RetryStrategy for the Job.

getService() - Method in class com.firebase.jobdispatcher.Job.Builder

Returns the name of the backing JobService class.

getService() - Method in class com.firebase.jobdispatcher.Job

Returns the name of the backing JobService class.

getService() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

Returns the name of the backing JobService class.

getTag() - Method in class com.firebase.jobdispatcher.Job.Builder

Returns a string identifier for the Job.

getTag() - Method in class com.firebase.jobdispatcher.Job

Returns a string identifier for the Job.

getTag() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

Returns a string identifier for the Job.

getTrigger() - Method in class com.firebase.jobdispatcher.Job.Builder

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

getTrigger() - Method in class com.firebase.jobdispatcher.Job

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

getTrigger() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

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

getTriggeredContentUris() - Method in class com.firebase.jobdispatcher.TriggerReason

getTriggerReason() - Method in class com.firebase.jobdispatcher.Job.Builder

getTriggerReason() - Method in class com.firebase.jobdispatcher.Job

getTriggerReason() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

getUri() - Method in class com.firebase.jobdispatcher.ObservedUri

getUris() - Method in class com.firebase.jobdispatcher.JobTrigger.ContentUriTrigger

getValidator() - Method in interface com.firebase.jobdispatcher.Driver

Returns a JobValidator configured for this backend.

getValidator() - Method in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Returns a ValidationEnforcer configured for the current Driver.

getValidator() - Method in class com.firebase.jobdispatcher.GooglePlayDriver

getWindowEnd() - Method in class com.firebase.jobdispatcher.JobTrigger.ExecutionWindowTrigger

getWindowStart() - Method in class com.firebase.jobdispatcher.JobTrigger.ExecutionWindowTrigger

GooglePlayDriver - Class in com.firebase.jobdispatcher

GooglePlayDriver provides an implementation of Driver for devices with Google Play services installed.

GooglePlayDriver(Context) - Constructor for class com.firebase.jobdispatcher.GooglePlayDriver

Instantiates a new GooglePlayDriver.

GooglePlayReceiver - Class in com.firebase.jobdispatcher

Handles incoming execute requests from the GooglePlay driver and forwards them to your Service.

GooglePlayReceiver() - Constructor for class com.firebase.jobdispatcher.GooglePlayReceiver

H

hashCode() - Method in class com.firebase.jobdispatcher.ObservedUri

I

isAvailable() - Method in interface com.firebase.jobdispatcher.Driver

Indicates whether the backend is available.

isAvailable() - Method in class com.firebase.jobdispatcher.GooglePlayDriver

isRecurring() - Method in class com.firebase.jobdispatcher.Job.Builder

Whether the Job should repeat.

isRecurring() - Method in class com.firebase.jobdispatcher.Job

Whether the Job should repeat.

isRecurring() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

Whether the Job should repeat.

isValid(JobParameters) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

Indicates whether the provided JobParameters is valid.

isValid(JobTrigger) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

Indicates whether the provided JobTrigger is valid.

isValid(RetryStrategy) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

Indicates whether the provided RetryStrategy is valid.

J

Job - Class in com.firebase.jobdispatcher

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

Job.Builder - Class in com.firebase.jobdispatcher

A class that understands how to build a Job.

JobCallback - Interface in com.firebase.jobdispatcher

JobCallback describes an object that knows how to send a JobResult back to the underlying execution driver.

jobFinished(int) - Method in interface com.firebase.jobdispatcher.JobCallback

jobFinished(JobParameters, boolean) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

Callback to inform the scheduling driver that you've finished executing.

JobParameters - Interface in com.firebase.jobdispatcher

Deprecated.

Firebase Job Dispatcher is deprecated. Apps should migrate to WorkManager before Apr 7, 2020. Please see FJD's README.md file for more information.

JobService - Class in com.firebase.jobdispatcher

Deprecated.

Firebase Job Dispatcher is deprecated. Apps should migrate to WorkManager before Apr 7, 2020. Please see FJD's README.md file for more information.

JobService() - Constructor for class com.firebase.jobdispatcher.JobService

Deprecated.

JobService.JobResult - Annotation Type in com.firebase.jobdispatcher

Deprecated.

The result returned from a job execution.

JobTrigger - Class in com.firebase.jobdispatcher

Contains all supported triggers.

JobTrigger() - Constructor for class com.firebase.jobdispatcher.JobTrigger

JobTrigger.ContentUriTrigger - Class in com.firebase.jobdispatcher

A trigger that will be triggered on content update for any of provided uris.

JobTrigger.ExecutionWindowTrigger - Class in com.firebase.jobdispatcher

ExecutionWindow represents a Job trigger that becomes eligible once the current elapsed time exceeds the scheduled time + the windowStart value.

JobTrigger.ImmediateTrigger - Class in com.firebase.jobdispatcher

ImmediateTrigger is a Trigger that's immediately available.

JobValidator - Interface in com.firebase.jobdispatcher

A JobValidator is an object that knows how to validate Jobs and some of their composite components.

L

Lifetime - Class in com.firebase.jobdispatcher

Lifetime represents how long a Job should last.

Lifetime() - Constructor for class com.firebase.jobdispatcher.Lifetime

M

MAX_EXTRAS_SIZE_BYTES - Static variable in class com.firebase.jobdispatcher.DefaultJobValidator

The maximum size, in bytes, that the provided extras bundle can be.

MAX_TAG_LENGTH - Static variable in class com.firebase.jobdispatcher.DefaultJobValidator

The maximum length of a tag, in characters (i.e.

mustSchedule(Job) - Method in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Attempts to schedule the provided Job, throwing an exception if it fails.

N

newJobBuilder() - Method in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Creates a new Job.Builder, configured with the current driver's validation settings.

newRetryStrategy(int, int, int) - Method in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Creates a new RetryStrategy from the provided parameters, validated with the current driver's JobValidator.

NOW - Static variable in class com.firebase.jobdispatcher.Trigger

Immediate is a Trigger that's immediately available.

O

ObservedUri - Class in com.firebase.jobdispatcher

Represents a single observed URI and any associated flags.

ObservedUri(Uri, int) - Constructor for class com.firebase.jobdispatcher.ObservedUri

Create a new ObservedUri.

ObservedUri.Flags - Annotation Type in com.firebase.jobdispatcher

Flag enforcement.

ON_ANY_NETWORK - Static variable in class com.firebase.jobdispatcher.Constraint

Only run the job when a network connection is available.

ON_UNMETERED_NETWORK - Static variable in class com.firebase.jobdispatcher.Constraint

Only run the job when an unmetered network is available.

onBind(Intent) - Method in class com.firebase.jobdispatcher.GooglePlayReceiver

onBind(Intent) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

onConfigurationChanged(Configuration) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

onJobFinished(JobInvocation, int) - Method in class com.firebase.jobdispatcher.GooglePlayReceiver

onRebind(Intent) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

onRunJob(JobParameters) - Method in class com.firebase.jobdispatcher.SimpleJobService

onStart(Intent, int) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

onStartCommand(Intent, int, int) - Method in class com.firebase.jobdispatcher.GooglePlayReceiver

onStartCommand(Intent, int, int) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

onStartJob(JobParameters) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

The entry point to your Job.

onStartJob(JobParameters) - Method in class com.firebase.jobdispatcher.SimpleJobService

onStopJob(JobParameters) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

Called when the scheduling engine has decided to interrupt the execution of a running job, most likely because the runtime constraints associated with the job are no longer satisfied.

onStopJob(JobParameters) - Method in class com.firebase.jobdispatcher.SimpleJobService

onTaskRemoved(Intent) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

onUnbind(Intent) - Method in class com.firebase.jobdispatcher.JobService

Deprecated.

R

RESULT_FAIL_NORETRY - Static variable in class com.firebase.jobdispatcher.JobService

Deprecated.

Returned to indicate the job encountered an error during execution but should not be retried.

RESULT_FAIL_RETRY - Static variable in class com.firebase.jobdispatcher.JobService

Deprecated.

Returned to indicate the job encountered an error during execution and should be retried after a backoff period.

RESULT_SUCCESS - Static variable in class com.firebase.jobdispatcher.JobService

Deprecated.

Returned to indicate the job was executed successfully.

RETRY_POLICY_EXPONENTIAL - Static variable in class com.firebase.jobdispatcher.RetryStrategy

Increase the backoff time exponentially.

RETRY_POLICY_LINEAR - Static variable in class com.firebase.jobdispatcher.RetryStrategy

Increase the backoff time linearly.

RetryStrategy - Class in com.firebase.jobdispatcher

RetryStrategy represents an approach to handling job execution failures.

RetryStrategy.RetryPolicy - Annotation Type in com.firebase.jobdispatcher

Defines the list of acceptable retry policies.

S

schedule(Job) - Method in interface com.firebase.jobdispatcher.Driver

Schedules the provided Job.

schedule(Job) - Method in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Attempts to schedule the provided Job.

schedule(Job) - Method in class com.firebase.jobdispatcher.GooglePlayDriver

Schedules the provided Job.

SCHEDULE_RESULT_BAD_SERVICE - Static variable in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Indicates the schedule request failed because the service is not exposed or configured correctly.

SCHEDULE_RESULT_NO_DRIVER_AVAILABLE - Static variable in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Indicates the schedule request failed because the driver was unavailable.

SCHEDULE_RESULT_SUCCESS - Static variable in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Indicates the schedule request seems to have been successful.

SCHEDULE_RESULT_UNKNOWN_ERROR - Static variable in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Indicates the schedule request encountered an unknown error.

SCHEDULE_RESULT_UNSUPPORTED_TRIGGER - Static variable in class com.firebase.jobdispatcher.FirebaseJobDispatcher

Deprecated.

Indicates the schedule request failed because the Trigger was unsupported.

ScheduleFailedException() - Constructor for exception com.firebase.jobdispatcher.FirebaseJobDispatcher.ScheduleFailedException

Deprecated.

setConstraints(int...) - Method in class com.firebase.jobdispatcher.Job.Builder

Sets the Job's runtime constraints.

setExtras(Bundle) - Method in class com.firebase.jobdispatcher.Job.Builder

Sets the user-defined extras associated with the Job.

setLifetime(int) - Method in class com.firebase.jobdispatcher.Job.Builder

Sets the Job's lifetime, or how long it should persist.

setRecurring(boolean) - Method in class com.firebase.jobdispatcher.Job.Builder

Sets whether the job should recur.

setReplaceCurrent(boolean) - Method in class com.firebase.jobdispatcher.Job.Builder

Sets whether this Job should replace pre-existing Jobs with the same tag.

setRetryStrategy(RetryStrategy) - Method in class com.firebase.jobdispatcher.Job.Builder

Set the RetryStrategy used for the Job.

setService(Class<? extends JobService>) - Method in class com.firebase.jobdispatcher.Job.Builder

Sets the backing JobService class for the Job.

setTag(String) - Method in class com.firebase.jobdispatcher.Job.Builder

Sets the unique String tag used to identify the Job.

setTrigger(JobTrigger) - Method in class com.firebase.jobdispatcher.Job.Builder

Sets the Trigger used for the Job.

shouldReplaceCurrent() - Method in class com.firebase.jobdispatcher.Job.Builder

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

shouldReplaceCurrent() - Method in class com.firebase.jobdispatcher.Job

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

shouldReplaceCurrent() - Method in interface com.firebase.jobdispatcher.JobParameters

Deprecated.

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

SimpleJobService - Class in com.firebase.jobdispatcher

SimpleJobService provides a simple way of doing background work in a JobService.

SimpleJobService() - Constructor for class com.firebase.jobdispatcher.SimpleJobService

T

Trigger - Class in com.firebase.jobdispatcher

Generally, a Trigger is an object that can answer the question, "is this job ready to run?"

Trigger() - Constructor for class com.firebase.jobdispatcher.Trigger

TriggerReason - Class in com.firebase.jobdispatcher

The class contains a summary of the events which caused the job to be executed.

U

UNTIL_NEXT_BOOT - Static variable in class com.firebase.jobdispatcher.Lifetime

The Job should be preserved until the next boot.

V

validate(JobParameters) - Method in class com.firebase.jobdispatcher.DefaultJobValidator

Attempts to validate the provided JobParameters.

validate(JobTrigger) - Method in class com.firebase.jobdispatcher.DefaultJobValidator

Attempts to validate the provided Trigger.

validate(RetryStrategy) - Method in class com.firebase.jobdispatcher.DefaultJobValidator

Attempts to validate the provided RetryStrategy.

validate(JobParameters) - Method in interface com.firebase.jobdispatcher.JobValidator

Returns a List of error messages, or null if the JobParameters is valid.

validate(JobTrigger) - Method in interface com.firebase.jobdispatcher.JobValidator

Returns a List of error messages, or null if the Trigger is valid.

validate(RetryStrategy) - Method in interface com.firebase.jobdispatcher.JobValidator

Returns a List of error messages, or null if the RetryStrategy is valid.

validate(JobParameters) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

validate(JobTrigger) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

validate(RetryStrategy) - Method in class com.firebase.jobdispatcher.ValidationEnforcer

ValidationEnforcer - Class in com.firebase.jobdispatcher

Wraps a JobValidator and provides helpful validation utilities.

ValidationEnforcer(JobValidator) - Constructor for class com.firebase.jobdispatcher.ValidationEnforcer

ValidationEnforcer.ValidationException - Exception in com.firebase.jobdispatcher

An Exception thrown when a validation error is encountered.

ValidationException(String, List<String>) - Constructor for exception com.firebase.jobdispatcher.ValidationEnforcer.ValidationException

A B C D E F G H I J L M N O R S T U V