alarmAction (property)
This property determines what the CalDAV server will do when the alarm Trigger is reached.
Syntax
- (int)alarmAction:(int)alarmIndex; - (void)setAlarmAction:(int)alarmIndex:(int)newAlarmAction;
/* Possible Values */
A_NO_ALARM(0),
A_AUDIO(1),
A_DISPLAY(2),
A_EMAIL(3)
public func alarmAction(alarmIndex: Int32) throws -> CaldavAlarmActions
public func setAlarmAction(alarmIndex: Int32, newAlarmAction: CaldavAlarmActions) throws -> Void
public enum CaldavAlarmActions : Int32 { case aNoAlarm = 0 case aAudio = 1 case aDisplay = 2 case aEmail = 3 }
Default Value
0
Remarks
This property determines what the CalDAV server will do when the alarm AlarmTrigger is reached. The following table explains the possible alarm actions:
aAudio (0) | Specifies an alarm that causes a sound to be played to alert the user. You may attach a custom sound file using the AlarmAttachment property. |
aDisplay (1) | Specifies an alarm that causes a visual alert to be displayed to the user. If AlarmAction is set to this value, you must also set the AlarmMessage property with the message to be displayed. |
aEmail (2) | Instructs the CalDAV sever to email a specified AlarmRecipient. In this case, the AlarmMessage property will contain the message body of the email and the AlarmSubject property should contain the subject line. |
The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.