![](\"https://img.shields.io/maintenance/yes/2026?style=flat-square\")
\n \n ![](\"https://img.shields.io/npm/l/@ebarooni/capacitor-calendar?style=flat-square\")
\n \n \n ![](\"https://img.shields.io/npm/dm/@ebarooni/capacitor-calendar?style=flat-square\")
\n \n \n ![](\"https://img.shields.io/npm/v/@ebarooni/capacitor-calendar?style=flat-square\")
\n \n \n ![](\"https://img.shields.io/badge/Capacitor-8.x-119EFF.svg?style=flat-square\"){kind=icon}
\n \n \n ![](\"https://img.shields.io/badge/MCP-161b22?style=flat&logo=modelcontextprotocol&logoColor=5FB8AF\"){kind=icon}
\n \n\n \n \n \n
CheckPermissionOptions |\n\n**Returns:** Promise<{ result: PermissionState; }>\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### checkAllPermissions()\n\n```typescript\ncheckAllPermissions() => Promise<{ result: CheckAllPermissionsResult; }>\n```\n\nRetrieves the current state of all permissions.\nOn Android, reminder keys always resolve to `\"prompt\"`.\n\n**Returns:** Promise<{ result: CheckAllPermissionsResult; }>\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestPermission(...)\n\n```typescript\nrequestPermission(options: RequestPermissionOptions) => Promise<{ result: PermissionState; }>\n```\n\nRequests permission for a given scope.\nOn Android, `readReminders` and `writeReminders` reject with `Invalid scope.`\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------------- |\n| **`options`** | RequestPermissionOptions |\n\n**Returns:** Promise<{ result: PermissionState; }>\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestAllPermissions()\n\n```typescript\nrequestAllPermissions() => Promise<{ result: RequestAllPermissionsResult; }>\n```\n\nRequests permission for all calendar and reminder permissions.\nOn Android, only calendar permissions are requested; reminder keys stay `\"prompt\"`.\n\n**Returns:** Promise<{ result: CheckAllPermissionsResult; }>\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestWriteOnlyCalendarAccess()\n\n```typescript\nrequestWriteOnlyCalendarAccess() => Promise<{ result: PermissionState; }>\n```\n\nRequests write access to the calendar.\n\n**Returns:** Promise<{ result: PermissionState; }>\n\n**Since:** 5.4.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestReadOnlyCalendarAccess()\n\n```typescript\nrequestReadOnlyCalendarAccess() => Promise<{ result: PermissionState; }>\n```\n\nRequests read access to the calendar.\n\n**Returns:** Promise<{ result: PermissionState; }>\n\n**Since:** 5.4.0\n\n**Platform:** Android\n\n---\n\n### requestFullCalendarAccess()\n\n```typescript\nrequestFullCalendarAccess() => Promise<{ result: PermissionState; }>\n```\n\nRequests read and write access to the calendar.\n\n**Returns:** Promise<{ result: PermissionState; }>\n\n**Since:** 5.4.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestFullRemindersAccess()\n\n```typescript\nrequestFullRemindersAccess() => Promise<{ result: PermissionState; }>\n```\n\nRequests read and write access to the reminders.\nResolves with `\"granted\"` or `\"denied\"` (never `\"prompt\"`).\nA grant covers both `readReminders` and `writeReminders`.\n\n**Returns:** Promise<{ result: PermissionState; }>\n\n**Since:** 5.4.0\n\n**Platform:** iOS\n\n---\n\n### createEventWithPrompt(...)\n\n```typescript\ncreateEventWithPrompt(options?: CreateEventWithPromptOptions | undefined) => PromiseCreateEventWithPromptOptions |\n\n**Returns:** Promise<CreateEventWithPromptResult>\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### modifyEventWithPrompt(...)\n\n```typescript\nmodifyEventWithPrompt(options: ModifyEventWithPromptOptions) => Promise<{ result: EventEditAction | null; }>\n```\n\nOpens a system calendar interface to modify an event.\nOn Android always returns `null`.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------- |\n| **`options`** | ModifyEventWithPromptOptions |\n\n**Returns:** Promise<{ result: EventEditAction | null; }>\n\n**Since:** 6.6.0\n\n**Platform:** Android, iOS\n\n---\n\n### createEvent(...)\n\n```typescript\ncreateEvent(options: CreateEventOptions) => PromiseCreateEventOptions |\n\n**Returns:** Promise<CreateEventResult>\n\n**Since:** 0.4.0\n\n**Platform:** Android, iOS, Web\n\n---\n\n### modifyEvent(...)\n\n```typescript\nmodifyEvent(options: ModifyEventOptions) => PromiseModifyEventOptions |\n\n**Since:** 6.6.0\n\n**Platform:** Android, iOS\n\n---\n\n### deleteEventsById(...)\n\n```typescript\ndeleteEventsById(options: DeleteEventsByIdOptions) => Promise<{ result: DeleteEventsByIdResult; }>\n```\n\nDeletes multiple events.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------- |\n| **`options`** | DeleteEventsByIdOptions |\n\n**Returns:** Promise<{ result: DeleteEventsByIdResult; }>\n\n**Since:** 0.11.0\n\n**Platform:** Android, iOS\n\n---\n\n### deleteEvent(...)\n\n```typescript\ndeleteEvent(options: DeleteEventOptions) => PromiseDeleteEventOptions |\n\n**Since:** 7.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### deleteEventWithPrompt(...)\n\n```typescript\ndeleteEventWithPrompt(options: DeleteEventWithPromptOptions) => Promise<{ deleted: boolean; }>\n```\n\nOpens a dialog to delete an event.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------- |\n| **`options`** | DeleteEventWithPromptOptions |\n\n**Returns:** Promise<{ deleted: boolean; }>\n\n**Since:** 7.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### listEventsInRange(...)\n\n```typescript\nlistEventsInRange(options: ListEventsInRangeOptions) => PromiseListEventsInRangeOptions |\n\n**Returns:** Promise<ListEventsInRangeResult>\n\n**Since:** 0.10.0\n\n**Platform:** Android, iOS\n\n---\n\n### commit()\n\n```typescript\ncommit() => PromiseSelectCalendarsWithPromptOptions |\n\n**Returns:** Promise<SelectCalendarsWithPromptResult>\n\n**Since:** 0.2.0\n\n**Platform:** iOS\n\n---\n\n### fetchAllCalendarSources()\n\n```typescript\nfetchAllCalendarSources() => PromisePromise<FetchAllCalendarSourcesResult>\n\n**Since:** 6.6.0\n\n**Platform:** iOS\n\n---\n\n### listCalendars()\n\n```typescript\nlistCalendars() => PromisePromise<ListCalendarsResult>\n\n**Since:** 7.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### getDefaultCalendar(...)\n\n```typescript\ngetDefaultCalendar(options?: GetDefaultCalendarOptions | undefined) => Promise<{ result: Calendar | null; }>\n```\n\nRetrieves the default calendar.\n\nRequires calendar read access. On Android, missing permission typically\nrejects. On iOS, missing authorization typically yields `result: null`.\n\nThe system default is the primary calendar on Android and\n`defaultCalendarForNewEvents` on iOS. When neither exists and\n`useFallbackCalendar` is true, the first available calendar is returned.\nOtherwise the method returns `null` when there is no system default.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------- |\n| **`options`** | GetDefaultCalendarOptions |\n\n**Returns:** Promise<{ result: Calendar | null; }>\n\n**Since:** 0.3.0\n\n**Platform:** Android, iOS\n\n---\n\n### openCalendar(...)\n\n```typescript\nopenCalendar(options?: OpenCalendarOptions | undefined) => PromiseOpenCalendarOptions |\n\n**Since:** 7.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### createCalendar(...)\n\n```typescript\ncreateCalendar(options: CreateCalendarOptions) => PromiseCreateCalendarOptions |\n\n**Returns:** Promise<CreateCalendarResult>\n\n**Since:** 5.2.0\n\n**Platform:** Android, iOS\n\n---\n\n### deleteCalendar(...)\n\n```typescript\ndeleteCalendar(options: DeleteCalendarOptions) => PromiseDeleteCalendarOptions |\n\n**Since:** 5.2.0\n\n**Platform:** Android, iOS\n\n---\n\n### modifyCalendar(...)\n\n```typescript\nmodifyCalendar(options: ModifyCalendarOptions) => PromiseModifyCalendarOptions |\n\n**Since:** 7.2.0\n\n**Platform:** Android, iOS\n\n---\n\n### createRemindersList(...)\n\n```typescript\ncreateRemindersList(options: CreateRemindersListOptions) => PromiseCreateRemindersListOptions |\n\n**Returns:** Promise<CreateRemindersListResult>\n\n**Since:** 8.1.0\n\n**Platform:** iOS\n\n---\n\n### deleteRemindersList(...)\n\n```typescript\ndeleteRemindersList(options: DeleteRemindersListOptions) => PromiseDeleteRemindersListOptions |\n\n**Since:** 8.2.0\n\n**Platform:** iOS\n\n---\n\n### fetchAllRemindersSources()\n\n```typescript\nfetchAllRemindersSources() => Promise<{ result: CalendarSource[]; }>\n```\n\nRetrieves a list of calendar sources.\n\n**Returns:** Promise<{ result: CalendarSource[]; }>\n\n**Since:** 6.6.0\n\n**Platform:** iOS\n\n---\n\n### openReminders()\n\n```typescript\nopenReminders() => PromisePromise<{ result: Calendar | null; }>\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### getRemindersLists()\n\n```typescript\ngetRemindersLists() => Promise<{ result: RemindersList[]; }>\n```\n\nRetrieves all available reminders lists.\n\n**Returns:** Promise<{ result: Calendar[]; }>\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### createReminder(...)\n\n```typescript\ncreateReminder(options: CreateReminderOptions) => PromiseCreateReminderOptions |\n\n**Returns:** Promise<CreateReminderResult>\n\n**Since:** 0.5.0\n\n**Platform:** iOS\n\n---\n\n### deleteRemindersById(...)\n\n```typescript\ndeleteRemindersById(options: DeleteRemindersByIdOptions) => Promise<{ result: DeleteRemindersByIdResult; }>\n```\n\nDeletes multiple reminders.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------- |\n| **`options`** | DeleteRemindersByIdOptions |\n\n**Returns:** Promise<{ result: DeleteRemindersByIdResult; }>\n\n**Since:** 5.3.0\n\n**Platform:** iOS\n\n---\n\n### deleteReminder(...)\n\n```typescript\ndeleteReminder(options: DeleteReminderOptions) => PromiseDeleteReminderOptions |\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### modifyReminder(...)\n\n```typescript\nmodifyReminder(options: ModifyReminderOptions) => PromiseModifyReminderOptions |\n\n**Since:** 6.7.0\n\n**Platform:** iOS\n\n---\n\n### getReminderById(...)\n\n```typescript\ngetReminderById(options: GetReminderByIdOptions) => PromiseGetReminderByIdOptions |\n\n**Returns:** Promise<GetReminderByIdResult>\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### getRemindersFromLists(...)\n\n```typescript\ngetRemindersFromLists(options: GetRemindersFromListsOptions) => PromiseGetRemindersFromListsOptions |\n\n**Returns:** Promise<GetRemindersFromListsResult>\n\n**Since:** 5.3.0\n\n**Platform:** iOS\n\n---\n\n### deleteReminderWithPrompt(...)\n\n```typescript\ndeleteReminderWithPrompt(options: DeleteReminderWithPromptOptions) => Promise<{ deleted: boolean; }>\n```\n\nOpens a dialog to delete a reminder.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------- |\n| **`options`** | DeleteReminderWithPromptOptions |\n\n**Returns:** Promise<{ deleted: boolean; }>\n\n**Since:** 7.2.0\n\n**Platform:** iOS\n\n---\n\n### updateRemindersList(...)\n\n```typescript\nupdateRemindersList(options: UpdateRemindersListOptions) => PromiseUpdateRemindersListOptions |\n\n**Returns:** Promise<UpdateRemindersListResult>\n\n**Since:** 8.2.0\n\n**Platform:** iOS\n\n---\n\n### Interfaces\n\n#### CheckPermissionOptions\n\nOptions for {@link CalendarAccess#checkPermission}.\n\n| Prop | Type | Description | Since | Platform |\n| ----------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----- | ------------ |\n| **`scope`** | CalendarPermissionScope | The permission scope to check. On Android, `readReminders` and `writeReminders` resolve to `\"prompt\"` (reminders are not supported on Android). | 8.3.1 | Android, iOS |\n\n#### RequestPermissionOptions\n\nOptions for {@link CalendarAccess#requestPermission}.\n\n| Prop | Type | Description | Since | Platform |\n| ----------- | --------------------------------------------------------------------------- | -------------------------------- | ----- | ------------ |\n| **`scope`** | CalendarPermissionScope | The permission scope to request. | 8.3.1 | Android, iOS |\n\n#### CreateEventWithPromptResult\n\n| Prop | Type | Description | Since | Platform |\n| -------- | --------------------------- | -------------------------------------------------------------------------------------------------- | ----- | ------------ |\n| **`id`** | string \\| null | The identifier of the created event. Always `null` on Android. Present on iOS when the user saves. | 0.1.0 | Android, iOS |\n\n#### CreateEventWithPromptOptions\n\n| Prop | Type | Description | Since | Platform |\n| ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ------------ |\n| **`alerts`** | number[] | Alert times in minutes relative to the event start. Use negative numbers for reminders before the start, and positive numbers for reminders after the start. On iOS only 2 alerts are supported. | 7.1.0 | iOS |\n| **`availability`** | EventAvailability | | 7.1.0 | Android, iOS |\n| **`calendarId`** | string | | 0.1.0 | iOS |\n| **`description`** | string | | 7.1.0 | Android, iOS |\n| **`endDate`** | number | | 0.1.0 | Android, iOS |\n| **`invitees`** | string[] | An array of emails to invite. | 7.1.0 | Android |\n| **`isAllDay`** | boolean | | 0.1.0 | Android, iOS |\n| **`location`** | string | | 0.1.0 | Android, iOS |\n| **`recurrence`** | EventRecurrenceRule | Rules for creating a recurring event. | 7.3.0 | Android, iOS |\n| **`startDate`** | number | | 0.1.0 | Android, iOS |\n| **`title`** | string | | 0.1.0 | Android, iOS |\n| **`url`** | string | | 0.1.0 | iOS |\n\n#### EventRecurrenceRule\n\n| Prop | Type | Description | Default | Since | Platform |\n| -------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ----- | ------------ |\n| **`byMonth`** | number[] | Limits a yearly recurrence to specific months of the year. The values should be between 1 and 12. | | 7.1.0 | Android, iOS |\n| **`byMonthDay`** | number[] | Limits a monthly recurrence to specific days of the month. The values should be between 1 and 31. | | 7.1.0 | Android, iOS |\n| **`byWeekDay`** | number[] | Limits a weekly recurrence to specific weekdays. The values should be between 1 and 7. 1 means Monday and 7 means Sunday. | | 7.3.0 | Android, iOS |\n| **`count`** | number | The total number of occurrences. If set, the recurrence ends after this many occurrences. If `count` is provided, `end` is ignored. | | 7.3.0 | Android, iOS |\n| **`daysOfTheYear`** | number[] | Limits a yearly recurrence to specific days of the year (1 to 366). | | 7.3.0 | iOS |\n| **`end`** | number | End date of the recurrence series as a Unix timestamp in milliseconds. | | 7.1.0 | Android, iOS |\n| **`frequency`** | RecurrenceFrequency | How often the event repeats. | | 7.3.0 | Android, iOS |\n| **`interval`** | number | The interval between recurrences. Use in combination with `frequency`. For example, a weekly event with an interval of 2, results in the event occurring every 2 weeks. | 1 | 7.3.0 | Android, iOS |\n| **`weeksOfTheYear`** | number[] | Limits a yearly recurrence to specific ISO week numbers (1 to 53). | | 7.3.0 | iOS |\n\n#### ModifyEventWithPromptOptions\n\n| Prop | Type | Description | Since | Platform |\n| ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ------------ |\n| **`alerts`** | number[] | Alert times in minutes relative to the event start. Use negative numbers for reminders before the start, and positive numbers for reminders after the start. On iOS only 2 alerts are supported. | 7.1.0 | iOS |\n| **`availability`** | EventAvailability | | 7.1.0 | Android, iOS |\n| **`calendarId`** | string | | 0.1.0 | iOS |\n| **`description`** | string | | 7.1.0 | Android, iOS |\n| **`endDate`** | number | | 0.1.0 | Android, iOS |\n| **`invitees`** | string[] | An array of emails to invite. | 7.1.0 | Android |\n| **`isAllDay`** | boolean | | 0.1.0 | Android, iOS |\n| **`location`** | string | | 0.1.0 | Android, iOS |\n| **`recurrence`** | EventRecurrenceRule | Rules for creating a recurring event. | 7.3.0 | Android, iOS |\n| **`startDate`** | number | | 0.1.0 | Android, iOS |\n| **`title`** | string | | 0.1.0 | Android, iOS |\n| **`url`** | string | | 0.1.0 | iOS |\n| **`id`** | string | The ID of the event to be modified. | 7.1.0 | Android, iOS |\n\n#### CreateEventResult\n\n| Prop | Type | Description | Since | Platform |\n| --------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ------------ |\n| **`ics`** | File \\| null | An `.ics` file (`text/calendar`) with one `VEVENT`. Always `null` on Android and iOS. On Web, the plugin does not write to a calendar store or start a download; use `downloadIcsFile(...)` or pass the `File` to another API. | 8.5.0 | Web |\n| **`id`** | string \\| null | The identifier of the created event. Always `null` on Web. Present on Android and iOS after a successful create. | 0.4.0 | Android, iOS |\n\n#### CreateEventOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ------------------ | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ----- | ----------------- |\n| **`alerts`** | number[] | Alert times in minutes relative to the event start. Use negative numbers for alerts before the start, and positive numbers for alerts after the start. | | 7.1.0 | Android, iOS, Web |\n| **`attendees`** | EventGuest[] | The event guests. | | 7.1.0 | Android, Web |\n| **`availability`** | EventAvailability | | | 7.1.0 | Android, iOS, Web |\n| **`calendarId`** | string | | | 0.1.0 | Android, iOS |\n| **`color`** | string | | | 7.1.0 | Android |\n| **`commit`** | boolean | Whether to save immediately (`true`) or batch changes for later (`false`). | true | 7.1.0 | iOS |\n| **`description`** | string | | | 7.1.0 | Android, iOS, Web |\n| **`duration`** | string | Duration of the event in RFC2445 format. | | 7.1.0 | Android |\n| **`endDate`** | number | | | 0.1.0 | Android, iOS, Web |\n| **`icsFileName`** | string | Download filename for the `.ics` file. When omitted, a name is derived from `title` (fallback `event.ics`). If the value has no `.ics` extension, `.ics` is appended. | | 8.5.0 | Web |\n| **`isAllDay`** | boolean | | | 0.1.0 | Android, iOS, Web |\n| **`location`** | string | | | 0.1.0 | Android, iOS, Web |\n| **`organizer`** | string | Email of the event organizer. | | 7.1.0 | Android, Web |\n| **`recurrence`** | EventRecurrenceRule | Rules for creating a recurring event. | | 7.3.0 | Android, iOS, Web |\n| **`startDate`** | number | | | 0.1.0 | Android, iOS, Web |\n| **`title`** | string | | | 0.4.0 | Android, iOS, Web |\n| **`url`** | string | | | 0.1.0 | iOS, Web |\n\n#### EventGuest\n\n| Prop | Type | Since |\n| ----------- | ------------------- | ----- |\n| **`name`** | string | 7.1.0 |\n| **`email`** | string | 7.1.0 |\n\n#### ModifyEventOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | ----- | ------------ |\n| **`alerts`** | number[] | Alert times in minutes relative to the event start. Use negative numbers for alerts before the start, and positive numbers for alerts after the start. | | 7.1.0 | Android, iOS |\n| **`attendees`** | EventGuest[] | The event guests. | | 7.1.0 | Android |\n| **`availability`** | EventAvailability | | | 7.1.0 | Android, iOS |\n| **`calendarId`** | string | | | 0.1.0 | Android, iOS |\n| **`color`** | string | | | 7.1.0 | Android |\n| **`description`** | string | | | 7.1.0 | Android, iOS |\n| **`duration`** | string | Duration of the event in RFC2445 format. | | 7.1.0 | Android |\n| **`endDate`** | number | | | 0.1.0 | Android, iOS |\n| **`id`** | string | The ID of the event to be modified. | | 7.1.0 | Android, iOS |\n| **`isAllDay`** | boolean | | | 0.1.0 | Android, iOS |\n| **`location`** | string | | | 0.1.0 | Android, iOS |\n| **`recurrence`** | EventRecurrenceRule | Rules for creating a recurring event. | | 7.3.0 | Android, iOS |\n| **`organizer`** | string | Email of the event organizer. | | 7.1.0 | Android |\n| **`span`** | EventSpan | The span of modifications. | EventSpan.THIS_EVENT | | iOS |\n| **`startDate`** | number | | | 0.1.0 | Android, iOS |\n| **`title`** | string | | | 0.4.0 | Android, iOS |\n| **`url`** | string | | | 0.1.0 | iOS |\n\n#### DeleteEventsByIdResult\n\n| Prop | Type | Since |\n| ------------- | --------------------- | ----- |\n| **`deleted`** | string[] | 7.1.0 |\n| **`failed`** | string[] | 7.1.0 |\n\n#### DeleteEventsByIdOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ------------ | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | ----- | ------------ |\n| **`commit`** | boolean | Whether to save the deletion to the event store immediately. Pass `false` to batch multiple changes and commit them together using `CapacitorCalendar.commit()`, which is more efficient than committing each save individually. | true | 8.3.0 | iOS |\n| **`ids`** | string[] | | | 7.1.0 | |\n| **`span`** | EventSpan | How much of a recurring series to delete. On Android, `THIS_EVENT` cannot target a single recurring occurrence here — use `deleteEvent` with `instanceDate`. Those ids are reported in `failed`. | EventSpan.THIS_EVENT | 7.1.0 | Android, iOS |\n\n#### DeleteEventOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ------------------ | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | ----- | ------------ |\n| **`commit`** | boolean | Whether to save the deletion to the event store immediately. Pass `false` to batch multiple changes and commit them together using `CapacitorCalendar.commit()`, which is more efficient than committing each save individually. | true | 8.3.0 | iOS |\n| **`id`** | string | The ID of the event to delete. | | 7.1.0 | Android, iOS |\n| **`instanceDate`** | number | The start time of the occurrence to delete, in milliseconds since the epoch. Use `startDate` from `listEventsInRange`. On Android, required for `THIS_EVENT` on recurring events. If omitted with `THIS_AND_FUTURE_EVENTS`, the whole series is deleted. | | 8.3.0 | Android |\n| **`span`** | EventSpan | How much of a recurring series to delete. | EventSpan.THIS_EVENT | 7.1.0 | Android, iOS |\n\n#### DeleteEventWithPromptOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ----------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | ----- | ------------ |\n| **`cancelButtonText`** | string | Text to show on the cancel button. | 'Cancel' | 7.1.0 | Android, iOS |\n| **`commit`** | boolean | Whether to save the deletion to the event store immediately. Pass `false` to batch multiple changes and commit them together using `CapacitorCalendar.commit()`, which is more efficient than committing each save individually. | true | 8.3.0 | iOS |\n| **`confirmButtonText`** |