Topics
All
MacOS
(Only)
Windows
(Only)
Linux
(Only, Not)
iOS
(Only, Not)
Components
Crossplatform Mac & Win
Server
Client
Old
Deprecated
Guides
Examples
Videos
New in version:
9.5
10.0
10.1
10.2
10.3
10.4
10.5
11.0
11.1
11.2
Statistic
FMM
Blog
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
MBS(
"Events.RemoveCalendar"; /* Removes a calendar from the database. */
$EKCalendar; /* The id of the calendar to query.e.g. $calendar */
$Commit) /* Optional; 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.e.g. 1 */
Less
Parameters
Parameter |
Description |
Example |
Flags |
EKCalendar |
The id of the calendar to query. |
$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
Created 10th March 2016, last changed 17th March 2021
Events.Reminders
-
Events.RemoveEvent
Feedback: Report problem or ask question.