JobRequest (library 1.2.4 API)

java.lang.Object
- com.evernote.android.job.JobRequest

```
public final class JobRequest
extends Object
```
Holds information about the pending Job. Use the JobRequest.Builder to create an instance. Once built you can either call schedule() or JobManager.schedule(JobRequest) to schedule the request.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JobRequest.BackoffPolicy`
`static class`	`JobRequest.Builder` Builder class for constructing JobRequests.
`static interface`	`JobRequest.JobScheduledCallback` Callback that is used when scheduling a `JobRequest` asynchronously on a background thread.
`static class`	`JobRequest.NetworkType`

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_BACKOFF_MS` If you don't change the back-off ms, then 30 seconds are used as default.
`static JobRequest.BackoffPolicy`	`DEFAULT_BACKOFF_POLICY` If you don't change the back-off policy, then EXPONENTIAL is used as default.
`static JobRequest.JobScheduledCallback`	`DEFAULT_JOB_SCHEDULED_CALLBACK` The default callback that is used when you schedule a `JobRequest` asynchronously in `scheduleAsync()`.
`static JobRequest.NetworkType`	`DEFAULT_NETWORK_TYPE` If you don't change the required network type, then no connection is required.
`static long`	`MIN_FLEX` The minimum flex of a periodic job.
`static long`	`MIN_INTERVAL` The minimum interval of a periodic job.
`(package private) static long`	`START_NOW`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobRequest.Builder`	`cancelAndEdit()` Cancel this request if it has been scheduled.
`(package private) JobRequest.Builder`	`createBuilder()`
`boolean`	`equals(Object o)`
`(package private) static JobRequest`	`fromCursor(Cursor cursor)`
`long`	`getBackoffMs()` Only valid if the job isn't periodic.
`(package private) long`	`getBackoffOffset()`
`JobRequest.BackoffPolicy`	`getBackoffPolicy()` Only valid if the job isn't periodic.
`long`	`getEndMs()` Only valid if the job isn't periodic.
`PersistableBundleCompat`	`getExtras()`
`int`	`getFailureCount()` The failure count increases if a non periodic `Job` was rescheduled or if a periodic `Job` wasn't successful.
`long`	`getFlexMs()` Flex time for this job.
`long`	`getIntervalMs()` Only valid if the job is periodic.
`(package private) JobApi`	`getJobApi()`
`int`	`getJobId()`
`long`	`getLastRun()` Returns the time the job did run the last time.
`(package private) static long`	`getMinFlex()`
`(package private) static long`	`getMinInterval()`
`long`	`getScheduledAt()` Returns the time when this job was scheduled.
`long`	`getStartMs()` Only valid if the job isn't periodic.
`String`	`getTag()`
`Bundle`	`getTransientExtras()` Returns the transient extras you passed in when constructing this job with `JobRequest.Builder.setTransientExtras(Bundle)`.
`int`	`hashCode()`
`boolean`	`hasRequirements()`
`boolean`	`isExact()`
`(package private) boolean`	`isFlexSupport()`
`boolean`	`isPeriodic()`
`(package private) boolean`	`isStarted()` Only non-periodic jobs can be in a started state.
`boolean`	`isTransient()` Returns whether this is a transient jobs.
`boolean`	`isUpdateCurrent()`
`JobRequest.NetworkType`	`requiredNetworkType()`
`boolean`	`requirementsEnforced()`
`boolean`	`requiresBatteryNotLow()`
`boolean`	`requiresCharging()`
`boolean`	`requiresDeviceIdle()`
`boolean`	`requiresStorageNotLow()`
`(package private) JobRequest`	`reschedule(boolean failure, boolean newJob)`
`int`	`schedule()` Schedule a request which will be executed in the future.
`void`	`scheduleAsync()` Helper method to schedule a request on a background thread.
`void`	`scheduleAsync(JobRequest.JobScheduledCallback callback)` Helper method to schedule a request on a background thread.
`(package private) void`	`setFlexSupport(boolean flexSupport)`
`(package private) void`	`setScheduledAt(long timeStamp)`
`(package private) void`	`setStarted(boolean started)`
`(package private) ContentValues`	`toContentValues()`
`String`	`toString()`
`(package private) void`	`updateStats(boolean incFailureCount, boolean updateLastRun)`

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

- Field Detail
  - DEFAULT_BACKOFF_MS
```
public static final long DEFAULT_BACKOFF_MS
```
    If you don't change the back-off ms, then 30 seconds are used as default.
    
    See Also:
    
    Builder#setBackoffCriteria(long, BackoffPolicy), Constant Field Values
  - DEFAULT_BACKOFF_POLICY
```
public static final JobRequest.BackoffPolicy DEFAULT_BACKOFF_POLICY
```
    If you don't change the back-off policy, then EXPONENTIAL is used as default.
    
    See Also:
    
    Builder#setBackoffCriteria(long, BackoffPolicy)
  - DEFAULT_NETWORK_TYPE
```
public static final JobRequest.NetworkType DEFAULT_NETWORK_TYPE
```
    If you don't change the required network type, then no connection is required.
    
    See Also:
    
    Builder#setRequiredNetworkType(NetworkType), JobRequest.Builder.setRequirementsEnforced(boolean)
  - DEFAULT_JOB_SCHEDULED_CALLBACK
```
public static final JobRequest.JobScheduledCallback DEFAULT_JOB_SCHEDULED_CALLBACK
```
    The default callback that is used when you schedule a JobRequest asynchronously in scheduleAsync(). This implementation only logs a message in case of a failure and doesn't crash.
  - MIN_INTERVAL
```
public static final long MIN_INTERVAL
```
    The minimum interval of a periodic job. Specifying a smaller interval will result in an exception.
    
    This limit comes from the JobScheduler starting with Android Nougat. You can read here more about the limit.
    
    See Also:
    
    JobRequest.Builder.setPeriodic(long), JobRequest.Builder.setPeriodic(long, long)
  - MIN_FLEX
```
public static final long MIN_FLEX
```
    The minimum flex of a periodic job. Specifying a smaller flex will result in an exception.
    
    This limit comes from the JobScheduler starting with Android Nougat. You can read here more about the limit.
    
    See Also:
    
    JobRequest.Builder.setPeriodic(long, long)
  - START_NOW
```
static final long START_NOW
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getMinInterval
```
static long getMinInterval()
```
  - getMinFlex
