iOS 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. More...

Inheritance


Conforms To


Import Statement


import EventKit @import EventKit;

Availability


Available in iOS 4.0 and later.
  • 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

    import EventKit

    Availability

    Available in iOS 6.0 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

    import EventKit

    Availability

    Available in iOS 4.0 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

    import EventKit

    Availability

    Available in iOS 4.0 and later.

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

    Declaration

    Swift

    var participantStatus: EKParticipantStatus { get }

    Objective-C

    @property(nonatomic, readonly) EKParticipantStatus participantStatus

    Import Statement

    import EventKit

    Availability

    Available in iOS 4.0 and later.

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

    Declaration

    Swift

    var participantType: EKParticipantType { get }

    Objective-C

    @property(nonatomic, readonly) EKParticipantType participantType

    Import Statement

    import EventKit

    Availability

    Available in iOS 4.0 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

    import EventKit

    Availability

    Available in iOS 4.0 and later.

  • Returns the address book record that represents the participant.

    Declaration

    Swift

    func ABRecordWithAddressBook(_ addressBook: ABAddressBook!) -> Unmanaged<ABRecord>!

    Objective-C

    - (ABRecordRef)ABRecordWithAddressBook:(ABAddressBookRef)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

    import EventKit

    Availability

    Available in iOS 4.0 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 iOS 4.0 and later.

    • EKParticipantRoleRequired

      EKParticipantRoleRequired

      The participant’s attendance is required.

      Available in iOS 4.0 and later.

    • EKParticipantRoleOptional

      EKParticipantRoleOptional

      The participant’s attendance is optional.

      Available in iOS 4.0 and later.

    • EKParticipantRoleChair

      EKParticipantRoleChair

      The participant is the chair of the event.

      Available in iOS 4.0 and later.

    • EKParticipantRoleNonParticipant

      EKParticipantRoleNonParticipant

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

      Available in iOS 4.0 and later.

    Import Statement

    import EventKit

    Availability

    Available in iOS 4.0 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 iOS 4.0 and later.

    • EKParticipantStatusPending

      EKParticipantStatusPending

      The participant has yet to respond to the event.

      Available in iOS 4.0 and later.

    • EKParticipantStatusAccepted

      EKParticipantStatusAccepted

      The participant has accepted the event.

      Available in iOS 4.0 and later.

    • EKParticipantStatusDeclined

      EKParticipantStatusDeclined

      The participant has declined the event.

      Available in iOS 4.0 and later.

    • EKParticipantStatusTentative

      EKParticipantStatusTentative

      The participant’s attendance status is tentative.

      Available in iOS 4.0 and later.

    • EKParticipantStatusDelegated

      EKParticipantStatusDelegated

      The participant has delegated attendance to another participant.

      Available in iOS 4.0 and later.

    • EKParticipantStatusCompleted

      EKParticipantStatusCompleted

      The participant’s event has completed.

      Available in iOS 4.0 and later.

    • EKParticipantStatusInProcess

      EKParticipantStatusInProcess

      The participant’s event is currently in process.

      Available in iOS 4.0 and later.

    Import Statement

    import EventKit

    Availability

    Available in iOS 4.0 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 iOS 4.0 and later.

    • EKParticipantTypePerson

      EKParticipantTypePerson

      The participant is a person.

      Available in iOS 4.0 and later.

    • EKParticipantTypeRoom

      EKParticipantTypeRoom

      The participant is a room.

      Available in iOS 4.0 and later.

    • EKParticipantTypeResource

      EKParticipantTypeResource

      The participant is a resource.

      Available in iOS 4.0 and later.

    • EKParticipantTypeGroup

      EKParticipantTypeGroup

      The participant is a group.

      Available in iOS 4.0 and later.

    Import Statement

    import EventKit

    Availability

    Available in iOS 4.0 and later.