Class: EKEvent

Inherits:
EKCalendarItem show all

Overview

An instance of the EKEvent class represents an event added to a calendar in the Event Kit framework.

Instance Attribute Summary (collapse)

Attributes inherited from EKCalendarItem

#URL, #alarms, #attendees, #calendar, #calendarItemExternalIdentifier, #calendarItemIdentifier, #creationDate, #hasAlarms, #hasAttendees, #hasNotes, #hasRecurrenceRules, #lastModifiedDate, #location, #notes, #recurrenceRules, #timeZone, #title

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from EKCalendarItem

#addAlarm:, #addRecurrenceRule:, #removeAlarm:, #removeRecurrenceRule:

Methods inherited from EKObject

#hasChanges, #isNew, #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

- (Boolean) allDay

A Boolean value that indicates whether the event is an all-day event.

Returns:

  • (Boolean)

- (EKEventAvailability) availability

The availability setting for the event. This setting is used by CalDAV and Exchange servers to indicate how the event should be treated for scheduling purposes.If the event’s calendar does not support availability settings, this property’s value is EKEventAvailabilityNotSupported.

Returns:

- (Integer) birthdayPersonID (readonly)

The Address Book framework record identifier of the person for this birthday event. (read-only) This property is only set if this is a birthday event; otherwise the property is nil.

Returns:

- (NSDate) endDate

The end date for the event.

Returns:

- (String) eventIdentifier (readonly)

A unique identifier for the event. (read-only) You can use this identifier to look up an event with the EKEventStore method eventWithIdentifier:.If the calendar of an event changes, its identifier most likely changes as well.

Returns:

- (Boolean) isDetached (readonly)

A Boolean value that indicates whether an event is a detached instance of a repeating event. (read-only) This value is YES if and only if the event is part of a repeating event and one or more of its attributes have been modified from the repeating event’s default attributes.

Returns:

  • (Boolean)

- (EKParticipant) organizer (readonly)

The organizer associated with the event. (read-only) This property is nil if the event has no organizer.

Returns:

- (NSDate) startDate

The start date of the event. Floating events such as all-day events are returned in the default time zone.

Returns:

- (EKEventStatus) status (readonly)

The status of the event. (read-only) You should act based on an event’s status only if the status is EKEventStatusCanceled, which indicates that the event has been canceled. Other statuses should be considered informational.

Returns:

Class Method Details

+ (EKEvent) eventWithEventStore(eventStore)

Creates and returns a new event belonging to a specified event store.

Parameters:

  • eventStore (EKEventStore)

    The event store to which the event belongs.

Returns:

Instance Method Details

- (NSComparisonResult) compareStartDateWithEvent(other)

Compares the start date of the receiving event with the start date of another event. You can pass the selector for this method to the NSArray method sortedArrayUsingSelector: to create an array of events sorted by start date.

Parameters:

  • other (EKEvent)

    The event to compare against.

Returns:

  • (NSComparisonResult)

- (Boolean) refresh

Updates the event’s data with the current information in the Calendar database. You should call this method only on events that your application is editing, and only when your application receives the EKEventStoreChangedNotification notification. If this method returns NO, the event has been deleted or otherwise invalidated, and you should not continue to use it.This method does not replace the values of any properties that you have modified.

Returns:

  • (Boolean)

    If the event was successfully refreshed, YES; otherwise, NO.