```
static long getMinFlex()
```
  - getJobId
```
public int getJobId()
```
    Returns:
    
    The unique ID for this job.
  - getTag
```
@NonNull
public String getTag()
```
    Returns:
    
    The tag which is used to map this request to a specific Job.
  - getStartMs
```
public long getStartMs()
```
    Only valid if the job isn't periodic.
    
    Returns:
    
    The start of the time frame when the job will run after it's been scheduled.
  - getEndMs
```
public long getEndMs()
```
    Only valid if the job isn't periodic.
    
    Returns:
    
    The end of the time frame when the job will run after it's been scheduled.
  - getBackoffPolicy
```
public JobRequest.BackoffPolicy getBackoffPolicy()
```
    Only valid if the job isn't periodic.
    
    Returns:
    
    The back-off policy if a job failed and is rescheduled.
  - getBackoffMs
```
public long getBackoffMs()
```
    Only valid if the job isn't periodic.
    
    Returns:
    
    The initial back-off time which is increasing depending on the getBackoffPolicy() if the job fails multiple times.
  - isPeriodic
```
public boolean isPeriodic()
```
    Returns:
    
    Whether this job is periodic.
  - getIntervalMs
```
public long getIntervalMs()
```
    Only valid if the job is periodic.
    
    Returns:
    
    The interval in which the job runs once.
  - getFlexMs
```
public long getFlexMs()
```
    Flex time for this job. Only valid if this is a periodic job. The job can execute at any time in a window of flex length at the end of the period.
    
    Returns:
    
    How close to the end of an interval a periodic job is allowed to run.
  - requirementsEnforced
```
public boolean requirementsEnforced()
```
    Returns:
    
    If true, then all requirements are checked before the job runs. If one requirement isn't met, then the job is rescheduled right away.
  - requiresCharging
```
public boolean requiresCharging()
```
    Returns:
    
    If true, then the job should only run if the device is charging.
  - requiresDeviceIdle
```
public boolean requiresDeviceIdle()
```
    Returns:
    
    If true, then the job should only run if the device is idle.
  - requiresBatteryNotLow
```
public boolean requiresBatteryNotLow()
```
    Returns:
    
    If true, then the job should only run if the battery isn't low.
  - requiresStorageNotLow
```
public boolean requiresStorageNotLow()
```
    Returns:
    
    If true, then the job should only run if the battery isn't low.
  - requiredNetworkType
```
public JobRequest.NetworkType requiredNetworkType()
```
    Returns:
    
    The network state which is required to run the job.
  - hasRequirements
```
public boolean hasRequirements()
```
    Returns:
    
    Whether any of the requirements is different than the default value.
  - getExtras
```
public PersistableBundleCompat getExtras()
```
    Returns:
    
    The extras for this job.
  - isUpdateCurrent
```
public boolean isUpdateCurrent()
```
    Returns:
    
    If true, then this request will overwrite any preexisting jobs.
  - isExact
```
public boolean isExact()
```
    Returns:
    
    If true, then the job will run at exact time ignoring the device state.
  - getBackoffOffset
```
long getBackoffOffset()
```
  - getJobApi
```
JobApi getJobApi()
```
  - setScheduledAt
```
void setScheduledAt(long timeStamp)
```
  - getScheduledAt
```
public long getScheduledAt()
```
    Returns the time when this job was scheduled.
    
    Note that this value is only useful for non-periodic jobs. The time for periodic jobs is inconsistent. Sometimes it will return the value when the periodic job was scheduled for the first time and sometimes it will be updated after each period. The reason for this limitation is the flex parameter, which was backported to older Android versions. You can only rely on this value during the first interval of the periodic job.
    
    Returns:
    
    The time when the job was scheduled.
  - getFailureCount
