AlarmRepeat Property

This property contains the number of times the alarm is to be repeated after the initial trigger.

Syntax

 caldav.getAlarmRepeat(index, [callback])
 caldav.setAlarmRepeat(index,  alarmRepeat, [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 getAlarmRepeat([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 setAlarmRepeat([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 number of times the alarm is to be repeated after the initial trigger.

This property defines the number of times an alarm should be repeated after its initial AlarmTrigger. If the alarm triggers more than once, then this property MUST be specified along with the AlarmDuration property.

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