alarmMessage (property)

This property contains a message used to alert the user when this alarm is triggered.

Syntax

- (NSString*)alarmMessage:(int)alarmIndex;
- (void)setAlarmMessage:(int)alarmIndex:(NSString*)newAlarmMessage;

public func alarmMessage(alarmIndex: Int32) throws -> String
public func setAlarmMessage(alarmIndex: Int32, newAlarmMessage: String) throws -> Void

Default Value

""

Remarks

This property contains a message used to alert the user when this alarm is triggered. If the AlarmAction is set to aDisplay, this property must contain the message that is to be displayed to the user. If AlarmAction is set to aEmail this property will contain the message body of the email that is sent to the AlarmRecipient. For instance: 

  CalDAV.Alarm.Action = aEmail;
  CalDAV.Alarm.Recipient = "mailto:john_doe@example.com";
  CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST).";
  CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting.";
or 
  CalDAV.Alarm.Action = aDisplay;
  CalDAV.Alarm.Message = "REMINDER: Send agenda for weekly staff meeting.";
AlarmMessage is not used for the aAudio alarm AlarmAction.

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.
Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 iOS Edition - Version 20.0 [Build 8307]