com.twofortyfouram.spackle

Class AlarmManagerCompat

java.lang.Object

com.twofortyfouram.spackle.AlarmManagerCompat

@ThreadSafe
public final class AlarmManagerCompat
extends Object

Provides backwards and forwards compatibility with the AlarmManager, specifically with changes to the alarm manager APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlarmManagerCompat.AlarmToken Effectively immutable class representing a token used to set an alarm.
static interface	AlarmManagerCompat.AlarmType Defines the possible values for the alarm manager type.

Method Summary

Modifier and Type	Method and Description
void	cancel(AlarmManagerCompat.AlarmToken alarmToken) Cancels the alarm, on a best-effort basis.
static AlarmManagerCompat	getInstance(Context applicationContext)
AlarmManagerCompat.AlarmToken	setExact(Context context, int type, long triggerAtMillis, PendingIntent pendingIntent, long currentWalltimeMillis, long currentElapsedRealtimeMillis) This method schedules exact alarms with support for the new exact alarm behavior KitKat, works around the minimum alarm interval of 5 seconds for Lollipop, and provides best-effort workarounds for the idling behavior of Marshmallow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static AlarmManagerCompat getInstance(Context applicationContext)

Parameters:

applicationContext - Application context.

Returns:

Instance of the alarm manager compatibility class.

setExact

public AlarmManagerCompat.AlarmToken setExact(Context context,
                                              int type,
                                              long triggerAtMillis,
                                              PendingIntent pendingIntent,
                                              long currentWalltimeMillis,
                                              long currentElapsedRealtimeMillis)

This method schedules exact alarms with support for the new exact alarm behavior KitKat, works around the minimum alarm interval of 5 seconds for Lollipop, and provides best-effort workarounds for the idling behavior of Marshmallow. Handling of short duration alarms on Lollipop has a few consequences. This documentation reveals implementation details, which is necessary to communicate the behavior seen, however implementation details are subject to change. On Lollipop, short duration alarms (less than 5 seconds), will be reliably triggered by this method which will hold a WakeLock and fire the Intent directly rather than go through the AlarmManager. Note that a WakeLock is also held for non-WAKEUP alarms, because this class prioritizes the exactness of the scheduling. Due to the usage of WakeLocks, clients should not schedule short duration alarms frequently. The expected use case is an application that needs to check things at exact times, and infrequently has exact checks in the near future. To make scheduling behavior explicit to clients, this method makes decisions based on the currentWalltimeMillis and currentElapsedRealtimeMillis passed in. For a short duration RTC alarm, there is a risk of TOCTOU errors if the wall time changes after this method is called. To mitigate this, clients should be able to handle receiving a short duration RTC alarm slightly sooner or later than expected. This risk does not apply to longer-duration alarms.

Parameters:

context - Application context.

type - One of the alarm types: AlarmManager.RTC, AlarmManager.RTC_WAKEUP , AlarmManager.ELAPSED_REALTIME, or AlarmManager.ELAPSED_REALTIME_WAKEUP.

triggerAtMillis - Time in milliseconds when the alarm should fire. This will be either wall time or elapsed realtime, depending on type.

pendingIntent - Operation to execute when the alarm fires. This object should not be mutated after being passed to this method.

cancel

public void cancel(AlarmManagerCompat.AlarmToken alarmToken)

Cancels the alarm, on a best-effort basis.