AlarmSubject Property

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

Object Oriented Interface

public function getAlarmSubject($alarmindex);
public function setAlarmSubject($alarmindex, $value);

Procedural Interface

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

Default Value

''

Remarks

This property contains the subject of the message used to alert the user when this alarm is triggered. If AlarmAction is set to aEmail this property will contain the subject 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.";

The $alarmindex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String