EKParticipant Class Reference

Inherits from
EKObject : NSObject
Conforms to
NSCopying
NSObject (NSObject)
Framework
/System/Library/Frameworks/EventKit.framework
Availability
Available in iOS 4.0 and later.
Companion guide
Calendar and Reminders Programming Guide
Declared in
EKParticipant.h
EKTypes.h

Overview

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.

Tasks

Accessing Participant Properties

Finding Participant Address Book Records

Properties

isCurrentUser

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

@property(readonly) BOOL *isCurrentUser
Availability
  • Available in iOS 6.0 and later.
Declared In
EKParticipant.h

name

The participant’s name. (read-only)

@property(readonly) NSString *name
Availability
  • Available in iOS 4.0 and later.
Declared In
EKParticipant.h

participantRole

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

@property(readonly) EKParticipantRole participantRole
Availability
  • Available in iOS 4.0 and later.
See Also
Declared In
EKParticipant.h

participantStatus

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

@property(readonly) EKParticipantStatus participantStatus
Availability
  • Available in iOS 4.0 and later.
See Also
Declared In
EKParticipant.h

participantType

The participant’s type. (read-only)

@property(readonly) EKParticipantType participantType
Availability
  • Available in iOS 4.0 and later.
See Also
Declared In
EKParticipant.h

URL

The URL representing this participant. (read-only)

@property(readonly) NSURL *URL
Availability
  • Available in iOS 4.0 and later.
Declared In
EKParticipant.h

Instance Methods

ABRecordWithAddressBook:

Returns the address book record that represents the participant.

- (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
Availability
  • Available in iOS 4.0 and later.
Declared In
EKParticipant.h

Constants

Participant Roles

Represents a participant’s role for an event.

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

The participant’s role is unknown.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantRoleRequired

The participant’s attendance is required.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantRoleOptional

The participant’s attendance is optional.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantRoleChair

The participant is the chair of the event.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantRoleNonParticipant

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

Available in iOS 4.0 and later.

Declared in EKTypes.h.

Participant Statuses

Represents a participant’s attendance status for an event.

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

The participant’s attendance status is unknown.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantStatusPending

The participant has yet to respond to the event.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantStatusAccepted

The participant has accepted the event.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantStatusDeclined

The participant has declined the event.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantStatusTentative

The participant’s attendance status is tentative.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantStatusDelegated

The participant has delegated attendance to another participant.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantStatusCompleted

The participant’s event has completed.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantStatusInProcess

The participant’s event is currently in process.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

Participant Types

Represent’s a participant’s type.

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

The participant’s type is unknown.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantTypePerson

The participant is a person.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantTypeRoom

The participant is a room.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantTypeResource

The participant is a resource.

Available in iOS 4.0 and later.

Declared in EKTypes.h.

EKParticipantTypeGroup

The participant is a group.

Available in iOS 4.0 and later.

Declared in EKTypes.h.



© 2012 Apple Inc. All Rights Reserved. (Last updated: 2012-07-17)

Did this document help you? Yes It's good, but... Not helpful...