Platforms to show: All Mac Windows Linux Cross-Platform
Back to CalCalendarStoreMBS class.
CalCalendarStoreMBS.calendars as CalCalendarMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If the user has iCal data from a previous version of Mac OS X, but has not launched iCal in 10.5, this will return an array of empty calendars. iCal needs to be launched at least once in order to migrate the user's calendar data.
If no calendar data from any version of Mac OS X exists, then this method will create and return two default calendars, named Home and Work.
Some examples using this method:
CalCalendarStoreMBS.calendarWithTitle(Title as string) as CalCalendarMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 14.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Title comparison is case insensitive.
Returns nil on any error.
CalCalendarStoreMBS.calendarWithUID(UID as string) as CalCalendarMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If no record with this UID exists, nil is returned.
CalCalendarStoreMBS.Constructor
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is the main class. Keep an object of it around as long as you use the calendar classes.
CalCalendarStoreMBS.events(StartDate as date, EndDate as date) as CalEventMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is the function which uses all calendars.
For performance reasons, this method will only return occurrences of repeating events that fall within a specific four year timespan. If the date range between the startDate and endDate is greater than four years, then the timespan containing recurrences is always the first four years of date range.
See also:
- events(StartDate as date, EndDate as date, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendars() as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendars() as CalCalendarMBS) as CalEventMBS()
CalCalendarStoreMBS.events(StartDate as date, EndDate as date, calendar as CalCalendarMBS) as CalEventMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
For performance reasons, this method will only return occurrences of repeating events that fall within a specific four year timespan. If the date range between the startDate and endDate is greater than four years, then the timespan containing recurrences is always the first four years of date range.
See also:
- events(StartDate as date, EndDate as date) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendars() as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendars() as CalCalendarMBS) as CalEventMBS()
CalCalendarStoreMBS.events(StartDate as date, EndDate as date, calendars() as CalCalendarMBS) as CalEventMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
For performance reasons, this method will only return occurrences of repeating events that fall within a specific four year timespan. If the date range between the startDate and endDate is greater than four years, then the timespan containing recurrences is always the first four years of date range.
See also:
- events(StartDate as date, EndDate as date) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendars() as CalCalendarMBS) as CalEventMBS()
CalCalendarStoreMBS.events(StartDate as date, EndDate as date, eventUID as string) as CalEventMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is the function which uses all calendars.
For performance reasons, this method will only return occurrences of repeating events that fall within a specific four year timespan. If the date range between the startDate and endDate is greater than four years, then the timespan containing recurrences is always the first four years of date range.
See also:
- events(StartDate as date, EndDate as date) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendars() as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendars() as CalCalendarMBS) as CalEventMBS()
CalCalendarStoreMBS.events(StartDate as date, EndDate as date, eventUID as string, calendar as CalCalendarMBS) as CalEventMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
For performance reasons, this method will only return occurrences of repeating events that fall within a specific four year timespan. If the date range between the startDate and endDate is greater than four years, then the timespan containing recurrences is always the first four years of date range.
See also:
- events(StartDate as date, EndDate as date) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendars() as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendars() as CalCalendarMBS) as CalEventMBS()
CalCalendarStoreMBS.events(StartDate as date, EndDate as date, eventUID as string, calendars() as CalCalendarMBS) as CalEventMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
For performance reasons, this method will only return occurrences of repeating events that fall within a specific four year timespan. If the date range between the startDate and endDate is greater than four years, then the timespan containing recurrences is always the first four years of date range.
See also:
- events(StartDate as date, EndDate as date) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendar as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, calendars() as CalCalendarMBS) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string) as CalEventMBS()
- events(StartDate as date, EndDate as date, eventUID as string, calendar as CalCalendarMBS) as CalEventMBS()
CalCalendarStoreMBS.eventsMT(StartDate as date, EndDate as date, calendars() as CalCalendarMBS = nil) as CalEventMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 16.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
For performance reasons, this method will only return occurrences of repeating events that fall within a specific four year timespan. If the date range between the startDate and endDate is greater than four years, then the timespan containing recurrences is always the first four years of date range.
If calendars array is nil, we use all calendars.
The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.
CalCalendarStoreMBS.eventWithUID(UID as string, occurrence as date) as CalEventMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns nil on any error.
uid: The unique identifier of an event.
date: The date of a recurring event. Pass nil if the event is not recurring.
Returns a CalEvent object that matches the specified unique identifier and date. Returns nil if the event is not found, or the event is recurring and date is not specified.
Available in Mac OS X v10.5 and later.
CalCalendarStoreMBS.removeCalendar(calendar as CalCalendarMBS, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Return
CalCalendarStoreMBS.removeEvent(theEvent as CalEventMBS, span as Integer, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true on success and false on failure.
Error is stored in the error object.
CalCalendarStoreMBS.removeTask(task as CalTaskMBS, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true on success and false on failure.
Error is stored in the error object.
CalCalendarStoreMBS.saveCalendar(calendar as CalCalendarMBS, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The saveCalendar and the removeCalendar calendars allow the client to add, modify, and remove calendars in the user's calendar store. saveCalendar should be used both to add a new calendar to the calendar store, and to modify a calendar already in the store.
The only calendars that can be added with this API are local calendars; it is not possible to add subscribed or CalDAV calendars, or the birthday calendar.
Changes made to a CalCalendar are not persisted until that calendar has been passed to saveCalendar. If saveCalendar is not called, the changes will be lost.
CalCalendarStoreMBS.saveEvent(theEvent as CalEventMBS, span as Integer, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This method should be used both to add a new event to the calendar store, and to modify an event already in the calendar store.
If the event being saved is a repeating event, the second argument is used to describe whether the change being made should apply to future occurrences of that event, all occurrences, or only this instance. This is analogous to options on the dialog iCal presents when a user modifies a recurring event (though iCal's UI does not provide a way to change all events, past and present).
Changes made to a CalEvent are not persisted until that event has been passed to saveEvent. If saveEvent is not called, the changes will be lost.
Applying changes to all events or all future events may cause the UID or the occurrence date of the event to change.
CalCalendarStoreMBS.saveTask(task as CalTaskMBS, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
task: The task to save.
error: If this method returns false, an NSError object describing the error.
Returns true on success; otherwise, returns false and sets the error argument to an NSError object describing the error.
Use this method to save new task objects and modifications to existing task objects. Changes to task objects are not persistent until this method is invoked. The calendar property needs to be set before attempting to save a task.
Available in Mac OS X v10.5 and later.
CalCalendarStoreMBS.tasks as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is the function which uses all calendars.
See also:
CalCalendarStoreMBS.tasks(calendar as CalCalendarMBS) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
CalCalendarStoreMBS.tasks(calendars() as CalCalendarMBS) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
CalCalendarStoreMBS.TasksCompletedSince(completedSince as date) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is the function which uses all calendars.
See also:
CalCalendarStoreMBS.TasksCompletedSince(completedSince as date, calendar as CalCalendarMBS) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
CalCalendarStoreMBS.TasksCompletedSince(completedSince as date, calendars() as CalCalendarMBS) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
CalCalendarStoreMBS.taskWithUID(UID as string) as CalTaskMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns nil on any error.
CalCalendarStoreMBS.UncompletedTasks as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is the function which uses all calendars.
See also:
- UncompletedTasks(calendar as CalCalendarMBS) as CalTaskMBS()
- UncompletedTasks(calendars() as CalCalendarMBS) as CalTaskMBS()
Some examples using this method:
CalCalendarStoreMBS.UncompletedTasks(calendar as CalCalendarMBS) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
CalCalendarStoreMBS.UncompletedTasks(calendars() as CalCalendarMBS) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
CalCalendarStoreMBS.UncompletedTasksDueBefore(dueDate as date) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is the function which uses all calendars.
See also:
CalCalendarStoreMBS.UncompletedTasksDueBefore(dueDate as date, calendar as CalCalendarMBS) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
CalCalendarStoreMBS.UncompletedTasksDueBefore(dueDate as date, calendars() as CalCalendarMBS) as CalTaskMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Calendar | MBS MacFrameworks Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
The items on this page are in the following plugins: MBS MacFrameworks Plugin.