alarm_action Property
This property determines what the CalDAV server will do when the alarm Trigger is reached.
Syntax
def get_alarm_action(alarm_index: int) -> int: ... def set_alarm_action(alarm_index: int, value: int) -> None: ...
Default Value
0
Remarks
This property determines what the CalDAV server will do when the alarm alarm_trigger is reached. The following table explains the possible alarm actions:
| aAudio (0) | Specifies an alarm that causes a sound to be played to alert the user. You may attach a custom sound file using the alarm_attachment property. |
| aDisplay (1) | Specifies an alarm that causes a visual alert to be displayed to the user. If alarm_action is set to this value, you must also set the alarm_message property with the message to be displayed. |
| aEmail (2) | Instructs the CalDAV sever to email a specified alarm_recipient. In this case, the alarm_message property will contain the message body of the email and the alarm_subject property should contain the subject line. |
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.