alarmTrigger (property)

This property contains the time when the alarm is triggered.

Syntax

• Objective-C
• Swift

- (NSString*)alarmTrigger:(int)alarmIndex;
- (void)setAlarmTrigger:(int)alarmIndex:(NSString*)newAlarmTrigger;

public func alarmTrigger(alarmIndex: Int32) throws -> String
public func setAlarmTrigger(alarmIndex: Int32, newAlarmTrigger: String) throws -> Void

Default Value

""

Remarks

This property contains the time when the alarm is triggered.

The AlarmTrigger is represented as a duration relative to the start of an event. The format is (+/-)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:

Either a positive or negative duration may be specified for the AlarmTrigger property. An alarm with a positive duration is triggered after the associated start of the event (or to-do). An alarm with a negative duration is triggered before the start of the event. For instance, the following code instructs an alarm to fire 10 minutes before the event starts:

  CalDAV.Alarm.Trigger = "-PT10M"

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.