{"id":13981541,"url":"https://github.com/ebarooni/capacitor-calendar","last_synced_at":"2025-12-26T19:47:42.081Z","repository":{"id":230881808,"uuid":"752043661","full_name":"ebarooni/capacitor-calendar","owner":"ebarooni","description":"A capacitor plugin for managing calendar events on iOS and Android, with reminders support on iOS.","archived":false,"fork":false,"pushed_at":"2025-03-07T15:57:54.000Z","size":6085,"stargazers_count":52,"open_issues_count":6,"forks_count":9,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-09T21:14:24.864Z","etag":null,"topics":["android","angular","calendar","capacitor","capacitor-plugin","eventkit","ionic","ios","kotlin","native","reminders","swift","typescript"],"latest_commit_sha":null,"homepage":"https://ebarooni.github.io/capacitor-calendar/","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ebarooni.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-02T22:13:27.000Z","updated_at":"2025-04-29T11:18:31.000Z","dependencies_parsed_at":"2024-04-19T23:33:57.866Z","dependency_job_id":null,"html_url":"https://github.com/ebarooni/capacitor-calendar","commit_stats":null,"previous_names":["ebarooni/capacitor-calendar"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebarooni%2Fcapacitor-calendar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebarooni%2Fcapacitor-calendar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebarooni%2Fcapacitor-calendar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebarooni%2Fcapacitor-calendar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ebarooni","download_url":"https://codeload.github.com/ebarooni/capacitor-calendar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253822222,"owners_count":21969818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","angular","calendar","capacitor","capacitor-plugin","eventkit","ionic","ios","kotlin","native","reminders","swift","typescript"],"created_at":"2024-08-09T05:00:47.463Z","updated_at":"2025-12-26T19:47:42.067Z","avatar_url":"https://github.com/ebarooni.png","language":"Swift","funding_links":[],"categories":["Plugins","Other plugins"],"sub_categories":["Community Plugins","Specialized Hardware"],"readme":"\u003cp align=\"center\"\u003e\n \u003cimg src=\"assets/images/text-logo.png\" alt=\"capacitor-calendar-logo\" height=\"136\"/\u003e\n \u003cbr\u003e\n \u003cem\u003eA capacitor plugin for managing calendar events on iOS and Android, with reminders support on iOS.\u003c/em\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n \u003cimg src=\"https://img.shields.io/maintenance/yes/2025?style=flat-square\" /\u003e\n \u003ca href=\"https://www.npmjs.com/package/@ebarooni/capacitor-calendar\"\u003e\n \u003cimg src=\"https://img.shields.io/npm/l/@ebarooni/capacitor-calendar?style=flat-square\" /\u003e\n \u003c/a\u003e\n \u003cbr\u003e\n \u003ca href=\"https://www.npmjs.com/package/@ebarooni/capacitor-calendar\"\u003e\n \u003cimg src=\"https://img.shields.io/npm/dw/@ebarooni/capacitor-calendar?style=flat-square\" /\u003e\n \u003c/a\u003e\n \u003ca href=\"https://www.npmjs.com/package/@ebarooni/capacitor-calendar\"\u003e\n \u003cimg src=\"https://img.shields.io/npm/v/@ebarooni/capacitor-calendar?style=flat-square\" /\u003e\n \u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Demo](#demo)\n- [Setup](#setup)\n- [Documentation](#documentation)\n- [Changelog](#changelog)\n- [API](#api)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\n```bash\nnpm install @ebarooni/capacitor-calendar\nnpx cap sync\n```\n\n## Demo\n\n| iOS 26 | Android 16 |\n| :-----------------------------: | :---------------------------------: |\n| ![](./assets/demo/ios-demo.gif) | ![](./assets/demo/android-demo.gif) |\n\n## Setup\n\nThis plugin requires additional platform-specific configuration. Follow the official guides:\n\n- **iOS:** [Migrating to the Latest Calendar Access Levels](https://developer.apple.com/documentation/technotes/tn3152-migrating-to-the-latest-calendar-access-levels)\n- **Android:** [Calendar Provider User Permissions](https://developer.android.com/identity/providers/calendar-provider#manifest)\n\n## Documentation\n\nFor comprehensive usage examples, detailed explanations, and API references, check out:\n\n- **[Online documentation](https://ebarooni.github.io/capacitor-calendar/)**\n- **[Type definitions \u0026 examples](src/definitions.ts)**\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for the latest updates and release history.\n\n\u003e [!NOTE] \n\u003e Version 7.1.0 introduces breaking changes.\n\n## API\n\n\u003cdocgen-index\u003e\n\n- [`checkPermission(...)`](#checkpermission)\n- [`checkAllPermissions()`](#checkallpermissions)\n- [`requestPermission(...)`](#requestpermission)\n- [`requestAllPermissions()`](#requestallpermissions)\n- [`requestWriteOnlyCalendarAccess()`](#requestwriteonlycalendaraccess)\n- [`requestReadOnlyCalendarAccess()`](#requestreadonlycalendaraccess)\n- [`requestFullCalendarAccess()`](#requestfullcalendaraccess)\n- [`requestFullRemindersAccess()`](#requestfullremindersaccess)\n- [`createEventWithPrompt(...)`](#createeventwithprompt)\n- [`modifyEventWithPrompt(...)`](#modifyeventwithprompt)\n- [`createEvent(...)`](#createevent)\n- [`modifyEvent(...)`](#modifyevent)\n- [`deleteEventsById(...)`](#deleteeventsbyid)\n- [`deleteEvent(...)`](#deleteevent)\n- [`deleteEventWithPrompt(...)`](#deleteeventwithprompt)\n- [`listEventsInRange(...)`](#listeventsinrange)\n- [`commit()`](#commit)\n- [`selectCalendarsWithPrompt(...)`](#selectcalendarswithprompt)\n- [`fetchAllCalendarSources()`](#fetchallcalendarsources)\n- [`listCalendars()`](#listcalendars)\n- [`getDefaultCalendar()`](#getdefaultcalendar)\n- [`openCalendar(...)`](#opencalendar)\n- [`createCalendar(...)`](#createcalendar)\n- [`deleteCalendar(...)`](#deletecalendar)\n- [`modifyCalendar(...)`](#modifycalendar)\n- [`fetchAllRemindersSources()`](#fetchallreminderssources)\n- [`openReminders()`](#openreminders)\n- [`getDefaultRemindersList()`](#getdefaultreminderslist)\n- [`getRemindersLists()`](#getreminderslists)\n- [`createReminder(...)`](#createreminder)\n- [`deleteRemindersById(...)`](#deleteremindersbyid)\n- [`deleteReminder(...)`](#deletereminder)\n- [`modifyReminder(...)`](#modifyreminder)\n- [`getReminderById(...)`](#getreminderbyid)\n- [`getRemindersFromLists(...)`](#getremindersfromlists)\n- [`deleteReminderWithPrompt(...)`](#deletereminderwithprompt)\n- [Interfaces](#interfaces)\n- [Type Aliases](#type-aliases)\n- [Enums](#enums)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n### checkPermission(...)\n\n```typescript\ncheckPermission(options: { scope: CalendarPermissionScope; }) =\u003e Promise\u003c{ result: PermissionState; }\u003e\n```\n\nRetrieves the current permission state for a given scope.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e{ scope: \u003ca href=\"#calendarpermissionscope\"\u003eCalendarPermissionScope\u003c/a\u003e; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### checkAllPermissions()\n\n```typescript\ncheckAllPermissions() =\u003e Promise\u003c{ result: CheckAllPermissionsResult; }\u003e\n```\n\nRetrieves the current state of all permissions.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#checkallpermissionsresult\"\u003eCheckAllPermissionsResult\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestPermission(...)\n\n```typescript\nrequestPermission(options: { scope: CalendarPermissionScope; }) =\u003e Promise\u003c{ result: PermissionState; }\u003e\n```\n\nRequests permission for a given scope.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e{ scope: \u003ca href=\"#calendarpermissionscope\"\u003eCalendarPermissionScope\u003c/a\u003e; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestAllPermissions()\n\n```typescript\nrequestAllPermissions() =\u003e Promise\u003c{ result: RequestAllPermissionsResult; }\u003e\n```\n\nRequests permission for all calendar and reminder permissions.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#checkallpermissionsresult\"\u003eCheckAllPermissionsResult\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestWriteOnlyCalendarAccess()\n\n```typescript\nrequestWriteOnlyCalendarAccess() =\u003e Promise\u003c{ result: PermissionState; }\u003e\n```\n\nRequests write access to the calendar.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 5.4.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestReadOnlyCalendarAccess()\n\n```typescript\nrequestReadOnlyCalendarAccess() =\u003e Promise\u003c{ result: PermissionState; }\u003e\n```\n\nRequests read access to the calendar.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 5.4.0\n\n**Platform:** Android\n\n---\n\n### requestFullCalendarAccess()\n\n```typescript\nrequestFullCalendarAccess() =\u003e Promise\u003c{ result: PermissionState; }\u003e\n```\n\nRequests read and write access to the calendar.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 5.4.0\n\n**Platform:** Android, iOS\n\n---\n\n### requestFullRemindersAccess()\n\n```typescript\nrequestFullRemindersAccess() =\u003e Promise\u003c{ result: PermissionState; }\u003e\n```\n\nRequests read and write access to the reminders.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 5.4.0\n\n**Platform:** iOS\n\n---\n\n### createEventWithPrompt(...)\n\n```typescript\ncreateEventWithPrompt(options?: CreateEventWithPromptOptions | undefined) =\u003e Promise\u003c{ id: string | null; }\u003e\n```\n\nOpens the system calendar interface to create a new event.\nOn Android always returns `null`.\nFetch the events to find the ID of the newly created event.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#createeventwithpromptoptions\"\u003eCreateEventWithPromptOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ id: string | null; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### modifyEventWithPrompt(...)\n\n```typescript\nmodifyEventWithPrompt(options: ModifyEventWithPromptOptions) =\u003e Promise\u003c{ result: EventEditAction | null; }\u003e\n```\n\nOpens a system calendar interface to modify an event.\nOn Android always returns `null`.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#modifyeventwithpromptoptions\"\u003eModifyEventWithPromptOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#eventeditaction\"\u003eEventEditAction\u003c/a\u003e | null; }\u0026gt;\u003c/code\u003e\n\n**Since:** 6.6.0\n\n**Platform:** Android, iOS\n\n---\n\n### createEvent(...)\n\n```typescript\ncreateEvent(options: CreateEventOptions) =\u003e Promise\u003c{ id: string; }\u003e\n```\n\nCreates an event in the calendar.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#createeventoptions\"\u003eCreateEventOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ id: string; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.4.0\n\n**Platform:** iOS, Android\n\n---\n\n### modifyEvent(...)\n\n```typescript\nmodifyEvent(options: ModifyEventOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nModifies an event.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#modifyeventoptions\"\u003eModifyEventOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 6.6.0\n\n**Platform:** Android, iOS\n\n---\n\n### deleteEventsById(...)\n\n```typescript\ndeleteEventsById(options: DeleteEventsByIdOptions) =\u003e Promise\u003c{ result: DeleteEventsByIdResult; }\u003e\n```\n\nDeletes multiple events.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#deleteeventsbyidoptions\"\u003eDeleteEventsByIdOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#deleteeventsbyidresult\"\u003eDeleteEventsByIdResult\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.11.0\n\n**Platform:** Android, iOS\n\n---\n\n### deleteEvent(...)\n\n```typescript\ndeleteEvent(options: DeleteEventOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nDeletes an event.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#deleteeventoptions\"\u003eDeleteEventOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 7.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### deleteEventWithPrompt(...)\n\n```typescript\ndeleteEventWithPrompt(options: DeleteEventWithPromptOptions) =\u003e Promise\u003c{ deleted: boolean; }\u003e\n```\n\nOpens a dialog to delete an event.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#deleteeventwithpromptoptions\"\u003eDeleteEventWithPromptOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ deleted: boolean; }\u0026gt;\u003c/code\u003e\n\n**Since:** 7.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### listEventsInRange(...)\n\n```typescript\nlistEventsInRange(options: ListEventsInRangeOptions) =\u003e Promise\u003c{ result: CalendarEvent[]; }\u003e\n```\n\nRetrieves the events within a date range.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#listeventsinrangeoptions\"\u003eListEventsInRangeOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: CalendarEvent[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.10.0\n\n**Platform:** Android, iOS\n\n---\n\n### commit()\n\n```typescript\ncommit() =\u003e Promise\u003cvoid\u003e\n```\n\nSave the changes to the calendar.\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### selectCalendarsWithPrompt(...)\n\n```typescript\nselectCalendarsWithPrompt(options?: SelectCalendarsWithPromptOptions | undefined) =\u003e Promise\u003c{ result: Calendar[]; }\u003e\n```\n\nOpens a system interface to choose one or multiple calendars.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#selectcalendarswithpromptoptions\"\u003eSelectCalendarsWithPromptOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: Calendar[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.2.0\n\n**Platform:** iOS\n\n---\n\n### fetchAllCalendarSources()\n\n```typescript\nfetchAllCalendarSources() =\u003e Promise\u003c{ result: CalendarSource[]; }\u003e\n```\n\nRetrieves a list of calendar sources.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: CalendarSource[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 6.6.0\n\n**Platform:** iOS\n\n---\n\n### listCalendars()\n\n```typescript\nlistCalendars() =\u003e Promise\u003c{ result: Calendar[]; }\u003e\n```\n\nRetrieves a list of all available calendars.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: Calendar[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 7.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### getDefaultCalendar()\n\n```typescript\ngetDefaultCalendar() =\u003e Promise\u003c{ result: Calendar | null; }\u003e\n```\n\nRetrieves the default calendar.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#calendar\"\u003eCalendar\u003c/a\u003e | null; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.3.0\n\n**Platform:** Android, iOS\n\n---\n\n### openCalendar(...)\n\n```typescript\nopenCalendar(options?: OpenCalendarOptions | undefined) =\u003e Promise\u003cvoid\u003e\n```\n\nOpens the calendar app.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#opencalendaroptions\"\u003eOpenCalendarOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 7.1.0\n\n**Platform:** Android, iOS\n\n---\n\n### createCalendar(...)\n\n```typescript\ncreateCalendar(options: CreateCalendarOptions) =\u003e Promise\u003c{ id: string; }\u003e\n```\n\nCreates a calendar.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#createcalendaroptions\"\u003eCreateCalendarOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ id: string; }\u0026gt;\u003c/code\u003e\n\n**Since:** 5.2.0\n\n**Platform:** Android, iOS\n\n---\n\n### deleteCalendar(...)\n\n```typescript\ndeleteCalendar(options: DeleteCalendarOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nDeletes a calendar by id.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#deletecalendaroptions\"\u003eDeleteCalendarOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 5.2.0\n\n**Platform:** Android, iOS\n\n---\n\n### modifyCalendar(...)\n\n```typescript\nmodifyCalendar(options: ModifyCalendarOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nModifies a calendar with options.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#modifycalendaroptions\"\u003eModifyCalendarOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 7.2.0\n\n**Platform:** Android, iOS\n\n---\n\n### fetchAllRemindersSources()\n\n```typescript\nfetchAllRemindersSources() =\u003e Promise\u003c{ result: CalendarSource[]; }\u003e\n```\n\nRetrieves a list of calendar sources.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: CalendarSource[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 6.6.0\n\n**Platform:** iOS\n\n---\n\n### openReminders()\n\n```typescript\nopenReminders() =\u003e Promise\u003cvoid\u003e\n```\n\nOpens the reminders app.\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### getDefaultRemindersList()\n\n```typescript\ngetDefaultRemindersList() =\u003e Promise\u003c{ result: RemindersList | null; }\u003e\n```\n\nRetrieves the default reminders list.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#calendar\"\u003eCalendar\u003c/a\u003e | null; }\u0026gt;\u003c/code\u003e\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### getRemindersLists()\n\n```typescript\ngetRemindersLists() =\u003e Promise\u003c{ result: RemindersList[]; }\u003e\n```\n\nRetrieves all available reminders lists.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: Calendar[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### createReminder(...)\n\n```typescript\ncreateReminder(options: CreateReminderOptions) =\u003e Promise\u003c{ id: string; }\u003e\n```\n\nCreates a reminder.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#createreminderoptions\"\u003eCreateReminderOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ id: string; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.5.0\n\n**Platform:** iOS\n\n---\n\n### deleteRemindersById(...)\n\n```typescript\ndeleteRemindersById(options: DeleteRemindersByIdOptions) =\u003e Promise\u003c{ result: DeleteRemindersByIdResult; }\u003e\n```\n\nDeletes multiple reminders.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#deleteremindersbyidoptions\"\u003eDeleteRemindersByIdOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#deleteremindersbyidresult\"\u003eDeleteRemindersByIdResult\u003c/a\u003e; }\u0026gt;\u003c/code\u003e\n\n**Since:** 5.3.0\n\n**Platform:** iOS\n\n---\n\n### deleteReminder(...)\n\n```typescript\ndeleteReminder(options: DeleteReminderOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nDeletes a reminder.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#deletereminderoptions\"\u003eDeleteReminderOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### modifyReminder(...)\n\n```typescript\nmodifyReminder(options: ModifyReminderOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nModifies a reminder.\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#modifyreminderoptions\"\u003eModifyReminderOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 6.7.0\n\n**Platform:** iOS\n\n---\n\n### getReminderById(...)\n\n```typescript\ngetReminderById(options: GetReminderByIdOptions) =\u003e Promise\u003c{ result: Reminder | null; }\u003e\n```\n\nRetrieve a reminder by ID.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#getreminderbyidoptions\"\u003eGetReminderByIdOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: \u003ca href=\"#reminder\"\u003eReminder\u003c/a\u003e | null; }\u0026gt;\u003c/code\u003e\n\n**Since:** 7.1.0\n\n**Platform:** iOS\n\n---\n\n### getRemindersFromLists(...)\n\n```typescript\ngetRemindersFromLists(options: GetRemindersFromListsOptions) =\u003e Promise\u003c{ result: Reminder[]; }\u003e\n```\n\nRetrieves reminders from multiple lists.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#getremindersfromlistsoptions\"\u003eGetRemindersFromListsOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ result: Reminder[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 5.3.0\n\n**Platform:** iOS\n\n---\n\n### deleteReminderWithPrompt(...)\n\n```typescript\ndeleteReminderWithPrompt(options: DeleteReminderWithPromptOptions) =\u003e Promise\u003c{ deleted: boolean; }\u003e\n```\n\nOpens a dialog to delete a reminder.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#deletereminderwithpromptoptions\"\u003eDeleteReminderWithPromptOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ deleted: boolean; }\u0026gt;\u003c/code\u003e\n\n**Since:** 7.2.0\n\n**Platform:** iOS\n\n---\n\n### Interfaces\n\n#### CreateEventWithPromptOptions\n\n| Prop | Type | Description | Since | Platform |\n| ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ------------ |\n| **`alerts`** | \u003ccode\u003enumber[]\u003c/code\u003e | 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`** | \u003ccode\u003e\u003ca href=\"#eventavailability\"\u003eEventAvailability\u003c/a\u003e\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`calendarId`** | \u003ccode\u003estring\u003c/code\u003e | | 0.1.0 | iOS |\n| **`description`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`endDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`invitees`** | \u003ccode\u003estring[]\u003c/code\u003e | An array of emails to invite. | 7.1.0 | Android |\n| **`isAllDay`** | \u003ccode\u003eboolean\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`location`** | \u003ccode\u003estring\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`recurrence`** | \u003ccode\u003e\u003ca href=\"#eventrecurrencerule\"\u003eEventRecurrenceRule\u003c/a\u003e\u003c/code\u003e | Rules for creating a recurring event. | 7.3.0 | Android, iOS |\n| **`startDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`url`** | \u003ccode\u003estring\u003c/code\u003e | | 0.1.0 | iOS |\n\n#### EventRecurrenceRule\n\n| Prop | Type | Description | Default | Since | Platform |\n| -------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ----- | ------------ |\n| **`byMonth`** | \u003ccode\u003enumber[]\u003c/code\u003e | 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`** | \u003ccode\u003enumber[]\u003c/code\u003e | 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`** | \u003ccode\u003enumber[]\u003c/code\u003e | 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`** | \u003ccode\u003enumber\u003c/code\u003e | 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`** | \u003ccode\u003enumber[]\u003c/code\u003e | Limits a yearly recurrence to specific days of the year (1 to 366). | | 7.3.0 | iOS |\n| **`end`** | \u003ccode\u003enumber\u003c/code\u003e | End date of the recurrence series as a Unix timestamp in milliseconds. | | 7.1.0 | Android, iOS |\n| **`frequency`** | \u003ccode\u003e\u003ca href=\"#recurrencefrequency\"\u003eRecurrenceFrequency\u003c/a\u003e\u003c/code\u003e | How often the event repeats. | | 7.3.0 | Android, iOS |\n| **`interval`** | \u003ccode\u003enumber\u003c/code\u003e | 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. | \u003ccode\u003e1\u003c/code\u003e | 7.3.0 | Android, iOS |\n| **`weeksOfTheYear`** | \u003ccode\u003enumber[]\u003c/code\u003e | 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`** | \u003ccode\u003enumber[]\u003c/code\u003e | 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`** | \u003ccode\u003e\u003ca href=\"#eventavailability\"\u003eEventAvailability\u003c/a\u003e\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`calendarId`** | \u003ccode\u003estring\u003c/code\u003e | | 0.1.0 | iOS |\n| **`description`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`endDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`invitees`** | \u003ccode\u003estring[]\u003c/code\u003e | An array of emails to invite. | 7.1.0 | Android |\n| **`isAllDay`** | \u003ccode\u003eboolean\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`location`** | \u003ccode\u003estring\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`recurrence`** | \u003ccode\u003e\u003ca href=\"#eventrecurrencerule\"\u003eEventRecurrenceRule\u003c/a\u003e\u003c/code\u003e | Rules for creating a recurring event. | 7.3.0 | Android, iOS |\n| **`startDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | 0.1.0 | Android, iOS |\n| **`url`** | \u003ccode\u003estring\u003c/code\u003e | | 0.1.0 | iOS |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | The ID of the event to be modified. | 7.1.0 | Android, iOS |\n\n#### CreateEventOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- | ----- | ------------ |\n| **`alerts`** | \u003ccode\u003enumber[]\u003c/code\u003e | 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`** | \u003ccode\u003eEventGuest[]\u003c/code\u003e | The event guests. | | 7.1.0 | Android |\n| **`availability`** | \u003ccode\u003e\u003ca href=\"#eventavailability\"\u003eEventAvailability\u003c/a\u003e\u003c/code\u003e | | | 7.1.0 | Android, iOS |\n| **`calendarId`** | \u003ccode\u003estring\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`color`** | \u003ccode\u003estring\u003c/code\u003e | | | 7.1.0 | Android |\n| **`commit`** | \u003ccode\u003eboolean\u003c/code\u003e | Whether to save immediately (`true`) or batch changes for later (`false`). | \u003ccode\u003etrue\u003c/code\u003e | 7.1.0 | iOS |\n| **`description`** | \u003ccode\u003estring\u003c/code\u003e | | | 7.1.0 | Android, iOS |\n| **`duration`** | \u003ccode\u003estring\u003c/code\u003e | Duration of the event in RFC2445 format. | | 7.1.0 | Android |\n| **`endDate`** | \u003ccode\u003enumber\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`isAllDay`** | \u003ccode\u003eboolean\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`location`** | \u003ccode\u003estring\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`organizer`** | \u003ccode\u003estring\u003c/code\u003e | Email of the event organizer. | | 7.1.0 | Android |\n| **`recurrence`** | \u003ccode\u003e\u003ca href=\"#eventrecurrencerule\"\u003eEventRecurrenceRule\u003c/a\u003e\u003c/code\u003e | Rules for creating a recurring event. | | 7.3.0 | Android, iOS |\n| **`startDate`** | \u003ccode\u003enumber\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | | 0.4.0 | Android, iOS |\n| **`url`** | \u003ccode\u003estring\u003c/code\u003e | | | 0.1.0 | iOS |\n\n#### EventGuest\n\n| Prop | Type | Since |\n| ----------- | ------------------- | ----- |\n| **`name`** | \u003ccode\u003estring\u003c/code\u003e | 7.1.0 |\n| **`email`** | \u003ccode\u003estring\u003c/code\u003e | 7.1.0 |\n\n#### ModifyEventOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | ----- | ------------ |\n| **`alerts`** | \u003ccode\u003enumber[]\u003c/code\u003e | 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`** | \u003ccode\u003eEventGuest[]\u003c/code\u003e | The event guests. | | 7.1.0 | Android |\n| **`availability`** | \u003ccode\u003e\u003ca href=\"#eventavailability\"\u003eEventAvailability\u003c/a\u003e\u003c/code\u003e | | | 7.1.0 | Android, iOS |\n| **`calendarId`** | \u003ccode\u003estring\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`color`** | \u003ccode\u003estring\u003c/code\u003e | | | 7.1.0 | Android |\n| **`description`** | \u003ccode\u003estring\u003c/code\u003e | | | 7.1.0 | Android, iOS |\n| **`duration`** | \u003ccode\u003estring\u003c/code\u003e | Duration of the event in RFC2445 format. | | 7.1.0 | Android |\n| **`endDate`** | \u003ccode\u003enumber\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | The ID of the event to be modified. | | 7.1.0 | Android, iOS |\n| **`isAllDay`** | \u003ccode\u003eboolean\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`location`** | \u003ccode\u003estring\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`recurrence`** | \u003ccode\u003e\u003ca href=\"#eventrecurrencerule\"\u003eEventRecurrenceRule\u003c/a\u003e\u003c/code\u003e | Rules for creating a recurring event. | | 7.3.0 | Android, iOS |\n| **`organizer`** | \u003ccode\u003estring\u003c/code\u003e | Email of the event organizer. | | 7.1.0 | Android |\n| **`span`** | \u003ccode\u003e\u003ca href=\"#eventspan\"\u003eEventSpan\u003c/a\u003e\u003c/code\u003e | The span of modifications. | \u003ccode\u003eEventSpan.THIS_EVENT\u003c/code\u003e | | iOS |\n| **`startDate`** | \u003ccode\u003enumber\u003c/code\u003e | | | 0.1.0 | Android, iOS |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | | 0.4.0 | Android, iOS |\n| **`url`** | \u003ccode\u003estring\u003c/code\u003e | | | 0.1.0 | iOS |\n\n#### DeleteEventsByIdResult\n\n| Prop | Type | Since |\n| ------------- | --------------------- | ----- |\n| **`deleted`** | \u003ccode\u003estring[]\u003c/code\u003e | 7.1.0 |\n| **`failed`** | \u003ccode\u003estring[]\u003c/code\u003e | 7.1.0 |\n\n#### DeleteEventsByIdOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ---------- | ----------------------------------------------- | --------------------- | --------------------------------- | ----- | -------- |\n| **`ids`** | \u003ccode\u003estring[]\u003c/code\u003e | | | 7.1.0 | |\n| **`span`** | \u003ccode\u003e\u003ca href=\"#eventspan\"\u003eEventSpan\u003c/a\u003e\u003c/code\u003e | The span of deletion. | \u003ccode\u003eEventSpan.THIS_EVENT\u003c/code\u003e | | iOS |\n\n#### DeleteEventOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ---------- | ----------------------------------------------- | --------------------- | --------------------------------- | ----- | -------- |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | | | 7.1.0 | |\n| **`span`** | \u003ccode\u003e\u003ca href=\"#eventspan\"\u003eEventSpan\u003c/a\u003e\u003c/code\u003e | The span of deletion. | \u003ccode\u003eEventSpan.THIS_EVENT\u003c/code\u003e | | iOS |\n\n#### DeleteEventWithPromptOptions\n\n| Prop | Type | Description | Default | Since | Platform |\n| ----------------------- | ----------------------------------------------- | ----------------------------------- | --------------------------------- | ----- | ------------ |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | | | 7.1.0 | |\n| **`span`** | \u003ccode\u003e\u003ca href=\"#eventspan\"\u003eEventSpan\u003c/a\u003e\u003c/code\u003e | The span of deletion. | \u003ccode\u003eEventSpan.THIS_EVENT\u003c/code\u003e | | iOS |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | Title of the dialog. | | 7.1.0 | Android, iOS |\n| **`message`** | \u003ccode\u003estring\u003c/code\u003e | Message of the dialog. | | 7.1.0 | Android, iOS |\n| **`confirmButtonText`** | \u003ccode\u003estring\u003c/code\u003e | Text to show on the confirm button. | \u003ccode\u003e'Delete'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`cancelButtonText`** | \u003ccode\u003estring\u003c/code\u003e | Text to show on the cancel button. | \u003ccode\u003e'Cancel'\u003c/code\u003e | 7.1.0 | Android, iOS |\n\n#### CalendarEvent\n\n| Prop | Type | Description | Since | Platform |\n| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ----- | ------------ |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`calendarId`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`location`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`startDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`endDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`isAllDay`** | \u003ccode\u003eboolean\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`alerts`** | \u003ccode\u003enumber[]\u003c/code\u003e | Alert times in minutes relative to the event start. | 7.1.0 | Android, iOS |\n| **`url`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`description`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`availability`** | \u003ccode\u003e\u003ca href=\"#eventavailability\"\u003eEventAvailability\u003c/a\u003e \\| null\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`organizer`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`color`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`duration`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | Android |\n| **`isDetached`** | \u003ccode\u003eboolean \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`birthdayContactIdentifier`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`status`** | \u003ccode\u003e\u003ca href=\"#eventstatus\"\u003eEventStatus\u003c/a\u003e \\| null\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`creationDate`** | \u003ccode\u003enumber \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`lastModifiedDate`** | \u003ccode\u003enumber \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`attendees`** | \u003ccode\u003e{ email: string \\| null; name: string \\| null; role: \u003ca href=\"#attendeerole\"\u003eAttendeeRole\u003c/a\u003e \\| null; status: \u003ca href=\"#attendeestatus\"\u003eAttendeeStatus\u003c/a\u003e \\| null; type: \u003ca href=\"#attendeetype\"\u003eAttendeeType\u003c/a\u003e \\| null; }[]\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`timezone`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | Android, iOS |\n\n#### ListEventsInRangeOptions\n\n| Prop | Type | Description | Since |\n| ---------- | ------------------- | ------------------------------ | ----- |\n| **`from`** | \u003ccode\u003enumber\u003c/code\u003e | The timestamp in milliseconds. | 7.1.0 |\n| **`to`** | \u003ccode\u003enumber\u003c/code\u003e | The timestamp in milliseconds. | 7.1.0 |\n\n#### Calendar\n\n| Prop | Type | Description | Since | Platform |\n| -------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------ | ----- | ------------ |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`internalTitle`** | \u003ccode\u003estring \\| null\u003c/code\u003e | Internal name of the calendar (`CalendarContract.Calendars.NAME`). | 7.1.0 | Android |\n| **`color`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 | Android, iOS |\n| **`isImmutable`** | \u003ccode\u003eboolean \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`allowsContentModifications`** | \u003ccode\u003eboolean \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`type`** | \u003ccode\u003e\u003ca href=\"#calendartype\"\u003eCalendarType\u003c/a\u003e \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`isSubscribed`** | \u003ccode\u003eboolean \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`source`** | \u003ccode\u003e\u003ca href=\"#calendarsource\"\u003eCalendarSource\u003c/a\u003e \\| null\u003c/code\u003e | | 7.1.0 | iOS |\n| **`visible`** | \u003ccode\u003eboolean \\| null\u003c/code\u003e | Indicates if the events from this calendar should be shown. | 7.1.0 | Android |\n| **`accountName`** | \u003ccode\u003estring \\| null\u003c/code\u003e | The account under which the calendar is registered. | 7.1.0 | Android |\n| **`ownerAccount`** | \u003ccode\u003estring \\| null\u003c/code\u003e | The owner of the calendar. | 7.1.0 | Android |\n| **`maxReminders`** | \u003ccode\u003enumber \\| null\u003c/code\u003e | Maximum number of reminders allowed per event. | 7.1.0 | Android |\n| **`location`** | \u003ccode\u003estring \\| null\u003c/code\u003e | | 7.1.0 | Android |\n\n#### CalendarSource\n\n| Prop | Type | Since |\n| ----------- | ----------------------------------------------------------------- | ----- |\n| **`type`** | \u003ccode\u003e\u003ca href=\"#calendarsourcetype\"\u003eCalendarSourceType\u003c/a\u003e\u003c/code\u003e | 7.1.0 |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | 7.1.0 |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | 7.1.0 |\n\n#### SelectCalendarsWithPromptOptions\n\n| Prop | Type | Description | Default | Since |\n| ------------------ | ----------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------ | ----- |\n| **`displayStyle`** | \u003ccode\u003e\u003ca href=\"#calendarchooserdisplaystyle\"\u003eCalendarChooserDisplayStyle\u003c/a\u003e\u003c/code\u003e | | \u003ccode\u003eCalendarChooserDisplayStyle.ALL_CALENDARS\u003c/code\u003e | 7.1.0 |\n| **`multiple`** | \u003ccode\u003eboolean\u003c/code\u003e | Allow multiple selections. | \u003ccode\u003efalse\u003c/code\u003e | 7.1.0 |\n\n#### OpenCalendarOptions\n\n| Prop | Type | Default | Since |\n| ---------- | ------------------- | ----------------------- | ----- |\n| **`date`** | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003eDate.now()\u003c/code\u003e | 7.1.0 |\n\n#### CreateCalendarOptions\n\n| Prop | Type | Description | Since | Platform |\n| ------------------ | ------------------- | ---------------------------------------------------------- | ----- | ------------ |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | 5.2.0 | Android, iOS |\n| **`color`** | \u003ccode\u003estring\u003c/code\u003e | The color of the calendar. Should be provided on Android. | 5.2.0 | Android, iOS |\n| **`sourceId`** | \u003ccode\u003estring\u003c/code\u003e | | 5.2.0 | iOS |\n| **`accountName`** | \u003ccode\u003estring\u003c/code\u003e | Only needed on Android. Typically set to an email address. | 7.1.0 | Android |\n| **`ownerAccount`** | \u003ccode\u003estring\u003c/code\u003e | Only needed on Android. Typically set to an email address. | 7.1.0 | Android |\n\n#### DeleteCalendarOptions\n\n| Prop | Type | Since |\n| -------- | ------------------- | ----- |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | 7.1.0 |\n\n#### ModifyCalendarOptions\n\n| Prop | Type | Since | Platform |\n| ----------- | ------------------- | ----- | ------------ |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | 7.2.0 | Android, iOS |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | 7.2.0 | Android, iOS |\n| **`color`** | \u003ccode\u003estring\u003c/code\u003e | 7.2.0 | Android, iOS |\n\n#### CreateReminderOptions\n\n| Prop | Type | Description | Since |\n| -------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`listId`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`priority`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 |\n| **`isCompleted`** | \u003ccode\u003eboolean\u003c/code\u003e | | 7.1.0 |\n| **`startDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 |\n| **`dueDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 |\n| **`completionDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 |\n| **`notes`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`url`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`location`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`recurrence`** | \u003ccode\u003e\u003ca href=\"#recurrencerule\"\u003eRecurrenceRule\u003c/a\u003e\u003c/code\u003e | | 7.1.0 |\n| **`alerts`** | \u003ccode\u003enumber[]\u003c/code\u003e | Alert times in minutes relative to the reminder start. Use negative numbers for alerts before the start, and positive numbers for alerts after the start. | 7.1.0 |\n\n#### RecurrenceRule\n\n| Prop | Type | Description | Since |\n| --------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ----- |\n| **`frequency`** | \u003ccode\u003e\u003ca href=\"#recurrencefrequency\"\u003eRecurrenceFrequency\u003c/a\u003e\u003c/code\u003e | | 7.1.0 |\n| **`interval`** | \u003ccode\u003enumber\u003c/code\u003e | How often it repeats (e.g. 1 for every occurrence, 2 for every second occurrence). | 7.1.0 |\n| **`end`** | \u003ccode\u003enumber\u003c/code\u003e | Timestamp of when the recurrence ends. | 7.1.0 |\n\n#### DeleteRemindersByIdResult\n\n| Prop | Type | Since |\n| ------------- | --------------------- | ----- |\n| **`deleted`** | \u003ccode\u003estring[]\u003c/code\u003e | 7.1.0 |\n| **`failed`** | \u003ccode\u003estring[]\u003c/code\u003e | 7.1.0 |\n\n#### DeleteRemindersByIdOptions\n\n| Prop | Type | Since |\n| --------- | --------------------- | ----- |\n| **`ids`** | \u003ccode\u003estring[]\u003c/code\u003e | 7.1.0 |\n\n#### DeleteReminderOptions\n\n| Prop | Type | Since |\n| -------- | ------------------- | ----- |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | 7.1.0 |\n\n#### ModifyReminderOptions\n\n| Prop | Type | Description | Since |\n| -------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`listId`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`priority`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 |\n| **`isCompleted`** | \u003ccode\u003eboolean\u003c/code\u003e | | 7.1.0 |\n| **`startDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 |\n| **`dueDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 |\n| **`completionDate`** | \u003ccode\u003enumber\u003c/code\u003e | | 7.1.0 |\n| **`notes`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`url`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`location`** | \u003ccode\u003estring\u003c/code\u003e | | 7.1.0 |\n| **`recurrence`** | \u003ccode\u003e\u003ca href=\"#recurrencerule\"\u003eRecurrenceRule\u003c/a\u003e\u003c/code\u003e | | 7.1.0 |\n| **`alerts`** | \u003ccode\u003enumber[]\u003c/code\u003e | Alert times in minutes relative to the reminder start. Use negative numbers for alerts before the start, and positive numbers for alerts after the start. On iOS only 2 alerts are supported. | 7.1.0 |\n\n#### Reminder\n\n| Prop | Type | Since |\n| -------------------- | ----------------------------- | ----- |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | 7.1.0 |\n| **`title`** | \u003ccode\u003estring \\| null\u003c/code\u003e | 7.1.0 |\n| **`listId`** | \u003ccode\u003estring \\| null\u003c/code\u003e | 7.1.0 |\n| **`isCompleted`** | \u003ccode\u003eboolean\u003c/code\u003e | 7.1.0 |\n| **`priority`** | \u003ccode\u003enumber \\| null\u003c/code\u003e | 7.1.0 |\n| **`notes`** | \u003ccode\u003estring \\| null\u003c/code\u003e | 7.1.0 |\n| **`location`** | \u003ccode\u003estring \\| null\u003c/code\u003e | 7.1.0 |\n| **`url`** | \u003ccode\u003estring \\| null\u003c/code\u003e | 7.1.0 |\n| **`startDate`** | \u003ccode\u003enumber \\| null\u003c/code\u003e | 7.1.0 |\n| **`dueDate`** | \u003ccode\u003enumber \\| null\u003c/code\u003e | 7.1.0 |\n| **`completionDate`** | \u003ccode\u003enumber \\| null\u003c/code\u003e | 7.1.0 |\n| **`recurrence`** | \u003ccode\u003eRecurrenceRule[]\u003c/code\u003e | 7.1.0 |\n| **`alerts`** | \u003ccode\u003enumber[]\u003c/code\u003e | 7.1.0 |\n\n#### GetReminderByIdOptions\n\n| Prop | Type | Since |\n| -------- | ------------------- | ----- |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | 7.1.0 |\n\n#### GetRemindersFromListsOptions\n\n| Prop | Type | Since |\n| ------------- | --------------------- | ----- |\n| **`listIds`** | \u003ccode\u003estring[]\u003c/code\u003e | 7.1.0 |\n\n#### DeleteReminderWithPromptOptions\n\n| Prop | Type | Description | Default | Since |\n| ----------------------- | ------------------- | ----------------------------------- | --------------------- | ----- |\n| **`id`** | \u003ccode\u003estring\u003c/code\u003e | | | 7.2.0 |\n| **`title`** | \u003ccode\u003estring\u003c/code\u003e | Title of the dialog. | | 7.2.0 |\n| **`message`** | \u003ccode\u003estring\u003c/code\u003e | Message of the dialog. | | 7.2.0 |\n| **`confirmButtonText`** | \u003ccode\u003estring\u003c/code\u003e | Text to show on the confirm button. | \u003ccode\u003e'Delete'\u003c/code\u003e | 7.2.0 |\n| **`cancelButtonText`** | \u003ccode\u003estring\u003c/code\u003e | Text to show on the cancel button. | \u003ccode\u003e'Cancel'\u003c/code\u003e | 7.2.0 |\n\n### Type Aliases\n\n#### PermissionState\n\n\u003ccode\u003e'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'\u003c/code\u003e\n\n#### CheckAllPermissionsResult\n\n\u003ccode\u003e\n \u003ca href=\"#record\"\u003eRecord\u003c/a\u003e\u0026lt;\u003ca href=\"#calendarpermissionscope\"\u003eCalendarPermissionScope\u003c/a\u003e,{' '}\n \u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e\u0026gt;\n\u003c/code\u003e\n\n#### Record\n\nConstruct a type with a set of properties K of type T\n\n\u003ccode\u003e{\n [P in K]: T;\n }\u003c/code\u003e\n\n#### RequestAllPermissionsResult\n\n\u003ccode\u003e\n \u003ca href=\"#checkallpermissionsresult\"\u003eCheckAllPermissionsResult\u003c/a\u003e\n\u003c/code\u003e\n\n#### RecurrenceFrequency\n\n\u003ccode\u003e'daily' | 'weekly' | 'monthly' | 'yearly'\u003c/code\u003e\n\n#### EventEditAction\n\n\u003ccode\u003e'canceled' | 'saved' | 'deleted'\u003c/code\u003e\n\n#### RemindersList\n\n\u003ccode\u003e\n \u003ca href=\"#calendar\"\u003eCalendar\u003c/a\u003e\n\u003c/code\u003e\n\n### Enums\n\n#### CalendarPermissionScope\n\n| Members | Value | Description | Since | Platform |\n| --------------------- | ----------------------------- | ------------------------------------------------------------ | ----- | ------------ |\n| **`READ_CALENDAR`** | \u003ccode\u003e'readCalendar'\u003c/code\u003e | Permission required for reading calendar events. | 7.1.0 | Android, iOS |\n| **`READ_REMINDERS`** | \u003ccode\u003e'readReminders'\u003c/code\u003e | Permission required for reading reminders. | 7.1.0 | iOS |\n| **`WRITE_CALENDAR`** | \u003ccode\u003e'writeCalendar'\u003c/code\u003e | Permission required for adding or modifying calendar events. | 7.1.0 | Android, iOS |\n| **`WRITE_REMINDERS`** | \u003ccode\u003e'writeReminders'\u003c/code\u003e | Permission required for adding or modifying reminders. | 7.1.0 | iOS |\n\n#### EventAvailability\n\n| Members | Value | Since | Platform |\n| ------------------- | --------------- | ----- | ------------ |\n| **`NOT_SUPPORTED`** | \u003ccode\u003e-1\u003c/code\u003e | 7.1.0 | iOS |\n| **`BUSY`** | | 7.1.0 | Android, iOS |\n| **`FREE`** | | 7.1.0 | Android, iOS |\n| **`TENTATIVE`** | | 7.1.0 | Android, iOS |\n| **`UNAVAILABLE`** | | 7.1.0 | iOS |\n\n#### EventSpan\n\n| Members | Since |\n| ---------------------------- | ----- |\n| **`THIS_EVENT`** | 7.1.0 |\n| **`THIS_AND_FUTURE_EVENTS`** | 7.1.0 |\n\n#### EventStatus\n\n| Members | Value | Since | Platform |\n| --------------- | ------------------------ | ----- | ------------ |\n| **`NONE`** | \u003ccode\u003e'none'\u003c/code\u003e | 7.1.0 | iOS |\n| **`CONFIRMED`** | \u003ccode\u003e'confirmed'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`TENTATIVE`** | \u003ccode\u003e'tentative'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`CANCELED`** | \u003ccode\u003e'canceled'\u003c/code\u003e | 7.1.0 | Android, iOS |\n\n#### AttendeeRole\n\n| Members | Value | Since | Platform |\n| --------------------- | ----------------------------- | ----- | ------------ |\n| **`UNKNOWN`** | \u003ccode\u003e'unknown'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`REQUIRED`** | \u003ccode\u003e'required'\u003c/code\u003e | 7.1.0 | iOS |\n| **`OPTIONAL`** | \u003ccode\u003e'optional'\u003c/code\u003e | 7.1.0 | iOS |\n| **`CHAIR`** | \u003ccode\u003e'chair'\u003c/code\u003e | 7.1.0 | iOS |\n| **`NON_PARTICIPANT`** | \u003ccode\u003e'nonParticipant'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`ATTENDEE`** | \u003ccode\u003e'attendee'\u003c/code\u003e | 7.1.0 | Android |\n| **`ORGANIZER`** | \u003ccode\u003e'organizer'\u003c/code\u003e | 7.1.0 | Android |\n| **`PERFORMER`** | \u003ccode\u003e'performer'\u003c/code\u003e | 7.1.0 | Android |\n| **`SPEAKER`** | \u003ccode\u003e'speaker'\u003c/code\u003e | 7.1.0 | Android |\n\n#### AttendeeStatus\n\n| Members | Value | Since | Platform |\n| ---------------- | ------------------------ | ----- | ------------ |\n| **`NONE`** | \u003ccode\u003e'none'\u003c/code\u003e | 7.1.0 | Android |\n| **`ACCEPTED`** | \u003ccode\u003e'accepted'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`DECLINED`** | \u003ccode\u003e'declined'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`INVITED`** | \u003ccode\u003e'invited'\u003c/code\u003e | 7.1.0 | Android |\n| **`UNKNOWN`** | \u003ccode\u003e'unknown'\u003c/code\u003e | 7.1.0 | iOS |\n| **`PENDING`** | \u003ccode\u003e'pending'\u003c/code\u003e | 7.1.0 | iOS |\n| **`TENTATIVE`** | \u003ccode\u003e'tentative'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`DELEGATED`** | \u003ccode\u003e'delegated'\u003c/code\u003e | 7.1.0 | iOS |\n| **`COMPLETED`** | \u003ccode\u003e'completed'\u003c/code\u003e | 7.1.0 | iOS |\n| **`IN_PROCESS`** | \u003ccode\u003e'inProcess'\u003c/code\u003e | 7.1.0 | iOS |\n\n#### AttendeeType\n\n| Members | Value | Since | Platform |\n| -------------- | ----------------------- | ----- | ------------ |\n| **`UNKNOWN`** | \u003ccode\u003e'unknown'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`PERSON`** | \u003ccode\u003e'person'\u003c/code\u003e | 7.1.0 | iOS |\n| **`ROOM`** | \u003ccode\u003e'room'\u003c/code\u003e | 7.1.0 | iOS |\n| **`RESOURCE`** | \u003ccode\u003e'resource'\u003c/code\u003e | 7.1.0 | Android, iOS |\n| **`GROUP`** | \u003ccode\u003e'group'\u003c/code\u003e | 7.1.0 | iOS |\n| **`REQUIRED`** | \u003ccode\u003e'required'\u003c/code\u003e | 7.1.0 | Android |\n| **`NONE`** | \u003ccode\u003e'none'\u003c/code\u003e | 7.1.0 | Android |\n| **`OPTIONAL`** | \u003ccode\u003e'optional'\u003c/code\u003e | 7.1.0 | Android |\n\n#### CalendarType\n\n| Members | Since |\n| ------------------ | ----- |\n| **`LOCAL`** | 7.1.0 |\n| **`CAL_DAV`** | 7.1.0 |\n| **`EXCHANGE`** | 7.1.0 |\n| **`SUBSCRIPTION`** | 7.1.0 |\n| **`BIRTHDAY`** | 7.1.0 |\n\n#### CalendarSourceType\n\n| Members | Since |\n| ---------------- | ----- |\n| **`LOCAL`** | 7.1.0 |\n| **`EXCHANGE`** | 7.1.0 |\n| **`CAL_DAV`** | 7.1.0 |\n| **`MOBILE_ME`** | 7.1.0 |\n| **`SUBSCRIBED`** | 7.1.0 |\n| **`BIRTHDAYS`** | 7.1.0 |\n\n#### CalendarChooserDisplayStyle\n\n| Members | Since |\n| ----------------------------- | ----- |\n| **`ALL_CALENDARS`** | 0.2.0 |\n| **`WRITABLE_CALENDARS_ONLY`** | 0.2.0 |\n\n\u003c/docgen-api\u003e\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n## License\n\nThis project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febarooni%2Fcapacitor-calendar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Febarooni%2Fcapacitor-calendar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febarooni%2Fcapacitor-calendar/lists"}