EventKit Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The EventKit namespace provides classes for accessing and manipulating calendar events and reminders stored in the system calendar database.
Classes
| Name | Description |
|---|---|
| EKAlarm |
An alarm in the user's EKCalendar. |
| EKCalendar |
A user's calendar. |
| EKCalendarItem |
The base class for calendar events and reminders. |
| EKErrorCodeExtensions |
Extension methods for the EKErrorCode enumeration. |
| EKEvent |
An event in a user's calendar. |
| EKEventStore |
The repository for Calendar and Reminder events. |
| EKEventStore.Notifications |
Notifications posted by the EKEventStore class. |
| EKObject |
The base-class for persistent Event Kit classes. |
| EKParticipant |
Person invited to an event. |
| EKRecurrenceDayOfWeek |
Represents a day of the week for use with EKRecurrenceRule. |
| EKRecurrenceEnd |
Represents how the EKRecurrence ends. Either by number of ocurrences or using a specific date. |
| EKRecurrenceRule |
Describes the recurring rule for an event. |
| EKReminder |
A calendar reminder. |
| EKSource |
Encapsulates an account that a calendar reflects. |
| EKStructuredLocation |
A 'geofence' that can trigger a calendar item. |
| EKVirtualConferenceDescriptor | |
| EKVirtualConferenceProvider | |
| EKVirtualConferenceRoomTypeDescriptor | |
| EKVirtualConferenceUrlDescriptor | |
Enums
| Name | Description |
|---|---|
| EKAlarmProximity |
An enumeration whose values specify whether an event was raised by entering or leaving a region. |
| EKAlarmType | |
| EKAuthorizationStatus |
An enumeration whose values specify the restrictions on access to the EKEventStore. Retrieved by calling the GetAuthorizationStatus(EKEntityType) method. |
| EKCalendarEventAvailability |
Specifies the types of availability information the calendar is capable of providing for its associated events. |
| EKCalendarType |
Specifies the type of a calendar. |
| EKDay |
Enumeration of the days of the week. |
| EKEntityMask |
An enumeration whose values represent the allowed entity types for a EKCalendar. |
| EKEntityType |
An enumeration that specifies whether an entity is an event or a reminder. |
| EKErrorCode |
Errors returned by Event Kit. |
| EKEventAvailability |
Types of availability |
| EKEventStatus |
The event status. |
| EKParticipantRole |
The role of an EKParticipant |
| EKParticipantScheduleStatus | |
| EKParticipantStatus |
The status of a participant. |
| EKParticipantType |
The kind of participant to the event. |
| EKRecurrenceFrequency |
The recurring frequency for the event. |
| EKReminderPriority | |
| EKSourceType |
An enumeration whose values indicate the type of a EKSource object. |
| EKSpan |
Determines how changes to an event will be applied, either it affects a single instance or affects all instances. |
| EKWeekday |
Enumerates the days of the week. |
Delegates
| Name | Description |
|---|---|
| EKEventSearchCallback |
Delegate signature for the event enumeration method in EKEventStore |
| EKEventStoreRequestAccessCompletionHandler | |
| VirtualConferenceHandler | |
| VirtualConferenceRoomTypeHandler | |
Remarks
The EventKit framework provides a consistent interface for accessing calendar and reminder data across iOS, macOS, tvOS, and Mac Catalyst. Applications can use this framework to retrieve, create, edit, and delete calendar events and reminders.
Key classes in this namespace include EKEventStore for accessing the calendar database, EKEvent for representing calendar events, EKReminder for reminders, and EKCalendar for managing calendars.
Before accessing calendar data, applications must request permission from the user using the RequestAccess(EKEntityType, Action<Boolean,NSError>) method.