JobRequest (library API)

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

```
public final class JobRequest
extends java.lang.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 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.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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobRequest.Builder`	`cancelAndEdit()` Cancel this request if it has been scheduled.
`boolean`	`equals(java.lang.Object o)`
`long`	`getBackoffMs()` Only valid if the job isn't periodic.
`JobRequest.BackoffPolicy`	`getBackoffPolicy()` Only valid if the job isn't periodic.
`long`	`getEndMs()` Only valid if the job isn't periodic.
`PersistableBundleCompat`	`getExtras()`
`long`	`getFlexMs()` Flex time for this job.
`long`	`getIntervalMs()` Only valid if the job is periodic.
`int`	`getJobId()`
`long`	`getScheduledAt()` Returns the time when this job was scheduled.
`long`	`getStartMs()` Only valid if the job isn't periodic.
`java.lang.String`	`getTag()`
`int`	`hashCode()`
`boolean`	`isExact()`
`boolean`	`isPeriodic()`
`boolean`	`isPersisted()`
`boolean`	`isUpdateCurrent()`
`JobRequest.NetworkType`	`requiredNetworkType()`
`boolean`	`requirementsEnforced()`
`boolean`	`requiresCharging()`
`boolean`	`requiresDeviceIdle()`
`int`	`schedule()` Convenience method.
`java.lang.String`	`toString()`

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)
  - 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)
- Method Detail
  - getJobId
```
public int getJobId()
```
    Returns:
    
    The unique ID for this job.
  - getTag
```
public java.lang.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 job should only run if the device is idle.
  - requiredNetworkType
```
public JobRequest.NetworkType requiredNetworkType()
```
    Returns:
    
    The network state which is required to run the job.
  - getExtras
```
public PersistableBundleCompat getExtras()
```
    Returns:
    
    The extras for this job.
  - isPersisted
```
public boolean isPersisted()
```
    Returns:
    
    If true, then the job persists across reboots.
  - 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.
  - 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.
  - schedule
```
public int schedule()
```
    Convenience method. Internally it calls JobManager.schedule(JobRequest) and getJobId() for this request.
    
    Returns:
    
    The unique ID for this job.
  - 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.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.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

MIN_INTERVAL

MIN_FLEX

Method Detail

getJobId

getTag

getStartMs

getEndMs

getBackoffPolicy

getBackoffMs

isPeriodic

getIntervalMs

getFlexMs

requirementsEnforced

requiresCharging

requiresDeviceIdle

requiredNetworkType

getExtras

isPersisted

isUpdateCurrent

isExact

getScheduledAt

schedule

cancelAndEdit

equals

hashCode

toString