AlarmBuilder

public final class AlarmBuilder extends IndexableBuilder<AlarmBuilder>

Builder to construct an Indexable for an alarm.

Constant Summary

String FRIDAY
String MONDAY
String SATURDAY
String SUNDAY
String THURSDAY
String TUESDAY
String WEDNESDAY

Public Method Summary

AlarmBuilder
setAlarmInstances(AlarmInstanceBuilder... alarmInstanceBuilders)
Sets the instances, if any, associated with this alarm.
AlarmBuilder
setDayOfWeek(String... daysOfWeek)
Sets the scheduled days for a repeating alarm.
AlarmBuilder
setEnabled(boolean enabled)
Sets whether or not the alarm is currently active and has at least one associated instance in the SCHEDULED, FIRED or SCHEDULED state.
AlarmBuilder
setHour(int hour)
Sets the hour that the alarm will fire.
AlarmBuilder
setIdentifier(String identifier)
Sets the immutable unique identifier of the alarm.
AlarmBuilder
setMessage(String message)
Sets the custom message associated with this alarm.
AlarmBuilder
setMinute(int minute)
Sets the minute that the alarm will fire.
AlarmBuilder
setRingtone(String ringtone)
Sets the ringtone to be played when the alarm fires, as a content URI of the media to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.
AlarmBuilder
setVibrate(boolean vibrate)
Sets whether or not to activate the device vibrator when the alarm fires.

Inherited Method Summary

Constants

public static final String FRIDAY

Constant Value: "Friday"

public static final String MONDAY

Constant Value: "Monday"

public static final String SATURDAY

Constant Value: "Saturday"

public static final String SUNDAY

Constant Value: "Sunday"

public static final String THURSDAY

Constant Value: "Thursday"

public static final String TUESDAY

Constant Value: "Tuesday"

public static final String WEDNESDAY

Constant Value: "Wednesday"

Public Methods

public AlarmBuilder setAlarmInstances (AlarmInstanceBuilder... alarmInstanceBuilders)

Sets the instances, if any, associated with this alarm.

public AlarmBuilder setDayOfWeek (String... daysOfWeek)

Sets the scheduled days for a repeating alarm.

Parameters
daysOfWeek Must be one or more of { MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY }.

public AlarmBuilder setEnabled (boolean enabled)

Sets whether or not the alarm is currently active and has at least one associated instance in the SCHEDULED, FIRED or SCHEDULED state.

public AlarmBuilder setHour (int hour)

Sets the hour that the alarm will fire.

Parameters
hour Must be 0-23, inclusive

public AlarmBuilder setIdentifier (String identifier)

Sets the immutable unique identifier of the alarm.

public AlarmBuilder setMessage (String message)

Sets the custom message associated with this alarm.

public AlarmBuilder setMinute (int minute)

Sets the minute that the alarm will fire.

Parameters
minute Must be 0-59, inclusive

public AlarmBuilder setRingtone (String ringtone)

Sets the ringtone to be played when the alarm fires, as a content URI of the media to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.

public AlarmBuilder setVibrate (boolean vibrate)

Sets whether or not to activate the device vibrator when the alarm fires.