AlarmAction Property
This property determines what the CalDAV server will do when the alarm Trigger is reached.
Object Oriented Interface
public function getAlarmAction($alarmindex); public function setAlarmAction($alarmindex, $value);
Procedural Interface
ipworks_caldav_get($res, 2 , $alarmindex); ipworks_caldav_set($res, 2, $value , $alarmindex);
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 size of the array is controlled by the AlarmCount property.
This property is not available at design time.
Data Type
Integer