Framework

EventKit

Create, view, and edit calendar and reminder events.

Overview

The EventKit framework provides access to calendar and reminders data so you and your users can create, retrieve, and edit calendar items in your app. In iOS, EventKitUI provides user interfaces you can implement in your app to let users create and edit calendar items.

You can use EventKit to set up alarms and create recurring events. And if a change to the Calendar database occurs from outside your app, EventKit detects the change and sends a notification, allowing you to stay up to date.

Topics

First Steps

Accessing the Event Store

Request access to a user's calendar data through the event store.

EKEventStore

An object that accesses the user’s calendar and reminder events and supports the scheduling of new events.

Events and Reminders

Creating Events and Reminders

Create and modify events and reminders in a user's database.

Retrieving Events and Reminders

Fetch events and reminders from the Calendar database.

Updating with Notifications

Register to be notified about changes and keep your app up to date.

EKEvent

A class that represents an event added to a calendar.

EKReminder

A class that represents a reminder added to a calendar.

Calendars

EKCalendar

A class that represents a calendar in Event Kit.

EKParticipant

A class that represents a participant in a calendar event.

Recurrence

Creating a Recurring Event

Set up an event or reminder that repeats.

EKRecurrenceDayOfWeek

A class that represents the day of the week.

EKRecurrenceEnd

A class that defines the end of a recurrence rule.

EKRecurrenceRule

A class that describes the recurrence pattern for a recurring event.

Alarms

Setting an Alarm

Alert users of events and reminders with an alarm.

EKAlarm

A class that represents an alarm.

EKStructuredLocation

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

Common Objects

EKCalendarItem

An abstract superclass for calendar events and reminders.

EKObject

An abstract superclass for all Event Kit classes that have instances that are persistent.

EKSource

An abstract superclass that represents the account a calendar belongs to.

Errors

EKErrorCode

Values that are returned as the error code property of an NSError object.

EKErrorDomain

String that identifies the EventKit error domain.

See Also

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software