Class

EKAlarm

A class that represents an alarm.

Declaration

@interface EKAlarm : EKObject

Overview

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

Topics

Creating an Alarm

+ alarmWithAbsoluteDate:

Creates and returns an alarm with an absolute date.

+ alarmWithRelativeOffset:

Creates and returns an alarm with a relative offset.

Accessing Alarm Dates

absoluteDate

The absolute date for the alarm.

relativeOffset

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

Setting GeoFence-based Alarms

EKAlarmProximity

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

proximity

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

structuredLocation

The location to trigger an alarm.

Triggering Alarm Actions

These properties are only available in macOS 10.8 or later.

EKAlarmType

Possible values that can be read from the type property.

type

The type of action to trigger when the alarm fires.

emailAddress

The recipient of an email to send when the alarm triggers.

soundName

The name of the sound to play when the alarm triggers.

url

The URL to open when the alarm triggers.

Deprecated

Relationships

Inherits From

Conforms To

See Also

Alarms

Setting an Alarm

Alert users of events and reminders with an alarm.

EKStructuredLocation

A class that specifies a geofence used to trigger the alarm of a calendar item.