AlarmAction Property

This property determines what the CalDAV server will do when the alarm Trigger is reached.

Syntax

 caldav.getAlarmAction(index, [callback])
 caldav.setAlarmAction(index,  alarmAction, [callback])

Possible Values

  0 (aNoAlarm), 
  1 (aAudio), 
  2 (aDisplay), 
  3 (aEmail)

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 getAlarmAction([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 setAlarmAction([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 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 index 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

Integer