AlarmMessage Property

This property contains a message used to alert the user when this alarm is triggered.

Object Oriented Interface

public function getAlarmMessage($alarmindex);
public function setAlarmMessage($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 6 , $alarmindex);
ipworks_caldav_set($res, 6, $value , $alarmindex);

Default Value

''

Remarks

This property contains a message used to alert the user when this alarm is triggered. If the AlarmAction is set to aDisplay, this property must contain the message that is to be displayed to the user. If AlarmAction is set to aEmail this property will contain the message body of the email that is sent to the AlarmRecipient. For instance:

  CalDAV.Alarm.Action = aEmail;
  CalDAV.Alarm.Recipient = "mailto:john_doe@example.com";
  CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST).";
  CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting.";

  CalDAV.Alarm.Action = aDisplay;
  CalDAV.Alarm.Message = "REMINDER: Send agenda for weekly staff meeting.";

The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String