Package apple.eventkit

Class EKEventStore

  • All Implemented Interfaces:
    NSObject
    public class EKEventStore
extends NSObject
    EKEventStore The EKEventStore class provides an interface for accessing and manipulating calendar events and reminders. The EKEventStore class is the main point of contact for accessing Calendar data. You must create a EKEventStore object in order to retrieve/add/delete events or reminders from the Calendar database. Events, Reminders, and Calendar objects retrieved from an event store cannot be used with any other event store. It is generally best to hold onto a long-lived instance of an event store, most likely as a singleton instance in your application.

    • Constructor Detail

      • EKEventStore

        protected EKEventStore​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • authorizationStatusForEntityType

        public static long authorizationStatusForEntityType​(long entityType)
        authorizationStatusForEntityType: Returns the authorization status for the given entity type

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)

      • new_objc

        public static java.lang.Object new_objc()

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • calendarItemWithIdentifier

        public EKCalendarItem calendarItemWithIdentifier​(java.lang.String identifier)
        calendarItemWithIdentifier: Returns either a reminder or the first occurrence of an event.

      • calendarItemsWithExternalIdentifier

        public NSArray<? extends EKCalendarItem> calendarItemsWithExternalIdentifier​(java.lang.String externalIdentifier)
        calendarItemsWithExternalIdentifier: Returns either matching reminders or the first occurrences of any events matching the given external identifier. This method returns a set of EKEvents or EKReminders with the given external identifier. Due to reasons discussed in -[EKCalendarItem calendarItemExternalIdentifier], there may be more than one matching calendar item.
        Parameters:
        externalIdentifier - The value obtained from EKCalendarItem's calendarItemExternalIdentifier property
        Returns:
        An unsorted array of EKCalendarItem instances

      • calendarWithIdentifier

        public EKCalendar calendarWithIdentifier​(java.lang.String identifier)
        calendarWithIdentifier: Returns a calendar with a specified identifier.

      • calendars

        @Deprecated
