com.evernote.android.job

Class Job.Params

java.lang.Object

com.evernote.android.job.Job.Params

Enclosing class:

Job

protected static final class Job.Params
extends java.lang.Object

Holds several parameters for the Job execution.

Method Summary

Modifier and Type	Method and Description
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()
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	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()
JobRequest.NetworkType	requiredNetworkType() Call Job.isRequirementNetworkTypeMet() to check whether this requirement is fulfilled.
boolean	requirementsEnforced()
boolean	requiresCharging() Call Job.isRequirementChargingMet() to check whether this requirement is fulfilled.
boolean	requiresDeviceIdle() Call Job.isRequirementDeviceIdleMet() to check whether this requirement is fulfilled.

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 java.lang.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()

isPersisted

public boolean isPersisted()

Returns:

If true, then the job persists across reboots.

See Also:

JobRequest.isPersisted()

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()

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.

getExtras

public PersistableBundleCompat getExtras()

Returns:

Extra arguments for this Job. Never returns null.

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