File Doc Category Size Date Package
AlarmClock.java API Doc Android 5.1 API 9287 Thu Mar 12 22:22:10 GMT 2015 android.provider

AlarmClock

java.lang.Object

public final class AlarmClock extends Object

The AlarmClock provider contains an Intent action and extras that can be used to start an Activity to set a new alarm or timer in an alarm clock application. Applications that wish to receive the ACTION_SET_ALARM and ACTION_SET_TIMER Intents should create an activity to handle the Intent that requires the permission com.android.alarm.permission.SET_ALARM. Applications that wish to create a new alarm or timer should use {@link android.content.Context#startActivity Context.startActivity()} so that the user has the option of choosing which alarm clock application to use.

Fields Summary
public static final String
ACTION_SET_ALARM
Activity Action: Set an alarm.
Activates an existing alarm or creates a new one.
This action requests an alarm to be set for a given time of day. If no time of day is specified, an implementation should start an activity that is capable of setting an alarm ({@link #EXTRA_SKIP_UI} is ignored in this case). If a time of day is specified, and {@link #EXTRA_SKIP_UI} is {@code true}, and the alarm is not repeating, the implementation should remove this alarm after it has been dismissed. If an identical alarm exists matching all parameters, the implementation may re-use it instead of creating a new one (in this case, the alarm should not be removed after dismissal). This action always enables the alarm.

Request parameters

{@link #EXTRA_HOUR} (optional): The hour of the alarm being set.
{@link #EXTRA_MINUTES} (optional): The minutes of the alarm being set.
{@link #EXTRA_DAYS} (optional): Weekdays for repeating alarm.
{@link #EXTRA_MESSAGE} (optional): A custom message for the alarm.
{@link #EXTRA_RINGTONE} (optional): A ringtone to play with this alarm.
{@link #EXTRA_VIBRATE} (optional): Whether or not to activate the device vibrator for this alarm.
{@link #EXTRA_SKIP_UI} (optional): Whether or not to display an activity for setting this alarm.
public static final String
ACTION_SET_TIMER
Activity Action: Set a timer.
Activates an existing timer or creates a new one.
This action requests a timer to be started for a specific {@link #EXTRA_LENGTH length} of time. If no {@link #EXTRA_LENGTH length} is specified, the implementation should start an activity that is capable of setting a timer ({@link #EXTRA_SKIP_UI} is ignored in this case). If a {@link #EXTRA_LENGTH length} is specified, and {@link #EXTRA_SKIP_UI} is {@code true}, the implementation should remove this timer after it has been dismissed. If an identical, unused timer exists matching both parameters, an implementation may re-use it instead of creating a new one (in this case, the timer should not be removed after dismissal). This action always starts the timer.

Request parameters

{@link #EXTRA_LENGTH} (optional): The length of the timer being set.
{@link #EXTRA_MESSAGE} (optional): A custom message for the timer.
{@link #EXTRA_SKIP_UI} (optional): Whether or not to display an activity for setting this timer.
public static final String
ACTION_SHOW_ALARMS
Activity Action: Show the alarms.
This action opens the alarms page.
public static final String
EXTRA_DAYS
Bundle extra: Weekdays for repeating alarm.
Used by {@link #ACTION_SET_ALARM}.
The value is an {@code ArrayList}. Each item can be:

{@link java.util.Calendar#SUNDAY},
{@link java.util.Calendar#MONDAY},
{@link java.util.Calendar#TUESDAY},
{@link java.util.Calendar#WEDNESDAY},
{@link java.util.Calendar#THURSDAY},
{@link java.util.Calendar#FRIDAY},
{@link java.util.Calendar#SATURDAY}
public static final String
EXTRA_HOUR
Bundle extra: The hour of the alarm.
Used by {@link #ACTION_SET_ALARM}.
This extra is optional. If not provided, an implementation should open an activity that allows a user to set an alarm with user provided time.
The value is an {@link Integer} and ranges from 0 to 23.
public static final String
EXTRA_LENGTH
Bundle extra: The length of the timer in seconds.
Used by {@link #ACTION_SET_TIMER}.
This extra is optional. If not provided, an implementation should open an activity that allows a user to set a timer with user provided length.
The value is an {@link Integer} and ranges from 1 to 86400 (24 hours).
public static final String
EXTRA_MESSAGE
Bundle extra: A custom message for the alarm or timer.
Used by {@link #ACTION_SET_ALARM} and {@link #ACTION_SET_TIMER}.
The value is a {@link String}.
public static final String
EXTRA_MINUTES
Bundle extra: The minutes of the alarm.
Used by {@link #ACTION_SET_ALARM}.
The value is an {@link Integer} and ranges from 0 to 59. If not provided, it defaults to 0.
public static final String
EXTRA_RINGTONE
Bundle extra: A ringtone to be played with this alarm.
Used by {@link #ACTION_SET_ALARM}.
This value is a {@link String} and can either be set to {@link #VALUE_RINGTONE_SILENT} or to a content URI of the media to be played. If not specified or the URI doesn't exist, {@code "content://settings/system/alarm_alert} will be used.
public static final String
EXTRA_SKIP_UI
Bundle extra: Whether or not to display an activity after performing the action.
Used by {@link #ACTION_SET_ALARM} and {@link #ACTION_SET_TIMER}.
If true, the application is asked to bypass any intermediate UI. If false, the application may display intermediate UI like a confirmation dialog or settings.
The value is a {@link Boolean}. The default is {@code false}.
public static final String
EXTRA_VIBRATE
Bundle extra: Whether or not to activate the device vibrator.
Used by {@link #ACTION_SET_ALARM}.
The value is a {@link Boolean}. The default is {@code true}.
public static final String
VALUE_RINGTONE_SILENT
Bundle extra value: Indicates no ringtone should be played.
Used by {@link #ACTION_SET_ALARM}, passed in through {@link #EXTRA_RINGTONE}.
Constructors Summary
Methods Summary