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.
Inheritance Hierarchy
System..::.Object
Microsoft.Phone.Scheduler..::.ScheduledAction
Microsoft.Phone.Scheduler..::.ScheduledNotification
Microsoft.Phone.Scheduler..::.Alarm
Namespace: Microsoft.Phone.Scheduler
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
Syntax
Public NotInheritable Class Alarm _
Inherits ScheduledNotification
public sealed class Alarm : ScheduledNotification
The Alarm type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Alarm | Initializes a new instance of the Alarm class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BeginTime | Gets or sets the time at which the action’s schedule begins. (Inherited from ScheduledAction.) |
|
Content | Gets or sets the text content of the notification that is displayed to the user when the notification is launched. (Inherited from ScheduledNotification.) |
|
ExpirationTime | Gets or sets the time at which the action’s schedule expires. (Inherited from ScheduledAction.) |
|
IsEnabled | This value is not used in the current release. (Inherited from ScheduledAction.) |
|
IsScheduled | Gets the scheduled status of the action. (Inherited from ScheduledAction.) |
|
Name | Gets the name of the scheduled action. (Inherited from ScheduledAction.) |
|
RecurrenceType | Gets or sets the recurrence type for a notification. (Inherited from ScheduledNotification.) |
|
Sound | Gets or sets the sound file that plays when the Alarm is launched. |
|
Title | This 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.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
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.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1
Platforms
Windows Phone
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.