com.evernote.android.job

Class DailyJob

java.lang.Object

com.evernote.android.job.Job

com.evernote.android.job.DailyJob

public abstract class DailyJob
extends Job

Helper class for jobs which should run once a day. Your daily job needs to extend DailyJob and you need to use the schedule(JobRequest.Builder, long, long) to schedule the job.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DailyJob.DailyJobResult

Nested classes/interfaces inherited from class com.evernote.android.job.Job

Job.Params, Job.Result

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	EXTRA_END_MS
(package private) static String	EXTRA_START_MS

Constructor Summary

Constructors

Constructor and Description
DailyJob()

Method Summary

Modifier and Type	Method and Description
protected abstract DailyJob.DailyJobResult	onRunDailyJob(Job.Params params) This method is invoked from a background thread.
protected Job.Result	onRunJob(Job.Params params) This method is invoked from a background thread.
static int	schedule(JobRequest.Builder baseBuilder, long startMs, long endMs) Schedules your daily job.
static void	scheduleAsync(JobRequest.Builder baseBuilder, long startMs, long endMs) Helper method to schedule a daily job on a background thread.
static void	scheduleAsync(JobRequest.Builder baseBuilder, long startMs, long endMs, JobRequest.JobScheduledCallback callback) Helper method to schedule a daily job on a background thread.
static int	startNowOnce(JobRequest.Builder baseBuilder) Schedules the daily job only once and runs it immediately.

Methods inherited from class com.evernote.android.job.Job

cancel, cancel, equals, getContext, getFinishedTimeStamp, getParams, getResult, hashCode, isCanceled, isDeleted, isFinished, isRequirementBatteryNotLowMet, isRequirementChargingMet, isRequirementDeviceIdleMet, isRequirementNetworkTypeMet, isRequirementStorageNotLowMet, meetsRequirements, meetsRequirements, onCancel, onReschedule, runJob, setContext, setRequest, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXTRA_START_MS

static final String EXTRA_START_MS

See Also:

Constant Field Values

EXTRA_END_MS

static final String EXTRA_END_MS

See Also:

Constant Field Values

Constructor Detail

DailyJob

public DailyJob()

Method Detail

schedule

public static int schedule(@NonNull
                           JobRequest.Builder baseBuilder,
                           long startMs,
                           long endMs)

Schedules your daily job. A builder is required for this method call. Within the builder, you may specify additional requirements and/or extras for the job. However, a daily job may not be exact, periodic or transient. If the requirements are enforced but are not met when the job runs, then the daily job will only be rescheduled for the next day. The back-off criteria is ignored in this case.

Daily jobs should use a unique tag and their classes shouldn't be reused for other jobs.

The start and end parameter must be less than one day. The end value may be smaller than the start value, allowing you to run the job in the evening or morning.

Sample usage:

 // schedule between 1am and 6am
 DailyJob.schedule(builder, TimeUnit.HOURS.toMillis(1), TimeUnit.HOURS.toMillis(6));

 // schedule between 8pm and 3am
 JobRequest.Builder builder = new JobRequest.Builder("MyTag").setRequiresCharging(true);
 DailyJob.schedule(builder, TimeUnit.HOURS.toMillis(20), TimeUnit.HOURS.toMillis(3));
 

Parameters:

baseBuilder - The builder of your daily job.

startMs - The time of the day when the job is allowed to start in milliseconds.

endMs - The time of the day when the job is not allowed to start later in milliseconds.

Returns:

The unique ID for this job.

scheduleAsync

public static void scheduleAsync(@NonNull
                                 JobRequest.Builder baseBuilder,
                                 long startMs,
                                 long endMs)

Helper method to schedule a daily job on a background thread. This is helpful to avoid IO operations on the main thread. For more information about scheduling daily jobs see schedule(JobRequest.Builder, long, long).

In case of a failure an error is logged, but the application doesn't crash.

scheduleAsync

public static void scheduleAsync(@NonNull
                                 JobRequest.Builder baseBuilder,
                                 long startMs,
                                 long endMs,
                                 @NonNull
                                 JobRequest.JobScheduledCallback callback)

Helper method to schedule a daily job 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. For more information about scheduling daily jobs see schedule(JobRequest.Builder, long, long).

Parameters:

callback - The callback which is invoked after the request has been scheduled.

startNowOnce

public static int startNowOnce(@NonNull
                               JobRequest.Builder baseBuilder)

Schedules the daily job only once and runs it immediately. This is helpful if you want to reuse your job and want to trigger the execution immediately. It's possible to schedule a daily job normally with schedule(JobRequest.Builder, long, long) and this method at the same time to trigger the execution immediately.

Parameters:

baseBuilder - The builder of your daily job.

Returns:

The unique ID for this job.

onRunJob

@NonNull
protected final Job.Result onRunJob(@NonNull
                                             Job.Params params)

Description copied from class: Job

This method is invoked from a background thread. You should run your desired task here. This method is thread safe. Each time a job starts executing a new instance of your Job is instantiated. You can identify your Job with the passed params.

You should call Job.isCanceled() frequently for long running jobs and stop your task if necessary.

A PowerManager.WakeLock is acquired for 3 minutes for each Job. If your task needs more time, then you need to create an extra PowerManager.WakeLock.

Specified by:

onRunJob in class Job

Parameters:

params - The parameters for this concrete job.

Returns:

The result of this Job. Note that returning Job.Result.RESCHEDULE for a periodic Job is invalid and ignored.

onRunDailyJob

@NonNull
 @WorkerThread
protected abstract DailyJob.DailyJobResult onRunDailyJob(@NonNull
                                                                                 Job.Params params)

This method is invoked from a background thread. You should run your desired task here. This method is thread safe. Each time a job starts, a new instance of your Job is instantiated and executed. You can identify your Job with the passed params.

You should call Job.isCanceled() frequently for long running jobs and stop your task if necessary.

A PowerManager.WakeLock is acquired for 3 minutes for each Job. If your task needs more time, then you need to create an extra PowerManager.WakeLock.

Parameters:

params - The parameters for this concrete job.

Returns:

The result of this DailyJob.