alarm_message Property

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

Syntax

def get_alarm_message(alarm_index: int) -> str: ...
def set_alarm_message(alarm_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains a message used to alert the user when this alarm is triggered. If the alarm_action is set to aDisplay, this property must contain the message that is to be displayed to the user. If alarm_action is set to aEmail this property will contain the message body of the email that is sent to the alarm_recipient. 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.";
alarm_message is not used for the aAudio alarm alarm_action.

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.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Python Edition - Version 20.0 [Build 8307]