Platforms to show: All Mac Windows Linux Cross-Platform
EKAlarmMBS class
Super class: EKObjectMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| class | Calendar | MBS Mac64bit Plugin | 15.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
Use the alarmWithAbsoluteDate: and alarmWithRelativeOffset class methods to create an alarm and use the properties to set information about an alarm. In OS X Mountain Lion, you can specify an action to trigger when the alarm fires via the emailAddress, soundName, or url property.
Subclass of the EKObjectMBS class.
- 9 properties
- property absoluteDate as date
- property absoluteDateTime as DateTime
- property emailAddress as String
- property proximity as Integer
- property relativeOffset as Double
- property soundName as String
- property structuredLocation as EKStructuredLocationMBS
- property type as Integer
- property url as String
- 4 methods
- method Constructor(date as date)
- method Constructor(date as dateTime)
- method Constructor(offset as Double)
- method copy as EKAlarmMBS
- 3 shared methods
- shared method alarmWithAbsoluteDate(d as date) as EKAlarmMBS
- shared method alarmWithAbsoluteDateTime(d as dateTime) as EKAlarmMBS
- shared method alarmWithRelativeOffset(offset as Double) as EKAlarmMBS
- 7 constants
Proximity Values
| Constant | Value | Description |
|---|---|---|
| kProximityEnter | 1 |
The alarm is set to fire when entering a region. |
| kProximityLeave | 2 |
The alarm is set to fire when leaving a region. |
| kProximityNone | 0 |
The alarm has no proximity trigger. |
Types
| Constant | Value | Description |
|---|---|---|
| kTypeAudio | 1 |
Play audio |
| kTypeDisplay | 0 |
Display alert |
| kTypeEmail | 3 |
Email |
| kTypeProcedure | 2 |
Procedure |
Super class EKObjectMBS
- property Handle as Integer
- 6 methods
- method Constructor Private
- method hasChanges as boolean
- method isNew as boolean
- method refresh as boolean
- method reset
- method rollback
This class has no sub classes.
Some methods using this class:
- EKCalendarItemMBS.addAlarm(alarm as EKAlarmMBS)
- EKCalendarItemMBS.alarms as EKAlarmMBS()
- EKCalendarItemMBS.removeAlarm(alarm as EKAlarmMBS)
- EKCalendarItemMBS.setAlarms(alarms() as EKAlarmMBS)
Blog Entries
Release notes
- Version 20.5
- Added datetime properties to EKEventMBS and EKAlarmMBS classes.
The items on this page are in the following plugins: MBS Mac64bit Plugin.
EdsVolumeMBS - EKCalendarItemMBS
