iOS Developer Library

Developer

EventKit Framework Reference EKAlarm Class Reference

Options
Deployment Target:

On This Page
Language:

EKAlarm

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. In OS X Mountain Lion, you can specify an action to trigger when the alarm fires via the emailAddress, soundName, or url property.

  • Creates and returns an alarm with an absolute date.

    Declaration

    Swift

    init(absoluteDate date: NSDate)

    Objective-C

    + (EKAlarm *)alarmWithAbsoluteDate:(NSDate *)date

    Parameters

    date

    The date for the alarm.

    Return Value

    The created alarm.

    Availability

    Available in iOS 4.0 and later.

  • Creates and returns an alarm with a relative offset.

    Declaration

    Swift

    init(relativeOffset offset: NSTimeInterval)

    Objective-C

    + (EKAlarm *)alarmWithRelativeOffset:(NSTimeInterval)offset

    Parameters

    offset

    The offset from the start of an event, at which the alarm fires.

    Return Value

    The created alarm.

    Discussion

    Negative offset values fire before the start of the event, while positive values fire after the start.

    Availability

    Available in iOS 4.0 and later.

  • The absolute date for the alarm.

    Declaration

    Swift

    @NSCopying var absoluteDate: NSDate?

    Objective-C

    @property(nonatomic, copy) NSDate *absoluteDate

    Discussion

    If you set this property for a relative offset alarm, it loses the relative offset and becomes an absolute alarm.

    Availability

    Available in iOS 4.0 and later.

  • The offset from the start of an event, at which the alarm fires.

    Declaration

    Swift

    var relativeOffset: NSTimeInterval

    Objective-C

    @property(nonatomic) NSTimeInterval relativeOffset

    Discussion

    If you set this value for an absolute alarm, it loses its absolute date and becomes a relative offset alarm.

    Availability

    Available in iOS 4.0 and later.

  • The location to trigger an alarm.

    Declaration

    Swift

    @NSCopying var structuredLocation: EKStructuredLocation?

    Objective-C

    @property(nonatomic, copy) EKStructuredLocation *structuredLocation

    Discussion

    This property is used in conjunction with proximity to perform geofence-based triggering of reminders.

    Availability

    Available in iOS 6.0 and later.

  • A value indicating how a location-based alarm is triggered.

    Declaration

    Swift

    var proximity: EKAlarmProximity

    Objective-C

    @property(nonatomic) EKAlarmProximity proximity

    Discussion

    Alarms can be set to trigger when entering or exiting a location specified by structuredLocation. By default, alarms are not affected by location.

    Availability

    Available in iOS 6.0 and later.

    See Also

    EKAlarmProximity

Data Types

  • Possible values that can be read from the type property.

    Declaration

    Swift

    enum EKAlarmType : Int { case Display case Audio case Procedure case Email }

    Objective-C

    typedef enum { EKAlarmTypeDisplay, EKAlarmTypeAudio, EKAlarmTypeProcedure, EKAlarmTypeEmail, } EKAlarmType;

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in iOS 9.0 and later.

  • A value indicating whether an alarm is triggered by entering or exiting a region.

    Declaration

    Swift

    enum EKAlarmProximity : Int { case None case Enter case Leave }

    Objective-C

    typedef enum { EKAlarmProximityNone, EKAlarmProximityEnter, EKAlarmProximityLeave, } EKAlarmProximity;

    Constants

    • None

      EKAlarmProximityNone

      The alarm has no proximity trigger.

      Available in iOS 6.0 and later.

    • Enter

      EKAlarmProximityEnter

      The alarm is set to fire when entering a region.

      Available in iOS 6.0 and later.

    • Leave

      EKAlarmProximityLeave

      The alarm is set to fire when leaving a region.

      Available in iOS 6.0 and later.

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in iOS 6.0 and later.