Mac Developer Library

Developer

EventKit Framework Reference EKParticipant Class Reference

Options
Deployment Target:

On This Page
Language:

EKParticipant

An EKParticipant object represents a participant in a calendar event. A participant can be a person, group, room, or other resource.

Do not create EKParticipant objects directly. Instead, use the property attendees on EKCalendarItem to return an array of EKParticipant objects.

Event Kit cannot add participants to an event nor change participant information. Use the properties in this class to get information about a participant.

  • Returns the address book record that represents the participant.

    Declaration

    Swift

    func ABPersonInAddressBook(_ addressBook: ABAddressBook) -> ABPerson?

    Objective-C

    - (ABPerson *)ABPersonInAddressBook:(ABAddressBook *)addressBook

    Parameters

    addressBook

    The address book to search.

    Return Value

    The address book record for the participant, or nil if the record is not found.

    Discussion

    This method searches for a record match based on the participant’s email address.

    Special Considerations

    Availability

    Available in OS X v10.8 and later.

    Deprecated in OS X v10.11.

  • Represents a participant’s role for an event.

    Declaration

    Swift

    enum EKParticipantRole : Int { case Unknown case Required case Optional case Chair case NonParticipant }

    Objective-C

    typedef enum { EKParticipantRoleUnknown, EKParticipantRoleRequired, EKParticipantRoleOptional, EKParticipantRoleChair, EKParticipantRoleNonParticipant } EKParticipantRole;

    Constants

    • Unknown

      EKParticipantRoleUnknown

      The participant’s role is unknown.

      Available in OS X v10.8 and later.

    • Required

      EKParticipantRoleRequired

      The participant’s attendance is required.

      Available in OS X v10.8 and later.

    • Optional

      EKParticipantRoleOptional

      The participant’s attendance is optional.

      Available in OS X v10.8 and later.

    • Chair

      EKParticipantRoleChair

      The participant is the chair of the event.

      Available in OS X v10.8 and later.

    • NonParticipant

      EKParticipantRoleNonParticipant

      The participant does not have an active role in the event.

      Available in OS X v10.8 and later.

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.

  • Represents a participant’s attendance status for an event.

    Declaration

    Swift

    enum EKParticipantStatus : Int { case Unknown case Pending case Accepted case Declined case Tentative case Delegated case Completed case InProcess }

    Objective-C

    typedef enum { EKParticipantStatusUnknown, EKParticipantStatusPending, EKParticipantStatusAccepted, EKParticipantStatusDeclined, EKParticipantStatusTentative, EKParticipantStatusDelegated, EKParticipantStatusCompleted, EKParticipantStatusInProcess } EKParticipantStatus;

    Constants

    • Unknown

      EKParticipantStatusUnknown

      The participant’s attendance status is unknown.

      Available in OS X v10.8 and later.

    • Pending

      EKParticipantStatusPending

      The participant has yet to respond to the event.

      Available in OS X v10.8 and later.

    • Accepted

      EKParticipantStatusAccepted

      The participant has accepted the event.

      Available in OS X v10.8 and later.

    • Declined

      EKParticipantStatusDeclined

      The participant has declined the event.

      Available in OS X v10.8 and later.

    • Tentative

      EKParticipantStatusTentative

      The participant’s attendance status is tentative.

      Available in OS X v10.8 and later.

    • Delegated

      EKParticipantStatusDelegated

      The participant has delegated attendance to another participant.

      Available in OS X v10.8 and later.

    • Completed

      EKParticipantStatusCompleted

      The participant’s event has completed.

      Available in OS X v10.8 and later.

    • InProcess

      EKParticipantStatusInProcess

      The participant’s event is currently in process.

      Available in OS X v10.8 and later.

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.

  • Represent’s a participant’s type.

    Declaration

    Swift

    enum EKParticipantType : Int { case Unknown case Person case Room case Resource case Group }

    Objective-C

    typedef enum { EKParticipantTypeUnknown, EKParticipantTypePerson, EKParticipantTypeRoom, EKParticipantTypeResource, EKParticipantTypeGroup } EKParticipantType;

    Constants

    • Unknown

      EKParticipantTypeUnknown

      The participant’s type is unknown.

      Available in OS X v10.8 and later.

    • Person

      EKParticipantTypePerson

      The participant is a person.

      Available in OS X v10.8 and later.

    • Room

      EKParticipantTypeRoom

      The participant is a room.

      Available in OS X v10.8 and later.

    • Resource

      EKParticipantTypeResource

      The participant is a resource.

      Available in OS X v10.8 and later.

    • Group

      EKParticipantTypeGroup

      The participant is a group.

      Available in OS X v10.8 and later.

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.