EKSource Class Reference
| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/EventKit.framework |
| Availability | Available in iOS 5.0 and later. |
| Declared in | EKSource.h EKTypes.h |
Overview
An instance of the EKSource class represents the account that a calendar belongs to. You do not create instances of this class. You retrieve EKSource objects from an EKEventStore object. Use the sources property to get all the EKSource objects for an event store, and use the methods in this class to access properties of the source object.
Tasks
Accessing Source Properties
-
sourceIdentifierproperty -
sourceTypeproperty -
titleproperty
Accessing Calendars
-
– calendarsForEntityType: -
calendarsproperty Deprecated in iOS 6.0
Properties
sourceIdentifier
A unique identifier for the source object. (read-only)
Availability
- Available in iOS 5.0 and later.
Declared In
EKSource.hsourceType
The type of this source object. (read-only)
Discussion
Possible values are described in EKSourceType.
Availability
- Available in iOS 5.0 and later.
Declared In
EKSource.htitle
The name of this source object. (read-only)
Availability
- Available in iOS 5.0 and later.
Declared In
EKSource.hInstance Methods
calendarsForEntityType:
Returns the calendars that belong to this source object that support a particular entity type.
Parameters
- entityType
The entity type of either an event or a reminder.
Return Value
The calendars belonging to this source that support the entity type.
Availability
- Available in iOS 6.0 and later.
See Also
Declared In
EKSource.hConstants
EKSourceType
The type of source object.
typedef enum {
EKSourceTypeLocal,
EKSourceTypeExchange,
EKSourceTypeCalDAV,
EKSourceTypeMobileMe,
EKSourceTypeSubscribed,
EKSourceTypeBirthdays
} EKSourceType;
Constants
EKSourceTypeLocalRepresents a local source.
Available in iOS 5.0 and later.
Declared in
EKTypes.h.EKSourceTypeExchangeRepresents an Exchange source.
Available in iOS 5.0 and later.
Declared in
EKTypes.h.EKSourceTypeCalDAVRepresents a CalDAV or iCloud source.
Available in iOS 5.0 and later.
Declared in
EKTypes.h.EKSourceTypeMobileMeRepresents a MobileMe source.
Available in iOS 5.0 and later.
Declared in
EKTypes.h.EKSourceTypeSubscribedRepresents a subscribed source.
Available in iOS 5.0 and later.
Declared in
EKTypes.h.EKSourceTypeBirthdaysRepresents a birthday source.
Available in iOS 5.0 and later.
Declared in
EKTypes.h.
Discussion
Use these values to set the sourceType property.
Availability
- Available in iOS 5.0 and later.
Declared In
EKTypes.hEKEntityType
The type of entities allowed for a source.
typedef enum {
EKEntityTypeEvent,
EKEntityTypeReminder
} EKEntityType;
Constants
EKEntityTypeEventRepresents an event.
Available in iOS 6.0 and later.
Declared in
EKTypes.h.EKEntityTypeReminderRepresents a reminder.
Available in iOS 6.0 and later.
Declared in
EKTypes.h.
Availability
- Available in iOS 6.0 and later.
Declared In
EKTypes.hEKEntityMask
A bitmask of EKEntityType for specifying multiple entities at once.
typedef enum {
EKEntityTypeEvent,
EKEntityTypeReminder
} EKEntityMask;
Constants
EKEntityMaskEventRepresents an event.
Available in iOS 6.0 and later.
Declared in
EKTypes.h.EKEntityMaskReminderRepresents a reminder.
Available in iOS 6.0 and later.
Declared in
EKTypes.h.
Availability
- Available in iOS 6.0 and later.
Declared In
EKTypes.h© 2012 Apple Inc. All Rights Reserved. (Last updated: 2012-07-17)