IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

AlarmSubject Property

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

Syntax

 caldav.getAlarmSubject(index, [callback])
 caldav.setAlarmSubject(index,  alarmSubject, [callback])

Default Value

""


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAlarmSubject([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAlarmSubject([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

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.";
AlarmSubject is not used for the aAudio or aDisplay alarm AlarmActions.

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

This property is not available at design time.

Data Type

String

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0