Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Events.Item.AddAlarm

Adds an alarm.

Component Version macOS Windows Linux Server iOS SDK
Events 6.2 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "Events.Item.AddAlarm"; EKCalendarItem; EKAlarm )   More

Parameters

Parameter Description Example
EKCalendarItem The reference to the calendar item: an event or reminder. $item
EKAlarm The reference to the alarm. $Alarm

Result

Returns OK or error.

Description

Adds an alarm.
This function add an alarm to an item. Be warned that some calendars can only allow a certain maximum number of alarms. When this item is saved, it will truncate any extra alarms from the array.

Examples

Add alarm:

Set Variable [$alarm; Value:MBS( "Events.NewAlarm" )]
If [not IsEmpty(Events Create Reminder::AlarmSound)]
    Set Variable [$r; Value:MBS( "Events.Alarm.SetSound"; $alarm; Events Create Reminder::AlarmSound )]
End If
If [not IsEmpty(Events Create Reminder::AlarmLocationTitle)]
    Set Variable [$l; Value:MBS( "Events.StructuredLocation.NewLocationWithTitle"; Events Create Reminder::AlarmLocationTitle )]
    Set Variable [$r; Value:MBS( "Events.StructuredLocation.SetRadius"; $l; Events Create Reminder::AlarmLocationRadius )]
    Set Variable [$r; Value:MBS( "Events.StructuredLocation.SetGeoLocation"; $l; Events Create Reminder::AlarmLocationGeoLat; Events Create Reminder::AlarmLocationGeoLong )]
    Set Variable [$r; Value:MBS( "Events.Alarm.SetStructuredLocation"; $alarm; $l)]
    Set Variable [$r; Value:MBS( "Events.Alarm.SetProximity"; $alarm; Events Create Reminder::AlarmProximity )]
End If
Set Variable [$r; Value:MBS( "Events.Item.AddAlarm"; $reminder; $alarm )]

See also

Example Databases

This function checks for a license.

Created 10th March 2016, last changed 13th March 2016


Events.Initialize - Events.Item.AddRecurrenceRule