FirebaseJobDispatcher (jobdispatcher 0.8.7 API)

java.lang.Object
- com.firebase.jobdispatcher.FirebaseJobDispatcher

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.
```
@Deprecated
public final class FirebaseJobDispatcher
extends java.lang.Object
```
The FirebaseJobDispatcher provides a driver-agnostic API for scheduling and cancelling Jobs.

See Also:

FirebaseJobDispatcher(Driver), Driver, JobParameters

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FirebaseJobDispatcher.CancelResult` Deprecated. Results that can legally be returned from `cancel(String)` or `cancelAll()` calls.
`static class`	`FirebaseJobDispatcher.ScheduleFailedException` Deprecated. Thrown when a `schedule(com.firebase.jobdispatcher.Job)` call fails.
`static interface`	`FirebaseJobDispatcher.ScheduleResult` Deprecated. Results that can legally be returned from `schedule(Job)` calls.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CANCEL_RESULT_NO_DRIVER_AVAILABLE` Deprecated. Indicates the cancel request failed because the driver was unavailable.
`static int`	`CANCEL_RESULT_SUCCESS` Deprecated. Indicates the cancel request seems to have been successful.
`static int`	`CANCEL_RESULT_UNKNOWN_ERROR` Deprecated. Indicates the cancel request encountered an unknown error.
`static int`	`SCHEDULE_RESULT_BAD_SERVICE` Deprecated. Indicates the schedule request failed because the service is not exposed or configured correctly.
`static int`	`SCHEDULE_RESULT_NO_DRIVER_AVAILABLE` Deprecated. Indicates the schedule request failed because the driver was unavailable.
`static int`	`SCHEDULE_RESULT_SUCCESS` Deprecated. Indicates the schedule request seems to have been successful.
`static int`	`SCHEDULE_RESULT_UNKNOWN_ERROR` Deprecated. Indicates the schedule request encountered an unknown error.
`static int`	`SCHEDULE_RESULT_UNSUPPORTED_TRIGGER` Deprecated. Indicates the schedule request failed because the Trigger was unsupported.

Constructor Summary

Constructors
Constructor and Description

FirebaseJobDispatcher(Driver driver)
Deprecated.

Instantiates a new FirebaseJobDispatcher using the provided Driver.

Constructors
Constructor and Description
`FirebaseJobDispatcher(Driver driver)` Deprecated. Instantiates a new FirebaseJobDispatcher using the provided Driver.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`cancel(java.lang.String tag)` Deprecated. Attempts to cancel the Job that matches the provided tag and endpoint.
`int`	`cancelAll()` Deprecated. Attempts to cancel all Jobs registered for this package.
`ValidationEnforcer`	`getValidator()` Deprecated. Returns a ValidationEnforcer configured for the current Driver.
`void`	`mustSchedule(Job job)` Deprecated. Attempts to schedule the provided Job, throwing an exception if it fails.
`Job.Builder`	`newJobBuilder()` Deprecated. Creates a new Job.Builder, configured with the current driver's validation settings.
`RetryStrategy`	`newRetryStrategy(int policy, int initialBackoff, int maximumBackoff)` Deprecated. Creates a new RetryStrategy from the provided parameters, validated with the current driver's `JobValidator`.
`int`	`schedule(Job job)` Deprecated. Attempts to schedule the provided Job.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCHEDULE_RESULT_SUCCESS
```
public static final int SCHEDULE_RESULT_SUCCESS
```
    Deprecated.
    
    Indicates the schedule request seems to have been successful.
    
    See Also:
    
    Constant Field Values
  - SCHEDULE_RESULT_UNKNOWN_ERROR
```
public static final int SCHEDULE_RESULT_UNKNOWN_ERROR
```
    Deprecated.
    
    Indicates the schedule request encountered an unknown error.
    
    See Also:
    
    Constant Field Values
  - SCHEDULE_RESULT_NO_DRIVER_AVAILABLE
```
public static final int SCHEDULE_RESULT_NO_DRIVER_AVAILABLE
```
    Deprecated.
    
    Indicates the schedule request failed because the driver was unavailable.
    
    See Also:
    
    Constant Field Values
  - SCHEDULE_RESULT_UNSUPPORTED_TRIGGER
