AlarmCount Property

The number of records in the Alarm arrays.

Syntax

 caldav.getAlarmCount([callback])
 caldav.setAlarmCount( alarmCount, [callback])

Default Value

0

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 getAlarmCount([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 setAlarmCount([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

• AlarmAction
• AlarmAttachment
• AlarmAttachmentType
• AlarmDuration
• AlarmMessage
• AlarmRecipient
• AlarmRepeat
• AlarmSubject
• AlarmTrigger

The array indices start at 0 and end at AlarmCount-1.

This property is not available at design time.

Data Type

Integer