Mac Developer Library

Developer

EventKit Framework Reference EKParticipant Class Reference

Options
Deployment Target:

On This Page
Language:

EKParticipant

Inheritance


Conforms To


Import Statement


Swift

import EventKit

Objective-C

@import EventKit;

Availability


Available in OS X v10.8 and later.

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.

  • A Boolean value indicating whether this participant represents the owner of this account. (read-only)

    Declaration

    Swift

    var isCurrentUser: Bool { get }

    Objective-C

    @property(nonatomic, readonly) BOOL isCurrentUser

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.9 and later.

  • name name Property

    The participant’s name. (read-only)

    Declaration

    Swift

    var name: String! { get }

    Objective-C

    @property(nonatomic, readonly) NSString *name

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.

  • The participant’s role in the event. (read-only)

    Declaration

    Swift

    var participantRole: EKParticipantRole { get }

    Objective-C

    @property(nonatomic, readonly) EKParticipantRole participantRole

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.

  • The participant’s attendance status. (read-only)

    Declaration

    Swift

    var participantStatus: EKParticipantStatus { get }

    Objective-C

    @property(nonatomic, readonly) EKParticipantStatus participantStatus

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.

  • The participant’s type. (read-only)

    Declaration

    Swift

    var participantType: EKParticipantType { get }

    Objective-C

    @property(nonatomic, readonly) EKParticipantType participantType

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.

  • URL URL Property

    The URL representing this participant. (read-only)

    Declaration

    Swift

    var URL: NSURL! { get }

    Objective-C

    @property(nonatomic, readonly) NSURL *URL

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.

  • 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

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in OS X v10.8 and later.

  • Represents a participant’s role for an event.

    Declaration

    Swift

    struct EKParticipantRole { init(_ value: UInt32) var value: UInt32 }

    Objective-C

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

    Constants

    • EKParticipantRoleUnknown

      EKParticipantRoleUnknown

      The participant’s role is unknown.

      Available in OS X v10.8 and later.

    • EKParticipantRoleRequired

      EKParticipantRoleRequired

      The participant’s attendance is required.

      Available in OS X v10.8 and later.

    • EKParticipantRoleOptional

      EKParticipantRoleOptional

      The participant’s attendance is optional.

      Available in OS X v10.8 and later.

    • EKParticipantRoleChair

      EKParticipantRoleChair

      The participant is the chair of the event.

      Available in OS X v10.8 and later.

    • EKParticipantRoleNonParticipant

      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

    struct EKParticipantStatus { init(_ value: UInt32) var value: UInt32 }

    Objective-C

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

    Constants

    • EKParticipantStatusUnknown

      EKParticipantStatusUnknown

      The participant’s attendance status is unknown.

      Available in OS X v10.8 and later.

    • EKParticipantStatusPending

      EKParticipantStatusPending

      The participant has yet to respond to the event.

      Available in OS X v10.8 and later.

    • EKParticipantStatusAccepted

      EKParticipantStatusAccepted

      The participant has accepted the event.

      Available in OS X v10.8 and later.

    • EKParticipantStatusDeclined

      EKParticipantStatusDeclined

      The participant has declined the event.

      Available in OS X v10.8 and later.

    • EKParticipantStatusTentative

      EKParticipantStatusTentative

      The participant’s attendance status is tentative.

      Available in OS X v10.8 and later.

    • EKParticipantStatusDelegated

      EKParticipantStatusDelegated

      The participant has delegated attendance to another participant.

      Available in OS X v10.8 and later.

    • EKParticipantStatusCompleted

      EKParticipantStatusCompleted

      The participant’s event has completed.

      Available in OS X v10.8 and later.

    • EKParticipantStatusInProcess

      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

    struct EKParticipantType { init(_ value: UInt32) var value: UInt32 }

    Objective-C

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

    Constants

    • EKParticipantTypeUnknown

      EKParticipantTypeUnknown

      The participant’s type is unknown.

      Available in OS X v10.8 and later.

    • EKParticipantTypePerson

      EKParticipantTypePerson

      The participant is a person.

      Available in OS X v10.8 and later.

    • EKParticipantTypeRoom

      EKParticipantTypeRoom

      The participant is a room.

      Available in OS X v10.8 and later.

    • EKParticipantTypeResource

      EKParticipantTypeResource

      The participant is a resource.

      Available in OS X v10.8 and later.

    • EKParticipantTypeGroup

      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.