| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/EventKit.framework |
| Availability | Available in iOS 4.0 and later. |
| Companion guide | |
| Declared in | EKAlarm.h |
An EKAlarm object represents an alarm in Event Kit. Use the alarmWithAbsoluteDate: and alarmWithRelativeOffset: class methods to create an alarm and use the properties to set information about an alarm.
For more about Objective-C properties, see “Properties” in The Objective-C Programming Language.
The absolute date for the alarm.
@property(copy) NSDate *absoluteDate
If you set this property for a relative offset alarm, it loses the relative offset and becomes an absolute alarm.
EKAlarm.hThe offset from the start of an event, at which the alarm fires.
@property NSTimeInterval relativeOffset
If you set this value for an absolute alarm, it loses its absolute date and becomes a relative offset alarm.
EKAlarm.hCreates and returns an alarm with an absolute date.
+ (EKAlarm *)alarmWithAbsoluteDate:(NSDate *)date
The date for the alarm.
The created alarm.
EKAlarm.hCreates and returns an alarm with a relative offset.
+ (EKAlarm *)alarmWithRelativeOffset:(NSTimeInterval)offset
The offset from start of an event, at which the alarm fires. Should be a negative value or 0.
The created alarm.
If offset is greater than zero, it is pinned to zero.
EKAlarm.hLast updated: 2010-03-25