AlarmDuration Property

This property contains the interval between repeating alarms.

Syntax

 caldav.getAlarmDuration(index, [callback])
 caldav.setAlarmDuration(index,  alarmDuration, [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 getAlarmDuration([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 setAlarmDuration([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 interval between repeating alarms. This property is only used when an alarm is set to AlarmRepeat multiple times. It is specified in the form of a Duration data type. Durations are represented by the format P<date>T<time>. The date component may contain a number of days or weeks (but not months or years), and the time component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:


P	is the duration designator (historically called "period") placed at the start of the duration representation.
W	is the week designator that follows the value for the number of weeks.
D	is the day designator that follows the value for the number of days.
T	is the time designator that precedes the time components of the representation.
H	is the hour designator that follows the value for the number of hours.
M	is the minute designator that follows the value for the number of minutes.
S	is the second designator that follows the value for the number of seconds.

For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. Unused date/time designators may be left out completely. (A five-minute duration may be represented as simply "PT5M"). Also note that "PT36H" and "P1DT12H" represent the same duration.

This format is based on ISO-8601, but unlike the ISO specification this duration property does not support durations measured in years or months.

The following is an example of an alarm that repeats 4 additional times after the initial AlarmTrigger, with a 5-minute delay between each alarm:

  CalDav.Trigger = "-PT10M";
  CalDAV.Alarm.Repeat = 4;
  CalDAV.Duration = "PT5M"
  CalDAV.Action = aDisplay;

If AlarmDuration is specified, AlarmRepeat MUST also be specified.

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