com.birbit.android.jobqueue

Annotation Type CancelReason

@Retention(value=SOURCE)
public @interface CancelReason

A list of possible reasons why a Job was cancelled. A reason will be passed to Job.onCancel(int, Throwable).

Field Detail

SINGLE_INSTANCE_ID_QUEUED

public static final int SINGLE_INSTANCE_ID_QUEUED

Used when a job was added while another job with the same single instance ID was already queued and not running. This job got cancelled immediately after being added and will not run.

REACHED_RETRY_LIMIT

public static final int REACHED_RETRY_LIMIT

Used when job throws an exception in Job.onRun() and will be cancelled because it has reached its retry limit.

See Also:

Job.getRetryLimit()

CANCELLED_WHILE_RUNNING

public static final int CANCELLED_WHILE_RUNNING

Used when job throws an exception in Job.onRun() and will be cancelled because it was cancelled via JobManager.cancelJobs(TagConstraint, String...) while it was running.

See Also:

JobManager.cancelJobs(TagConstraint, String...), JobManager.cancelJobsInBackground(CancelResult.AsyncCancelCallback, TagConstraint, String...)

SINGLE_INSTANCE_WHILE_RUNNING

public static final int SINGLE_INSTANCE_WHILE_RUNNING

Used when job throws an exception in Job.onRun() and will be cancelled because another job with the same single instance id was queued while it was running.

See Also:

Job.getSingleInstanceId()

CANCELLED_VIA_SHOULD_RE_RUN

public static final int CANCELLED_VIA_SHOULD_RE_RUN

Used when job throws an exception in Job.onRun() and will be cancelled because it decided not to run again via Job.shouldReRunOnThrowable(Throwable, int, int).

REACHED_DEADLINE

public static final int REACHED_DEADLINE

Used when a Job is cancelled for hitting its deadline.

This means the job's params were constructed using Params.overrideDeadlineToCancelInMs(long).