Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Events.RemoveCalendar

Removes a calendar from the database.

Component Version macOS Windows Linux Server iOS SDK
Events 6.2 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "Events.RemoveCalendar"; EKCalendar { ; Commit } )   More

Parameters

Parameter Description Example Flags
EKCalendar The identifier or name of the calendar. $calendar
Commit Whether to commit.
Pass 1 to commit or 0 to not commit.
Default is 1.
Pass 0 to batch changes together and commit with Events.Commit later.		 1 Optional

Result

Returns OK or error.

Description

Removes a calendar from the database.
This function attempts to delete the given calendar from the calendar database. It returns OK if successful and error otherwise.
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.

You may still need to call Events.Commit later.

See also

This function checks for a license.

Created 10th March 2016, last changed 17th March 2021


Events.Reminders - Events.RemoveEvent