Job.Params (library 1.2.4 API)

java.lang.Object
- com.evernote.android.job.Job.Params

Enclosing class:

Job
```
public static final class Job.Params
extends Object
```
Holds several parameters for the Job execution.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(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()`
`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.
`int`	`getId()`
`long`	`getIntervalMs()` Only valid if the job is periodic.
`long`	`getLastRun()` Returns the time the job did run the last time.
`(package private) JobRequest`	`getRequest()`
`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`	`isExact()`
`boolean`	`isPeriodic()`
`boolean`	`isTransient()` Returns whether this is a transient jobs.
`JobRequest.NetworkType`	`requiredNetworkType()` Call `Job.isRequirementNetworkTypeMet()` to check whether this requirement is fulfilled.
`boolean`	`requirementsEnforced()`
`boolean`	`requiresBatteryNotLow()`
`boolean`	`requiresCharging()` Call `Job.isRequirementChargingMet()` to check whether this requirement is fulfilled.
`boolean`	`requiresDeviceIdle()` Call `Job.isRequirementDeviceIdleMet()` to check whether this requirement is fulfilled.
`boolean`	`requiresStorageNotLow()`

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

- Method Detail
  - getId
```
public int getId()
```
    Returns:
    
    The unique ID for this Job.
    
    See Also:
    
    JobRequest.getJobId()
  - getTag
```
public String getTag()
```
    Returns:
    
    The tag for this Job which was passed in the constructor of the JobRequest.Builder.
    
    See Also:
    
    JobRequest.getTag()
  - isPeriodic
```
public boolean isPeriodic()
```
    Returns:
    
    Whether this Job is periodic or not. If this Job is periodic, then you shouldn't return Job.Result.RESCHEDULE as result.
    
    See Also:
    
    JobRequest.isPeriodic()
  - isExact
```
public boolean isExact()
```
    Returns:
    
    true if this job was scheduled at an exact time by calling JobRequest.Builder.setExact(long).
    
    See Also:
    
    JobRequest.isExact()
  - 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.
    
    See Also:
    
    JobRequest.getStartMs()
  - 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.
    
    See Also:
    
    JobRequest.getEndMs()
  - getIntervalMs
```
public long getIntervalMs()
```
    Only valid if the job is periodic.
    
    Returns:
    
    The interval in which the job runs once.
    
    See Also:
    
    JobRequest.getIntervalMs()
  - 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.
    
    See Also:
    
    JobRequest.getFlexMs()
  - 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.
  - 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.
    
    See Also:
    
    JobRequest.getBackoffMs()
  - 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.
    
    See Also:
    
    JobRequest.getBackoffPolicy()
  - requiresCharging
```
public boolean requiresCharging()
```
    Call Job.isRequirementChargingMet() to check whether this requirement is fulfilled.
    
    Returns:
    
    If true, then the job should only run if the device is charging.
    
    See Also:
    
    JobRequest.requiresCharging()
  - requiresDeviceIdle
```
public boolean requiresDeviceIdle()
```
    Call Job.isRequirementDeviceIdleMet() to check whether this requirement is fulfilled.
    
    Returns:
    
    If true, then job should only run if the device is idle.
    
    See Also:
    
    JobRequest.requiresDeviceIdle()
  - requiredNetworkType
```
public JobRequest.NetworkType requiredNetworkType()
```
    Call Job.isRequirementNetworkTypeMet() to check whether this requirement is fulfilled.
    
    Returns:
    
    The network state which is required to run the job.
    
    See Also:
    
    JobRequest.requiredNetworkType()
  - 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.
  - 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.
    
    See Also:
    
    JobRequest.requirementsEnforced()
  - 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.
  - 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.
    
    Returns:
    
    The transient extras you passed in when constructing this job.
  - getExtras
```
@NonNull
public PersistableBundleCompat getExtras()
```
    Returns:
    
    Extra arguments for this Job. Never returns null.
  - getRequest
```
JobRequest getRequest()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Job.Params

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getId

getTag

isPeriodic

isExact

getStartMs

getEndMs

getIntervalMs

getFlexMs

getScheduledAt

getBackoffMs

getBackoffPolicy

requiresCharging

requiresDeviceIdle

requiredNetworkType

requiresBatteryNotLow

requiresStorageNotLow

requirementsEnforced

getFailureCount

getLastRun

isTransient

getTransientExtras

getExtras

getRequest

equals

hashCode