The Android Developer Challenge is back! Submit your idea before December 2.

AlarmManagerCompat

class AlarmManagerCompat
kotlin.Any
   ↳ androidx.core.app.AlarmManagerCompat

Compatibility library for AlarmManager with fallbacks for older platforms.

Summary

Public methods

static Unit
setAlarmClock(@NonNull alarmManager: AlarmManager, triggerTime: Long, @NonNull showIntent: PendingIntent, @NonNull operation: PendingIntent)

Schedule an alarm that represents an alarm clock.

static Unit
setAndAllowWhileIdle(@NonNull alarmManager: AlarmManager, type: Int, triggerAtMillis: Long, @NonNull operation: PendingIntent)

Like AlarmManager#set(int, long, PendingIntent), but this alarm will be allowed to execute even when the system is in low-power idle modes.

static Unit
setExact(@NonNull alarmManager: AlarmManager, type: Int, triggerAtMillis: Long, @NonNull operation: PendingIntent)

Schedule an alarm to be delivered precisely at the stated time.

static Unit
setExactAndAllowWhileIdle(@NonNull alarmManager: AlarmManager, type: Int, triggerAtMillis: Long, @NonNull operation: PendingIntent)

Like setExact, but this alarm will be allowed to execute even when the system is in low-power idle modes.

Public methods

setAlarmClock

static fun setAlarmClock(@NonNull alarmManager: AlarmManager, triggerTime: Long, @NonNull showIntent: PendingIntent, @NonNull operation: PendingIntent): Unit

Schedule an alarm that represents an alarm clock. The system may choose to display information about this alarm to the user.

This method is like setExact, but implies AlarmManager#RTC_WAKEUP.

Parameters
alarmManager AlarmManager: AlarmManager instance used to set the alarm
triggerTime AlarmManager: time at which the underlying alarm is triggered in wall time milliseconds since the epoch
showIntent AlarmManager: an intent that can be used to show or edit details of the alarm clock.
operation AlarmManager: Action to perform when the alarm goes off; typically comes from IntentSender.getBroadcast().

setAndAllowWhileIdle

static fun setAndAllowWhileIdle(@NonNull alarmManager: AlarmManager, type: Int, triggerAtMillis: Long, @NonNull operation: PendingIntent): Unit

Like AlarmManager#set(int, long, PendingIntent), but this alarm will be allowed to execute even when the system is in low-power idle modes. This type of alarm must only be used for situations where it is actually required that the alarm go off while in idle -- a reasonable example would be for a calendar notification that should make a sound so the user is aware of it. When the alarm is dispatched, the app will also be added to the system's temporary whitelist for approximately 10 seconds to allow that application to acquire further wake locks in which to complete its work.

These alarms can significantly impact the power use of the device when idle (and thus cause significant battery blame to the app scheduling them), so they should be used with care. To reduce abuse, there are restrictions on how frequently these alarms will go off for a particular application. Under normal system operation, it will not dispatch these alarms more than about every minute (at which point every such pending alarm is dispatched); when in low-power idle modes this duration may be significantly longer, such as 15 minutes.

Unlike other alarms, the system is free to reschedule this type of alarm to happen out of order with any other alarms, even those from the same app. This will clearly happen when the device is idle (since this alarm can go off while idle, when any other alarms from the app will be held until later), but may also happen even when not idle.

Regardless of the app's target SDK version, this call always allows batching of the alarm.

Parameters
alarmManager AlarmManager: AlarmManager instance used to set the alarm
type AlarmManager: One of AlarmManager#ELAPSED_REALTIME, AlarmManager#ELAPSED_REALTIME_WAKEUP, AlarmManager#RTC, or AlarmManager#RTC_WAKEUP.
triggerAtMillis AlarmManager: time in milliseconds that the alarm should go off, using the appropriate clock (depending on the alarm type).
operation AlarmManager: Action to perform when the alarm goes off; typically comes from IntentSender.getBroadcast().

setExact

static fun setExact(@NonNull alarmManager: AlarmManager, type: Int, triggerAtMillis: Long, @NonNull operation: PendingIntent): Unit

Schedule an alarm to be delivered precisely at the stated time.

This method is like AlarmManager#set(int, long, PendingIntent), but does not permit the OS to adjust the delivery time. The alarm will be delivered as nearly as possible to the requested trigger time.

Note: only alarms for which there is a strong demand for exact-time delivery (such as an alarm clock ringing at the requested time) should be scheduled as exact. Applications are strongly discouraged from using exact alarms unnecessarily as they reduce the OS's ability to minimize battery use.

Parameters
alarmManager AlarmManager: AlarmManager instance used to set the alarm
type AlarmManager: One of AlarmManager#ELAPSED_REALTIME, AlarmManager#ELAPSED_REALTIME_WAKEUP, AlarmManager#RTC, or AlarmManager#RTC_WAKEUP.
triggerAtMillis AlarmManager: time in milliseconds that the alarm should go off, using the appropriate clock (depending on the alarm type).
operation AlarmManager: Action to perform when the alarm goes off; typically comes from IntentSender.getBroadcast().

setExactAndAllowWhileIdle

static fun setExactAndAllowWhileIdle(@NonNull alarmManager: AlarmManager, type: Int, triggerAtMillis: Long, @NonNull operation: PendingIntent): Unit

Like setExact, but this alarm will be allowed to execute even when the system is in low-power idle modes. If you don't need exact scheduling of the alarm but still need to execute while idle, consider using setAndAllowWhileIdle. This type of alarm must only be used for situations where it is actually required that the alarm go off while in idle -- a reasonable example would be for a calendar notification that should make a sound so the user is aware of it. When the alarm is dispatched, the app will also be added to the system's temporary whitelist for approximately 10 seconds to allow that application to acquire further wake locks in which to complete its work.

These alarms can significantly impact the power use of the device when idle (and thus cause significant battery blame to the app scheduling them), so they should be used with care. To reduce abuse, there are restrictions on how frequently these alarms will go off for a particular application. Under normal system operation, it will not dispatch these alarms more than about every minute (at which point every such pending alarm is dispatched); when in low-power idle modes this duration may be significantly longer, such as 15 minutes.

Unlike other alarms, the system is free to reschedule this type of alarm to happen out of order with any other alarms, even those from the same app. This will clearly happen when the device is idle (since this alarm can go off while idle, when any other alarms from the app will be held until later), but may also happen even when not idle. Note that the OS will allow itself more flexibility for scheduling these alarms than regular exact alarms, since the application has opted into this behavior. When the device is idle it may take even more liberties with scheduling in order to optimize for battery life.

Parameters
alarmManager AlarmManager: AlarmManager instance used to set the alarm
type AlarmManager: One of AlarmManager#ELAPSED_REALTIME, AlarmManager#ELAPSED_REALTIME_WAKEUP, AlarmManager#RTC, or AlarmManager#RTC_WAKEUP.
triggerAtMillis AlarmManager: time in milliseconds that the alarm should go off, using the appropriate clock (depending on the alarm type).
operation AlarmManager: Action to perform when the alarm goes off; typically comes from IntentSender.getBroadcast().