public NSArray<? extends EKCalendar> calendars()
        Deprecated.
        calendars While this returns an array, the calendars are unordered. This call is deprecated and only returns calendars that support events. If you want reminder calendars you should use calendarsForEntityType:

      • calendarsForEntityType

        public NSArray<? extends EKCalendar> calendarsForEntityType​(long entityType)
        calendarsForEntityType Returns calendars that support a given entity type (reminders, events)

      • cancelFetchRequest

        public void cancelFetchRequest​(java.lang.Object fetchIdentifier)
        cancelFetchRequest: Given a value returned from fetchRemindersMatchingPredicate, this method can be used to cancel the request. Once called, the completion block specified in fetchReminders... will not be called.

      • commit

        public boolean commit​(org.moe.natj.general.ptr.Ptr<NSError> error)
        commit: Commits pending changes to the database. If you use saveCalendar/saveEvent/removeCalendar/removeEvent, etc. and you pass NO to their parameter, you are batching changes for a later commit. This method does that commit. This allows you to save the database only once for many additions or changes. If you pass YES to methods' commit parameter, then you don't need to call this method. This method will return YES as long as nothing went awry, even if nothing was actually committed. If it returns NO, error should contain the reason it became unhappy. On WatchOS, modifying the database is not supported.

      • defaultCalendarForNewEvents

        public EKCalendar defaultCalendarForNewEvents()
        [@property] defaultCalendarForNewEvents Returns the calendar that events should be added to by default. This may be nil if there is no default calendar for new events.

      • defaultCalendarForNewReminders

        public EKCalendar defaultCalendarForNewReminders()
        defaultCalendarForNewReminders Returns the calendar that reminders should be added to by default. This may be nil if there is no default calendar for new reminders.

      • enumerateEventsMatchingPredicateUsingBlock

        public void enumerateEventsMatchingPredicateUsingBlock​(NSPredicate predicate,
                                                       EKEventStore.Block_enumerateEventsMatchingPredicateUsingBlock block)
        enumerateEventsMatchingPredicate:usingBlock: Searches for events that match the given predicate. This call executes a search for the events indicated by the predicate passed to it, calling the block specified in the callback parameter for each event. It only includes events which have been committed (e.g. those saved using saveEvent:commit:NO are not included until commit: is called.) This method is synchronous. If you want async behavior, you should either use dispatch_async or NSOperation to run the query someplace other than the main thread.
        Parameters:
        predicate - The predicate to invoke. If this predicate was not created with the predicate creation functions in this class, an exception is raised.
        block - The block to call for each event. Your block should return YES in the stop parameter to stop iterating.

      • eventStoreIdentifier

        public java.lang.String eventStoreIdentifier()
        [@property] eventStoreIdentifier Returns a unique identifier string representing this calendar store.

      • eventWithIdentifier

        public EKEvent eventWithIdentifier​(java.lang.String identifier)
        eventWithIdentifier: Returns the first occurrence of an event matching the given event identifier.
        Parameters:
        identifier - The eventIdentifier to search for.
        Returns:
        An EKEvent object, or nil if not found.

      • eventsMatchingPredicate

        public NSArray<? extends EKEvent> eventsMatchingPredicate​(NSPredicate predicate)
        eventsMatchingPredicate: Searches for events that match the given predicate. This call executes a search for the events indicated by the predicate passed to it. It only includes events which have been committed (e.g. those saved using saveEvent:commit:NO are not included until commit: is called.) It is synchronous. If you want async behavior, you should either use dispatch_async or NSOperation to run the query someplace other than the main thread, and then funnel the array back to the main thread.
        Parameters:
        predicate - The predicate to invoke. If this predicate was not created with the predicate creation functions in this class, an exception is raised.
        Returns:
        An array of EKEvent objects, or nil. There is no guaranteed order to the events.

      • fetchRemindersMatchingPredicateCompletion

        public java.lang.Object fetchRemindersMatchingPredicateCompletion​(NSPredicate predicate,
                                                                  EKEventStore.Block_fetchRemindersMatchingPredicateCompletion completion)
        fetchRemindersMatchingPredicate:completion: Fetches reminders asynchronously. This method fetches reminders asynchronously and returns a value which can be used in cancelFetchRequest: to cancel the request later if desired. The completion block is called with an array of reminders that match the given predicate (or potentially nil). This only includes reminders which have been committed (e.g. those saved using saveReminder:commit:NO are not included until commit: is called.)

      • predicateForCompletedRemindersWithCompletionDateStartingEndingCalendars

        public NSPredicate predicateForCompletedRemindersWithCompletionDateStartingEndingCalendars​(NSDate startDate,
                                                                                           NSDate endDate,
                                                                                           NSArray<? extends EKCalendar> calendars)
        predicateForCompletedRemindersWithCompletionDateStarting:ending:calendars: Fetch completed reminders in a set of calendars. You can use this method to search for reminders completed between a range of dates. You can pass nil for start date to find all reminders completed before endDate. You can pass nil for both start and end date to get all completed reminders in the specified calendars. You can pass nil for calendars to fetch from all available calendars.

      • predicateForEventsWithStartDateEndDateCalendars

        public NSPredicate predicateForEventsWithStartDateEndDateCalendars​(NSDate startDate,
                                                                   NSDate endDate,
                                                                   NSArray<? extends EKCalendar> calendars)
        predicateForEventsWithStartDate:endDate:calendars: Creates a predicate for use with eventsMatchingPredicate or enumerateEventsMatchingPredicate:usingBlock:. Creates a simple query predicate to search for events within a certain date range. At present, this will return events in the default time zone ([NSTimeZone defaultTimeZone]). For performance reasons, this method will only return events within a four year timespan. If the date range between the startDate and endDate is greater than four years, then it will be shortened to the first four years.
        Parameters:
        startDate - The start date.
        endDate - The end date.
        calendars - The calendars to search for events in, or nil to search all calendars.

      • predicateForIncompleteRemindersWithDueDateStartingEndingCalendars

        public NSPredicate predicateForIncompleteRemindersWithDueDateStartingEndingCalendars​(NSDate startDate,
                                                                                     NSDate endDate,
                                                                                     NSArray<? extends EKCalendar> calendars)
        predicateForIncompleteRemindersWithDueDateStarting:ending:calendars: Fetch incomplete reminders in a set of calendars. You can use this method to search for incomplete reminders due in a range. You can pass nil for start date to find all reminders due before endDate. You can pass nil for both start and end date to get all incomplete reminders in the specified calendars. You can pass nil for calendars to fetch from all available calendars.

      • predicateForRemindersInCalendars

        public NSPredicate predicateForRemindersInCalendars​(NSArray<? extends EKCalendar> calendars)
        predicateForRemindersInCalendars: Fetch all reminders in a set of calendars. You can pass nil for calendars to fetch from all available calendars.

      • refreshSourcesIfNecessary

        public void refreshSourcesIfNecessary()
        refreshSourcesIfNecessary Cause a sync to potentially occur taking into account the necessity of it. You can call this method to pull new data from remote sources. This only updates the event store's data. If you want to update your objects after refreshing the sources, you should call refresh on each of them afterwards. On iOS, this sync only occurs if deemed necessary. On OS X, this will occur regardless of necessity, but may change in a future release to match the iOS behavior. On WatchOS, initiating sync is not available. Sync will occur automatically with the paired iOS device.

      • removeCalendarCommitError

        public boolean removeCalendarCommitError​(EKCalendar calendar,
                                         boolean commit,
                                         org.moe.natj.general.ptr.Ptr<NSError> error)
        removeCalendar:commit:error: Removes a calendar from the database. This method attempts to delete the given calendar from the calendar database. It returns YES if successful and NO otherwise. Passing a calendar fetched from another EKEventStore instance into this function will raise an exception. If the calendar supports multiple entity types (allowedEntityTypes), but the user has not granted you access to all those entity types, then we will delete all of the entity types for which you have access and remove that entity type from the allowedEntityTypes. For example: If a calendar supports both events and reminders, but you only have access to reminders, we will delete all the reminders and make the calendar only support events. If you have access to all of its allowedEntityTypes, then it will delete the calendar and all of the events and reminders in the calendar. On WatchOS, modifying the database is not supported.
        Parameters:
        calendar - The calendar to delete.
        commit - Pass YES to cause the database to save. You can pass NO to batch multiple changes and then call commit: to save them all at once.
        error - If an error occurs, this will contain a valid NSError object on exit.

      • removeEventSpanCommitError

        public boolean removeEventSpanCommitError​(EKEvent event,
                                          long span,
                                          boolean commit,
                                          org.moe.natj.general.ptr.Ptr<NSError> error)

      • removeEventSpanError

        public boolean removeEventSpanError​(EKEvent event,
                                    long span,
                                    org.moe.natj.general.ptr.Ptr<NSError> error)
        removeEvent:span:error: Removes an event from the calendar store. This method attempts to remove the event from the calendar database. It returns YES if successful and NO otherwise. It's possible for this method to return NO, and error will be set to nil. This occurs if the event wasn't ever added and didn't need removing. This means the correct way to detect failure is a result of NO and a non-nil error parameter. Passing an event from another CalendarStore into this function will raise an exception. After an event is removed, it is no longer tied to this calendar store, and all data in the event is cleared except for the eventIdentifier. On WatchOS, modifying the database is not supported.
        Parameters:
        event - The event to save.
        span - The span to use (this event, or this and future events).
        error - If an error occurs, this will contain a valid NSError object on exit.

      • removeReminderCommitError

        public boolean removeReminderCommitError​(EKReminder reminder,
                                         boolean commit,
                                         org.moe.natj.general.ptr.Ptr<NSError> error)
        removeReminder:commit:error: Removes a reminder from the event store. This method attempts to remove the reminder from the event store database. It returns YES if successful and NO otherwise. Passing a reminder from another EKEventStore into this function will raise an exception. After a reminder is removed, it is no longer tied to this event store. On WatchOS, modifying the database is not supported.
        Parameters:
        reminder - The reminder to save.
        commit - Whether to save to the database or not. Pass NO to batch changes together and commit with [EKEventStore commit:].
        error - If an error occurs, this will contain a valid NSError object on exit.

      • requestAccessToEntityTypeCompletion

        public void requestAccessToEntityTypeCompletion​(long entityType,
                                                EKEventStore.Block_requestAccessToEntityTypeCompletion completion)
        requestAccessToEntityType:completion: Users are able to grant or deny access to event and reminder data on a per-app basis. To request access to event and/or reminder data, call -requestAccessToEntityType:completion:. This will not block the app while the user is being asked to grant or deny access. Until access has been granted for an entity type, the event store will not contain any calendars for that entity type, and any attempt to save will fail. The user will only be prompted the first time access is requested; any subsequent instantiations of EKEventStore will use the existing permissions. When the user taps to grant or deny access, the completion handler will be called on an arbitrary queue.

      • reset

        public void reset()
        reset Resets the event store. You can use this method to forget ALL changes made to the event store (all additions, all fetched objects, etc.). It essentially is as if you released the store and then created a new one. It brings it back to its initial state. All objects ever created/fetched, etc. using this store are no longer connected to it and are considered invalid.

      • saveCalendarCommitError

        public boolean saveCalendarCommitError​(EKCalendar calendar,
                                       boolean commit,
                                       org.moe.natj.general.ptr.Ptr<NSError> error)
        saveCalendar:commit:error: Saves changes to a calendar, or adds a new calendar to the database. This method attempts to save the given calendar to the calendar database. It returns YES if successful and NO otherwise. Passing a calendar fetched from another EKEventStore instance into this function will raise an exception. On WatchOS, saving changes is not supported.
        Parameters:
        calendar - The calendar to save.
        commit - Pass YES to cause the database to save. You can pass NO to save multiple calendars and then call commit: to save them all at once.
        error - If an error occurs, this will contain a valid NSError object on exit.

      • saveEventSpanCommitError

        public boolean saveEventSpanCommitError​(EKEvent event,
                                        long span,
                                        boolean commit,
                                        org.moe.natj.general.ptr.Ptr<NSError> error)
        These variants of the above allow you to batch changes by passing NO to commit. You can commit all changes later with [EKEventStore commit:]

      • saveEventSpanError

        public boolean saveEventSpanError​(EKEvent event,
                                  long span,
                                  org.moe.natj.general.ptr.Ptr<NSError> error)
        saveEvent:span:error: Saves changes to an event permanently. This method attempts to save the event to the calendar database. It returns YES if successful and NO otherwise. It's possible for this method to return NO, and error will be set to nil. This occurs if the event wasn't dirty and didn't need saving. This means the correct way to detect failure is a result of NO and a non-nil error parameter. Passing an event fetched from another EKEventStore instance into this function will raise an exception. After an event is successfully saved, it is also put into sync with the database, meaning that all fields you did not change will be updated to the latest values. If you save the event, but it was deleted by a different store/process, you will effectively recreate the event as a new event. On WatchOS, saving changes is not supported.
        Parameters:
        event - The event to save.
        span - The span to use (this event, or this and future events).
        error - If an error occurs, this will contain a valid NSError object on exit.

      • saveReminderCommitError

        public boolean saveReminderCommitError​(EKReminder reminder,
                                       boolean commit,
                                       org.moe.natj.general.ptr.Ptr<NSError> error)
        saveReminder:commit:error: Saves changes to a reminder. This method attempts to save the reminder to the event store database. It returns YES if successful and NO otherwise. Passing a reminder fetched from another EKEventStore instance into this function will raise an exception. After a reminder is successfully saved, its fields are updated to the latest values in the database. On WatchOS, saving changes is not supported.
        Parameters:
        reminder - The reminder to save.
        commit - Whether to save to the database or not. Pass NO to batch changes together and commit with [EKEventStore commit:].
        error - If an error occurs, this will contain a valid NSError object on exit.

      • sourceWithIdentifier

        public EKSource sourceWithIdentifier​(java.lang.String identifier)
        sourceWithIdentifier: Returns a source with a specified identifier.

      • sources

        public NSArray<? extends EKSource> sources()
        [@property] sources Returns an unordered array of sources.

      • delegateSources

        public NSArray<? extends EKSource> delegateSources()
        [@property] delegateSources Returns an unordered array of sources for all available delegates. By default, delegates are not included in an event store's sources. To work with delegates, you can create a new event store and pass in the sources, including sources returned from this method, that you're interested in.