alarm_duration Property
This property contains the interval between repeating alarms.
Syntax
def get_alarm_duration(alarm_index: int) -> str: ... def set_alarm_duration(alarm_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property contains the interval between repeating alarms. This property is only used when an alarm is set to alarm_repeat 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. |
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 alarm_trigger, with a 5-minute delay between each alarm:
CalDav.Trigger = "-PT10M"; CalDAV.Alarm.Repeat = 4; CalDAV.Duration = "PT5M" CalDAV.Action = aDisplay;
If alarm_duration is specified, alarm_repeat MUST also be specified.
The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.