AlarmAction Property
This property determines what the CalDAV server will do when the alarm Trigger is reached.
Syntax
ANSI (Cross Platform) int GetAlarmAction(int iAlarmIndex);
int SetAlarmAction(int iAlarmIndex, int iAlarmAction); Unicode (Windows) INT GetAlarmAction(INT iAlarmIndex);
INT SetAlarmAction(INT iAlarmIndex, INT iAlarmAction);
Possible Values
A_NO_ALARM(0),
A_AUDIO(1),
A_DISPLAY(2),
A_EMAIL(3)
- (int)alarmAction:(int)alarmIndex; - (void)setAlarmAction:(int)alarmIndex:(int)newAlarmAction;
Possible Values
A_NO_ALARM(0),
A_AUDIO(1),
A_DISPLAY(2),
A_EMAIL(3)
#define PID_CALDAV_ALARMACTION 2 IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_CalDAV_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_CalDAV_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal); IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_CalDAV_CheckIndex(void *lpObj, int propid, int arridx);
Default Value
0
Remarks
This property determines what the CalDAV server will do when the alarm AlarmTrigger 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 AlarmAttachment property. |
| aDisplay (1) | Specifies an alarm that causes a visual alert to be displayed to the user. If AlarmAction is set to this value, you must also set the AlarmMessage property with the message to be displayed. |
| aEmail (2) | Instructs the CalDAV sever to email a specified AlarmRecipient. In this case, the AlarmMessage property will contain the message body of the email and the AlarmSubject property should contain the subject line. |
The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.
This property is not available at design time.
Data Type
Integer