Alarm Class

Alarm Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

A notification for which a custom sound can be specified.

Namespace:  Microsoft.Phone.Scheduler
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)

public sealed class Alarm : ScheduledNotification

The Alarm type exposes the following members.

Public methodAlarmInitializes a new instance of the Alarm class.

Public propertyBeginTimeGets or sets the time at which the action’s schedule begins. (Inherited from ScheduledAction.)
Public propertyContentGets or sets the text content of the notification that is displayed to the user when the notification is launched. (Inherited from ScheduledNotification.)
Public propertyExpirationTimeGets or sets the time at which the action’s schedule expires. (Inherited from ScheduledAction.)
Public propertyIsEnabledThis value is not used in the current release. (Inherited from ScheduledAction.)
Public propertyIsScheduledGets the scheduled status of the action. (Inherited from ScheduledAction.)
Public propertyNameGets the name of the scheduled action. (Inherited from ScheduledAction.)
Public propertyRecurrenceTypeGets or sets the recurrence type for a notification. (Inherited from ScheduledNotification.)
Public propertySoundGets or sets the sound file that plays when the Alarm is launched.
Public propertyTitleThis property is inherited from the base ScheduledNotification class, but is not supported for alarms. The title that is displayed for all alarm notifications is “Alarm”. (Overrides ScheduledNotification.Title.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This class inherits from ScheduledNotification and ScheduledAction. The title displayed in the alarm dialog is always “Alarm”. To create a notification that can pass contextual information to the application that created it, use Reminder.

Alarms are accurate only within a range of one minute. In other words, the notification can be launched up to one minute after it was scheduled. For more information about Alarms, see Alarms and Reminders for Windows Phone 8.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

© 2017 Microsoft