EKEventStore Class

Definition

The repository for Calendar and Reminder events.

[Foundation.Register("EKEventStore", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 8, ObjCRuntime.PlatformArchitecture.Arch64, null)]
public class EKEventStore : Foundation.NSObject
type EKEventStore = class
    inherit NSObject
Inheritance
EKEventStore
Attributes

Remarks

The EventStore is required to perform any operations in EventKit. It can be thought of as the persistent storage, or database, engine for all EventKit data. From EKEventStore you have access to both the calendars and calendar events in the Calendar Application, as well as reminders in the Reminders Application.

Because EKEventStore is like a database engine, it should be long-lived, meaning that it should be created and destroyed as little as possible during the lifetime of an application instance. In fact, it’s recommended that once you create one instance of an EDEventStore in an application, you keep that reference around for the entire lifetime of the application, unless you’re sure you won’t need it again. Additionally, all calls should go to a single EKEventStore instance. For this reason, the Singleton pattern is recommended for keeping a single instance available.

The following code illustrates an easy and efficient way to create a single instance of the EventStore class and make it available statically from within an application:


public class App
{
	public static App Current {
		get { return current; }
	}
	private static App current;
public EKEventStore EventStore {
	get { return eventStore; }
}
protected EKEventStore eventStore;

static App ()
{
	current = new App();
}
protected App () 
{
	eventStore = new EKEventStore ( );
}

}

The code above uses the Singleton pattern to instantiate an instance of the EventStore when the application loads. The EventStore can then be accessed globally from within the application as follows: App.Current.EventStore;

Before being allowed to access any data via the EKEventStore, an application must first request access to either the calendar events data or reminders data, depending on which one you need. To facilitate this, the KEEventStore exposes a method called RequestAccess which, when called, will show an alert view to the user telling them the application is requesting access to either the calendar data, or reminder data, depending on which EKEntityType is passed to it. Because it raises an alert view, the call is asynchronous and will call a completion handler passed as an NSAction (or Lambda) to it which will receive two parameters, a boolean of whether or not access was granted, and an NSError, which, if not-null will contain any error information in the request. For example, the following coded will request access to calendar event data and show an alert view if the request was not granted:


App.Current.EventStore.RequestAccess (EKEntityType.Event, 
	(bool granted, NSError e) => {
		if (granted)
			//do something here
		else
			new UIAlertView ( "Access Denied", 
"User Denied Access to Calendar Data", null,
"ok", null).Show ();
		} );

Once the request has been granted, it will be remembered as long as the application is installed on the device and will not pop up an alert to the user. However, access is only given to the type of resource, either calendar events or reminders granted. If an application needs access to both, it should request both.

Because permission is remembered, it’s relatively cheap to make the request each time, so it’s a good idea to always request access before performing an operation.

Additionally, because the completion handler is called on a separate (non-UI) thread, any updates to the UI in the completion handler should be called via InovkeOnMainThread, otherwise an exception will be thrown, and if not caught, the application will crash.

Constructors

EKEventStore()

Default constructor that initializes a new instance of this class with no parameters.

EKEventStore(EKEntityMask)
EKEventStore(EKSource[])
EKEventStore(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

EKEventStore(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Calendars

Developers should not use this deprecated property. Developers should use 'GetCalendars' instead.

ChangedNotification

Notification constant for Changed

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DefaultCalendarForNewEvents
DefaultCalendarForNewReminders
DelegateSources
Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
EventStoreIdentifier
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self (Inherited from NSObject)
Sources
Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Zone (Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
CancelFetchRequest(IntPtr)
Commit(NSError)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EnumerateEvents(NSPredicate, EKEventSearchCallback)

Enumerates all of the events that match the specified predicate.

Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
EventFromIdentifier(String)
EventsMatching(NSPredicate)

Returns all of the events that match the specified predicate.

ExposedBindings() (Inherited from NSObject)
FetchReminders(NSPredicate, Action<EKReminder[]>)

Fetches the reminders that match the specified predicate.

FetchRemindersAsync(NSPredicate)

Fetches the reminders that match the specified predicate.

FetchRemindersAsync(NSPredicate, IntPtr)
GetAuthorizationStatus(EKEntityType)

The current access the application has for the specified entityType.

GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetCalendar(String)
GetCalendarItem(String)
GetCalendarItems(String)
GetCalendars(EKEntityType)
GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetSource(String)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PredicateForCompleteReminders(NSDate, NSDate, EKCalendar[])

Returns a predicate that represents the completed reminders in a time period from the calendar.

PredicateForEvents(NSDate, NSDate, EKCalendar[])

Returns a predicate that represents events in a time period from the calendar.

PredicateForIncompleteReminders(NSDate, NSDate, EKCalendar[])

Returns a predicate that represents the incomplete reminders in a time period from the calendar.

PredicateForReminders(EKCalendar[])

Returns a predicate that represets all the reminders from the calendar.

PrepareForInterfaceBuilder() (Inherited from NSObject)
RefreshSourcesIfNecessary()
RemoveCalendar(EKCalendar, Boolean, NSError)
RemoveEvent(EKEvent, EKSpan, Boolean, NSError)
RemoveEvents(EKEvent, EKSpan, NSError)
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveReminder(EKReminder, Boolean, NSError)
RequestAccess(EKEntityType, Action<Boolean,NSError>)

Shows, if necessary, the standard permissions dialog for the specified entityType.

RequestAccessAsync(EKEntityType)

Shows, if necessary, the standard permissions dialog for the specified entityType.

Reset()
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SaveCalendar(EKCalendar, Boolean, NSError)
SaveEvent(EKEvent, EKSpan, Boolean, NSError)
SaveEvent(EKEvent, EKSpan, NSError)
SaveReminder(EKReminder, Boolean, NSError)
SetNativeField(String, NSObject) (Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String) (Inherited from NSObject)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also