| Interface | Description |
|---|---|
| Driver |
Driver represents a component that understands how to schedule, validate, and execute jobs.
|
| JobCallback |
JobCallback describes an object that knows how to send a JobResult back to the underlying
execution driver.
|
| JobParameters |
JobParameters represents anything that can describe itself in terms of Job components.
|
| JobValidator |
A JobValidator is an object that knows how to validate Jobs and some of their composite
components.
|
| Class | Description |
|---|---|
| Constraint |
A Constraint is a runtime requirement for a job.
|
| DefaultJobValidator |
Validates Jobs according to some safe standards.
|
| FirebaseJobDispatcher |
The FirebaseJobDispatcher provides a driver-agnostic API for scheduling and cancelling Jobs.
|
| GooglePlayDriver |
GooglePlayDriver provides an implementation of Driver for devices with Google Play
services installed.
|
| GooglePlayReceiver |
Handles incoming execute requests from the GooglePlay driver and forwards them to your Service.
|
| Job |
Job is the embodiment of a unit of work and an associated set of triggers, settings, and runtime
constraints.
|
| Job.Builder |
A class that understands how to build a
Job. |
| JobService |
JobService is the fundamental unit of work used in the JobDispatcher.
|
| JobTrigger | |
| JobTrigger.ExecutionWindowTrigger |
ExecutionWindow represents a Job trigger that becomes eligible once
the current elapsed time exceeds the scheduled time + the
windowStart
value. |
| JobTrigger.ImmediateTrigger | |
| Lifetime |
Lifetime represents how long a Job should last.
|
| RetryStrategy |
RetryStrategy represents an approach to handling job execution failures.
|
| SimpleJobService |
SimpleJobService provides a simple way of doing background work in a JobService.
|
| Trigger |
Generally, a Trigger is an object that can answer the question, "is this job ready to run?"
More specifically, a Trigger is an opaque, abstract class used to root the type hierarchy.
|
| ValidationEnforcer |
Wraps a JobValidator and provides helpful validation utilities.
|
| Exception | Description |
|---|---|
| FirebaseJobDispatcher.ScheduleFailedException |
Thrown when a
FirebaseJobDispatcher.schedule(com.firebase.jobdispatcher.Job) call
fails. |
| ValidationEnforcer.ValidationException |
An Exception thrown when a validation error is encountered.
|
| Annotation Type | Description |
|---|---|
| Constraint.JobConstraint |
A tooling type-hint for any of the valid constraint values.
|
| FirebaseJobDispatcher.CancelResult |
Results that can legally be returned from
FirebaseJobDispatcher.cancel(String) or FirebaseJobDispatcher.cancelAll()
calls. |
| FirebaseJobDispatcher.ScheduleResult |
Results that can legally be returned from
FirebaseJobDispatcher.schedule(Job) calls. |
| JobService.JobResult |
The result returned from a job execution.
|
| RetryStrategy.RetryPolicy |