Class: EKCalendar
Overview
An instance of the EKCalendar class represents a calendar in Event Kit. Use the properties in this class to get attributes about a calendar, such as its title and type. Use the calendarForEntityType:eventStore: method to create a calendar object.
Instance Attribute Summary (collapse)
-
- allowedEntityTypes
readonly
The entity types this calendar can contain.
-
- allowsContentModifications
readonly
A Boolean value that indicates whether you can add, edit, and delete items in the calendar.
-
- calendarIdentifier
readonly
A unique identifier for the calendar.
-
- CGColor
The calendar’s color.
-
- immutable
readonly
A Boolean value indicating whether the calendar’s properties can be edited or deleted.
-
- source
The source object representing the account to which this calendar belongs.
-
- subscribed
readonly
A Boolean value indicating whether the calendar is a subscribed calendar.
-
- supportedEventAvailabilities
readonly
The event availability settings supported by this calendar, as indicated by a bitmask.
-
- title
The calendar’s title.
-
- type
readonly
The calendar’s type.
Class Method Summary (collapse)
-
+ calendarForEntityType:eventStore:
Creates a new calendar that can contain the given entity type.
Methods inherited from EKObject
#hasChanges, #isNew, #refresh, #reset, #rollback
Methods inherited from NSObject
#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version
Constructor Details
This class inherits a constructor from NSObject
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class NSObject
Instance Attribute Details
- (EKEntityMask) allowedEntityTypes (readonly)
The entity types this calendar can contain. (read-only) While Event Kit only allows creation of single-entity calendars, other servers might allow mixed-entity calendars.
- (Boolean) allowsContentModifications (readonly)
A Boolean value that indicates whether you can add, edit, and delete items in the calendar. (read-only)
- (String) calendarIdentifier (readonly)
A unique identifier for the calendar. (read-only) This property is set when the calendar is created and can be used as a local identifier. Use calendarWithIdentifier: to get a calendar with the specified identifier.A full sync with the calendar will lose this identifier. You should have a plan for dealing with a calendar whose identifier is no longer fetch-able by caching its other properties.
- (CGColorRef) CGColor
The calendar’s color.
- (Boolean) immutable (readonly)
A Boolean value indicating whether the calendar’s properties can be edited or deleted. (read-only) If YES, the calendar is immutable; otherwise it is not. Events and reminders can still be added to an immutable calendar.
- (EKSource) source
The source object representing the account to which this calendar belongs. This property can only be set for newly created calendar objects. This property is read-only after the first time it is set; setting a value to this property after the first time it is set will result in an error. Therefore, moving a calendar from one source to another is not supported.
- (Boolean) subscribed (readonly)
A Boolean value indicating whether the calendar is a subscribed calendar. (read-only) If YES, the calendar is a subscribed calendar; otherwise it is not.
- (EKCalendarEventAvailabilityMask) supportedEventAvailabilities (readonly)
The event availability settings supported by this calendar, as indicated by a bitmask. (read-only) If the calendar doesn’t support event availability settings, this value is EKCalendarEventAvailabilityNone.
- (String) title
The calendar’s title.
- (EKCalendarType) type (readonly)
The calendar’s type. (read-only) CalDAV-subscribed calendars are of type EKCalendarTypeCalDAV with isSubscribed set to YES.
Class Method Details
+ (EKCalendar) calendarForEntityType(entityType, eventStore:eventStore)
Creates a new calendar that can contain the given entity type. You can only create calendars that accept either reminders or events. Some servers might allow mixing the two, although it is not common.