AlarmClock.ActionDismissAlarm Field

Definition

Namespace:

Android.Provider

Assembly:

Mono.Android.dll

Activity Action: Dismiss an alarm.

[Android.Runtime.Register("ACTION_DISMISS_ALARM", ApiSince=23)]
public const string ActionDismissAlarm;

[<Android.Runtime.Register("ACTION_DISMISS_ALARM", ApiSince=23)>]
val mutable ActionDismissAlarm : string

Field Value

String

Attributes

RegisterAttribute

Remarks

Activity Action: Dismiss an alarm.

The alarm to dismiss can be specified or searched for in one of the following ways: <ol> <li>The Intent's data URI, which represents a deeplink to the alarm. <li>The extra #EXTRA_ALARM_SEARCH_MODE to determine how to search for the alarm. </ol>

If neither of the above are given then: <ul> <li>If exactly one active alarm exists, it is dismissed. <li>If more than one active alarm exists, the user is prompted to choose the alarm to dismiss. </ul>

If the extra #EXTRA_ALARM_SEARCH_MODE is used, and the search results contain two or more matching alarms, then the implementation should show an UI with the results and allow the user to select the alarm to dismiss. If the implementation supports android.content.Intent#CATEGORY_VOICE and the activity is started in Voice Interaction mode (i.e. check android.app.Activity#isVoiceInteraction), then the implementation should additionally use android.app.VoiceInteractor.PickOptionRequest to start a voice interaction follow-on flow to help the user disambiguate the alarm by voice.

If the specified alarm is a single occurrence alarm, then dismissing it effectively disables the alarm; it will never ring again unless explicitly re-enabled.

If the specified alarm is a repeating alarm, then dismissing it only prevents the upcoming instance from ringing. The alarm remains enabled so that it will still ring on the date and time of the next instance (i.e. the instance after the upcoming one).

Java documentation for android.provider.AlarmClock.ACTION_DISMISS_ALARM.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.