```
public int getFailureCount()
```
    The failure count increases if a non periodic Job was rescheduled or if a periodic Job wasn't successful.
    
    Returns:
    
    How often the job already has failed.
  - isStarted
```
boolean isStarted()
```
    Only non-periodic jobs can be in a started state. The started state means, that the job is running and is about to be removed. A job can get stuck in a started state, if the app terminates while the job is running. Then the job isn't scheduled anymore, but the entry is still in the database. Since the job didn't finish successfully, reschedule the job if necessary and treat it as it wouldn't have run, yet.
    
    Returns:
    
    Whether the job is in a started state.
  - isFlexSupport
```
boolean isFlexSupport()
```
  - setFlexSupport
```
void setFlexSupport(boolean flexSupport)
```
  - getLastRun
```
public long getLastRun()
```
    Returns the time the job did run the last time. This is only useful for periodic jobs, daily jobs or jobs which were rescheduled. If the job didn't run, yet, then it returns 0.
    
    Returns:
    
    The last time the rescheduled or periodic job did run.
  - isTransient
```
public boolean isTransient()
```
    Returns whether this is a transient jobs. WARNING: It's not guaranteed that a transient job will run at all, e.g. rebooting the device or force closing the app will cancel the job.
    
    Returns:
    
    If this is a transient job.
  - getTransientExtras
```
@NonNull
public Bundle getTransientExtras()
```
    Returns the transient extras you passed in when constructing this job with JobRequest.Builder.setTransientExtras(Bundle). WARNING: It's not guaranteed that a transient job will run at all, e.g. rebooting the device or force closing the app will cancel the job.
    
    This will never be null. If you did not set any extras this will be an empty bundle. The returned bundle will also be empty, if the request isn't cached anymore.
    
    Returns:
    
    The transient extras you passed in when constructing this job.
  - schedule
```
public int schedule()
```
    Schedule a request which will be executed in the future. If you want to update an existing JobRequest, call cancelAndEdit(), update your parameters and call this method again. Calling this method on the same request instance multiple times without cancelling is idempotent.
    
    Convenience method. Internally it calls JobManager.schedule(JobRequest) and getJobId() for this request.
    
    Returns:
    
    The unique ID for this job.
  - scheduleAsync
```
public void scheduleAsync()
```
    Helper method to schedule a request on a background thread. This is helpful to avoid IO operations on the main thread.
    
    In case of a failure an error is logged, but the application doesn't crash.
  - scheduleAsync
```
public void scheduleAsync(@NonNull
                          JobRequest.JobScheduledCallback callback)
```
    Helper method to schedule a request on a background thread. This is helpful to avoid IO operations on the main thread. The callback notifies you about the job ID or a possible failure.
    
    Parameters:
    
    callback - The callback which is invoked after the request has been scheduled.
  - cancelAndEdit
```
public JobRequest.Builder cancelAndEdit()
```
    Cancel this request if it has been scheduled. Note that if the job isn't periodic, then the time passed since the job has been scheduled is subtracted from the time frame. For example a job should run between 4 and 6 seconds from now. You cancel the scheduled job after 2 seconds, then the job will run between 2 and 4 seconds after it's been scheduled again.
    
    Returns:
    
    A builder to modify the parameters.
  - createBuilder
```
JobRequest.Builder createBuilder()
```
  - reschedule
```
JobRequest reschedule(boolean failure,
                      boolean newJob)
```
  - updateStats
```
void updateStats(boolean incFailureCount,
                 boolean updateLastRun)
```
  - setStarted
```
void setStarted(boolean started)
```
  - toContentValues
```
ContentValues toContentValues()
```
  - fromCursor
```
static JobRequest fromCursor(Cursor cursor)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JobRequest

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BACKOFF_MS

DEFAULT_BACKOFF_POLICY

DEFAULT_NETWORK_TYPE

DEFAULT_JOB_SCHEDULED_CALLBACK

MIN_INTERVAL

MIN_FLEX

START_NOW

Method Detail

getMinInterval

getMinFlex

getJobId

getTag

getStartMs

getEndMs

getBackoffPolicy

getBackoffMs

isPeriodic

getIntervalMs

getFlexMs

requirementsEnforced

requiresCharging

requiresDeviceIdle

requiresBatteryNotLow

requiresStorageNotLow

requiredNetworkType

hasRequirements

getExtras

isUpdateCurrent

isExact

getBackoffOffset

getJobApi

setScheduledAt

getScheduledAt

getFailureCount

isStarted

isFlexSupport

setFlexSupport

getLastRun

isTransient

getTransientExtras

schedule

scheduleAsync

scheduleAsync

cancelAndEdit

createBuilder

reschedule

updateStats

setStarted

toContentValues

fromCursor

equals

hashCode

toString