```
public static final int SCHEDULE_RESULT_UNSUPPORTED_TRIGGER
```
    Deprecated.
    
    Indicates the schedule request failed because the Trigger was unsupported.
    
    See Also:
    
    Constant Field Values
  - SCHEDULE_RESULT_BAD_SERVICE
```
public static final int SCHEDULE_RESULT_BAD_SERVICE
```
    Deprecated.
    
    Indicates the schedule request failed because the service is not exposed or configured correctly.
    
    See Also:
    
    Constant Field Values
  - CANCEL_RESULT_SUCCESS
```
public static final int CANCEL_RESULT_SUCCESS
```
    Deprecated.
    
    Indicates the cancel request seems to have been successful.
    
    See Also:
    
    Constant Field Values
  - CANCEL_RESULT_UNKNOWN_ERROR
```
public static final int CANCEL_RESULT_UNKNOWN_ERROR
```
    Deprecated.
    
    Indicates the cancel request encountered an unknown error.
    
    See Also:
    
    Constant Field Values
  - CANCEL_RESULT_NO_DRIVER_AVAILABLE
```
public static final int CANCEL_RESULT_NO_DRIVER_AVAILABLE
```
    Deprecated.
    
    Indicates the cancel request failed because the driver was unavailable.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FirebaseJobDispatcher
```
public FirebaseJobDispatcher(Driver driver)
```
    Deprecated.
    
    Instantiates a new FirebaseJobDispatcher using the provided Driver.
- Method Detail
  - schedule
```
public int schedule(Job job)
```
    Deprecated.
    
    Attempts to schedule the provided Job.
    Returns one of the SCHEDULE_RESULT_ constants.
  - cancel
```
public int cancel(java.lang.String tag)
```
    Deprecated.
    
    Attempts to cancel the Job that matches the provided tag and endpoint.
    Returns one of the CANCEL_RESULT_ constants.
  - cancelAll
```
public int cancelAll()
```
    Deprecated.
    
    Attempts to cancel all Jobs registered for this package.
    Returns one of the CANCEL_RESULT_ constants.
  - mustSchedule
```
public void mustSchedule(Job job)
```
    Deprecated.
    
    Attempts to schedule the provided Job, throwing an exception if it fails.
    
    Throws:
    
    FirebaseJobDispatcher.ScheduleFailedException
  - getValidator
```
public ValidationEnforcer getValidator()
```
    Deprecated.
    
    Returns a ValidationEnforcer configured for the current Driver.
  - newJobBuilder
```
public Job.Builder newJobBuilder()
```
    Deprecated.
    
    Creates a new Job.Builder, configured with the current driver's validation settings.
  - newRetryStrategy
```
public RetryStrategy newRetryStrategy(int policy,
                                      int initialBackoff,
                                      int maximumBackoff)
```
    Deprecated.
    
    Creates a new RetryStrategy from the provided parameters, validated with the current driver's JobValidator.
    
    Parameters:
    
    policy - the backoff policy to use. One of the RetryStrategy.RetryPolicy constants.
    
    initialBackoff - the initial backoff, in seconds.
    
    maximumBackoff - the maximum backoff, in seconds.
    
    Throws:
    
    ValidationEnforcer.ValidationException
    
    See Also:
    
    RetryStrategy

Class FirebaseJobDispatcher

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCHEDULE_RESULT_SUCCESS

SCHEDULE_RESULT_UNKNOWN_ERROR

SCHEDULE_RESULT_NO_DRIVER_AVAILABLE

SCHEDULE_RESULT_UNSUPPORTED_TRIGGER

SCHEDULE_RESULT_BAD_SERVICE

CANCEL_RESULT_SUCCESS

CANCEL_RESULT_UNKNOWN_ERROR

CANCEL_RESULT_NO_DRIVER_AVAILABLE

Constructor Detail

FirebaseJobDispatcher

Method Detail

schedule

cancel

cancelAll

mustSchedule

getValidator

newJobBuilder

newRetryStrategy