Alarms Property

An alarm related to the event.

Syntax

 getAlarms(): CalAlarmList;

 setAlarms(alarms: CalAlarmList): void;

Default Value

Remarks

This property contains the information for an Alarm calendar component. An Alarm calendar component is a grouping of properties that set up a reminder or alarm for an event or to-do. For example, it may be used to define a reminder for a pending event or an overdue to-do.

Each CalAlarm calendar component MUST include the and properties. The property further constrains the CalAlarm in the following ways:

When the is aAudio, the alarm can optionally include an property, containing a base-64 encoded binary audio file to be played when the alarm is triggered.

When the is aDisplay, the alarm MUST also include the property, which contains the text to be displayed when the alarm is triggered.

When the is aEmail, the alarm MUST include the property, which contains the text to be used as the message body, the property, which contains the text to be used as the message subject, and the property, which contains the email address of the person intended to receive the message.

An event may contain multiple alarms.

This property is filled from the response to a GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.