{ "api": { "name": "CapacitorCalendarPlugin", "slug": "capacitorcalendarplugin", "docs": "", "tags": [], "methods": [ { "name": "checkPermission", "signature": "(options: { scope: CalendarPermissionScope; }) => Promise<{ result: PermissionState; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ scope: CalendarPermissionScope; }" } ], "returns": "Promise<{ result: PermissionState; }>", "tags": [ { "name": "example", "text": "CapacitorCalendar.checkPermission({ scope: CalendarPermissionScope.READ_CALENDAR });" }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "0.1.0" } ], "docs": "Retrieves the current permission state for a given scope.", "complexTypes": [ "PermissionState", "CalendarPermissionScope" ], "slug": "checkpermission" }, { "name": "checkAllPermissions", "signature": "() => Promise<{ result: CheckAllPermissionsResult; }>", "parameters": [], "returns": "Promise<{ result: CheckAllPermissionsResult; }>", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "0.1.0" } ], "docs": "Retrieves the current state of all permissions.", "complexTypes": [ "CheckAllPermissionsResult" ], "slug": "checkallpermissions" }, { "name": "requestPermission", "signature": "(options: { scope: CalendarPermissionScope; }) => Promise<{ result: PermissionState; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ scope: CalendarPermissionScope; }" } ], "returns": "Promise<{ result: PermissionState; }>", "tags": [ { "name": "example", "text": "this.requestPermission({ scope: CalendarPermissionScope.READ_CALENDAR });" }, { "name": "deprecated", "text": "Use {@link requestWriteOnlyCalendarAccess}, {@link requestReadOnlyCalendarAccess},\n{@link requestFullCalendarAccess} or {@link requestFullRemindersAccess} instead." }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "0.1.0" } ], "docs": "Requests permission for a given scope.", "complexTypes": [ "PermissionState", "CalendarPermissionScope" ], "slug": "requestpermission" }, { "name": "requestAllPermissions", "signature": "() => Promise<{ result: RequestAllPermissionsResult; }>", "parameters": [], "returns": "Promise<{ result: CheckAllPermissionsResult; }>", "tags": [ { "name": "deprecated", "text": "Use {@link requestFullCalendarAccess} or {@link requestFullRemindersAccess} instead." }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "0.1.0" } ], "docs": "Requests permission for all calendar and reminder permissions.", "complexTypes": [ "RequestAllPermissionsResult" ], "slug": "requestallpermissions" }, { "name": "requestWriteOnlyCalendarAccess", "signature": "() => Promise<{ result: PermissionState; }>", "parameters": [], "returns": "Promise<{ result: PermissionState; }>", "tags": [ { "name": "permissions", "text": "| Platform | Required |\n|-----------|---------------------|\n| iOS 17+ | `NSCalendarsWriteOnlyAccessUsageDescription` |\n| iOS 13-16 | `NSCalendarsUsageDescription` |\n| Android | `android.permission.WRITE_CALENDAR` |" }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "5.4.0" } ], "docs": "Requests write access to the calendar.", "complexTypes": [ "PermissionState" ], "slug": "requestwriteonlycalendaraccess" }, { "name": "requestReadOnlyCalendarAccess", "signature": "() => Promise<{ result: PermissionState; }>", "parameters": [], "returns": "Promise<{ result: PermissionState; }>", "tags": [ { "name": "permissions", "text": "| Platform | Required |\n|-----------|---------------------|\n| Android | `android.permission.READ_CALENDAR` |" }, { "name": "platform", "text": "Android" }, { "name": "since", "text": "5.4.0" } ], "docs": "Requests read access to the calendar.", "complexTypes": [ "PermissionState" ], "slug": "requestreadonlycalendaraccess" }, { "name": "requestFullCalendarAccess", "signature": "() => Promise<{ result: PermissionState; }>", "parameters": [], "returns": "Promise<{ result: PermissionState; }>", "tags": [ { "name": "permissions", "text": "| Platform | Required |\n|-----------|---------------------|\n| iOS 17+ | `NSCalendarsFullAccessUsageDescription` |\n| iOS 13-16 | `NSCalendarsUsageDescription` |\n| Android | `android.permission.READ_CALENDAR` & `android.permission.WRITE_CALENDAR` |" }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "5.4.0" } ], "docs": "Requests read and write access to the calendar.", "complexTypes": [ "PermissionState" ], "slug": "requestfullcalendaraccess" }, { "name": "requestFullRemindersAccess", "signature": "() => Promise<{ result: PermissionState; }>", "parameters": [], "returns": "Promise<{ result: PermissionState; }>", "tags": [ { "name": "permissions", "text": "| Platform | Required |\n|-----------|---------------------|\n| iOS 17+ | `NSRemindersFullAccessUsageDescription` |\n| iOS 10-16 | `NSRemindersUsageDescription` |" }, { "name": "platform", "text": "iOS" }, { "name": "see", "text": "{" }, { "name": "link", "text": "CalendarPermissionScope}" }, { "name": "since", "text": "5.4.0" } ], "docs": "Requests read and write access to the reminders.", "complexTypes": [ "PermissionState" ], "slug": "requestfullremindersaccess" }, { "name": "createEventWithPrompt", "signature": "(options?: CreateEventWithPromptOptions | undefined) => Promise<{ id: string | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "CreateEventWithPromptOptions | undefined" } ], "returns": "Promise<{ id: string | null; }>", "tags": [ { "name": "example", "text": "const options = {\n title: 'Test event',\n startDate: Date.now(),\n}\nawait CapacitorCalendar.createEventWithPrompt(options)" }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "0.1.0" } ], "docs": "Opens 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.", "complexTypes": [ "CreateEventWithPromptOptions" ], "slug": "createeventwithprompt" }, { "name": "modifyEventWithPrompt", "signature": "(options: ModifyEventWithPromptOptions) => Promise<{ result: EventEditAction | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "ModifyEventWithPromptOptions" } ], "returns": "Promise<{ result: EventEditAction | null; }>", "tags": [ { "name": "example", "text": "const options = {\n id: 'EVENT_ID',\n title: 'New title',\n}\nawait CapacitorCalendar.modifyEventWithPrompt(options);" }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "6.6.0" } ], "docs": "Opens a system calendar interface to modify an event.\nOn Android always returns `null`.", "complexTypes": [ "EventEditAction", "ModifyEventWithPromptOptions" ], "slug": "modifyeventwithprompt" }, { "name": "createEvent", "signature": "(options: CreateEventOptions) => Promise<{ id: string; }>", "parameters": [ { "name": "options", "docs": "", "type": "CreateEventOptions" } ], "returns": "Promise<{ id: string; }>", "tags": [ { "name": "platform", "text": "iOS, Android" }, { "name": "since", "text": "0.4.0" } ], "docs": "Creates an event in the calendar.", "complexTypes": [ "CreateEventOptions" ], "slug": "createevent" }, { "name": "modifyEvent", "signature": "(options: ModifyEventOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "ModifyEventOptions" } ], "returns": "Promise", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "6.6.0" } ], "docs": "Modifies an event.", "complexTypes": [ "ModifyEventOptions" ], "slug": "modifyevent" }, { "name": "deleteEventsById", "signature": "(options: DeleteEventsByIdOptions) => Promise<{ result: DeleteEventsByIdResult; }>", "parameters": [ { "name": "options", "docs": "", "type": "DeleteEventsByIdOptions" } ], "returns": "Promise<{ result: DeleteEventsByIdResult; }>", "tags": [ { "name": "deprecated", "text": "Use `deleteEvent(...)`." }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "0.11.0" } ], "docs": "Deletes multiple events.", "complexTypes": [ "DeleteEventsByIdResult", "DeleteEventsByIdOptions" ], "slug": "deleteeventsbyid" }, { "name": "deleteEvent", "signature": "(options: DeleteEventOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "DeleteEventOptions" } ], "returns": "Promise", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Deletes an event.", "complexTypes": [ "DeleteEventOptions" ], "slug": "deleteevent" }, { "name": "deleteEventWithPrompt", "signature": "(options: DeleteEventWithPromptOptions) => Promise<{ deleted: boolean; }>", "parameters": [ { "name": "options", "docs": "", "type": "DeleteEventWithPromptOptions" } ], "returns": "Promise<{ deleted: boolean; }>", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Opens a dialog to delete an event.", "complexTypes": [ "DeleteEventWithPromptOptions" ], "slug": "deleteeventwithprompt" }, { "name": "listEventsInRange", "signature": "(options: ListEventsInRangeOptions) => Promise<{ result: CalendarEvent[]; }>", "parameters": [ { "name": "options", "docs": "", "type": "ListEventsInRangeOptions" } ], "returns": "Promise<{ result: CalendarEvent[]; }>", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "0.10.0" } ], "docs": "Retrieves the events within a date range.", "complexTypes": [ "CalendarEvent", "ListEventsInRangeOptions" ], "slug": "listeventsinrange" }, { "name": "commit", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Save the changes to the calendar.", "complexTypes": [], "slug": "commit" }, { "name": "selectCalendarsWithPrompt", "signature": "(options?: SelectCalendarsWithPromptOptions | undefined) => Promise<{ result: Calendar[]; }>", "parameters": [ { "name": "options", "docs": "", "type": "SelectCalendarsWithPromptOptions | undefined" } ], "returns": "Promise<{ result: Calendar[]; }>", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "0.2.0" } ], "docs": "Opens a system interface to choose one or multiple calendars.", "complexTypes": [ "Calendar", "SelectCalendarsWithPromptOptions" ], "slug": "selectcalendarswithprompt" }, { "name": "fetchAllCalendarSources", "signature": "() => Promise<{ result: CalendarSource[]; }>", "parameters": [], "returns": "Promise<{ result: CalendarSource[]; }>", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "6.6.0" } ], "docs": "Retrieves a list of calendar sources.", "complexTypes": [ "CalendarSource" ], "slug": "fetchallcalendarsources" }, { "name": "listCalendars", "signature": "() => Promise<{ result: Calendar[]; }>", "parameters": [], "returns": "Promise<{ result: Calendar[]; }>", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Retrieves a list of all available calendars.", "complexTypes": [ "Calendar" ], "slug": "listcalendars" }, { "name": "getDefaultCalendar", "signature": "() => Promise<{ result: Calendar | null; }>", "parameters": [], "returns": "Promise<{ result: Calendar | null; }>", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "0.3.0" } ], "docs": "Retrieves the default calendar.", "complexTypes": [ "Calendar" ], "slug": "getdefaultcalendar" }, { "name": "openCalendar", "signature": "(options?: OpenCalendarOptions | undefined) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "OpenCalendarOptions | undefined" } ], "returns": "Promise", "tags": [ { "name": "example", "text": "CapacitorCalendar.openCalendar({ date: Date.now() });" }, { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Opens the calendar app.", "complexTypes": [ "OpenCalendarOptions" ], "slug": "opencalendar" }, { "name": "createCalendar", "signature": "(options: CreateCalendarOptions) => Promise<{ id: string; }>", "parameters": [ { "name": "options", "docs": "", "type": "CreateCalendarOptions" } ], "returns": "Promise<{ id: string; }>", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "5.2.0" } ], "docs": "Creates a calendar.", "complexTypes": [ "CreateCalendarOptions" ], "slug": "createcalendar" }, { "name": "deleteCalendar", "signature": "(options: DeleteCalendarOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "DeleteCalendarOptions" } ], "returns": "Promise", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "5.2.0" } ], "docs": "Deletes a calendar by id.", "complexTypes": [ "DeleteCalendarOptions" ], "slug": "deletecalendar" }, { "name": "modifyCalendar", "signature": "(options: ModifyCalendarOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "ModifyCalendarOptions" } ], "returns": "Promise", "tags": [ { "name": "platform", "text": "Android, iOS" }, { "name": "since", "text": "7.2.0" } ], "docs": "Modifies a calendar with options.", "complexTypes": [ "ModifyCalendarOptions" ], "slug": "modifycalendar" }, { "name": "fetchAllRemindersSources", "signature": "() => Promise<{ result: CalendarSource[]; }>", "parameters": [], "returns": "Promise<{ result: CalendarSource[]; }>", "tags": [ { "name": "deprecated", "text": "Duplicates {@link CalendarOperations#fetchAllCalendarSources}" }, { "name": "platform", "text": "iOS" }, { "name": "since", "text": "6.6.0" } ], "docs": "Retrieves a list of calendar sources.", "complexTypes": [ "CalendarSource" ], "slug": "fetchallreminderssources" }, { "name": "openReminders", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Opens the reminders app.", "complexTypes": [], "slug": "openreminders" }, { "name": "getDefaultRemindersList", "signature": "() => Promise<{ result: RemindersList | null; }>", "parameters": [], "returns": "Promise<{ result: Calendar | null; }>", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Retrieves the default reminders list.", "complexTypes": [ "RemindersList" ], "slug": "getdefaultreminderslist" }, { "name": "getRemindersLists", "signature": "() => Promise<{ result: RemindersList[]; }>", "parameters": [], "returns": "Promise<{ result: Calendar[]; }>", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Retrieves all available reminders lists.", "complexTypes": [ "RemindersList" ], "slug": "getreminderslists" }, { "name": "createReminder", "signature": "(options: CreateReminderOptions) => Promise<{ id: string; }>", "parameters": [ { "name": "options", "docs": "", "type": "CreateReminderOptions" } ], "returns": "Promise<{ id: string; }>", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "0.5.0" } ], "docs": "Creates a reminder.", "complexTypes": [ "CreateReminderOptions" ], "slug": "createreminder" }, { "name": "deleteRemindersById", "signature": "(options: DeleteRemindersByIdOptions) => Promise<{ result: DeleteRemindersByIdResult; }>", "parameters": [ { "name": "options", "docs": "", "type": "DeleteRemindersByIdOptions" } ], "returns": "Promise<{ result: DeleteRemindersByIdResult; }>", "tags": [ { "name": "deprecated", "text": "Use `deleteReminder(...)`." }, { "name": "platform", "text": "iOS" }, { "name": "since", "text": "5.3.0" } ], "docs": "Deletes multiple reminders.", "complexTypes": [ "DeleteRemindersByIdResult", "DeleteRemindersByIdOptions" ], "slug": "deleteremindersbyid" }, { "name": "deleteReminder", "signature": "(options: DeleteReminderOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "DeleteReminderOptions" } ], "returns": "Promise", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Deletes a reminder.", "complexTypes": [ "DeleteReminderOptions" ], "slug": "deletereminder" }, { "name": "modifyReminder", "signature": "(options: ModifyReminderOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "ModifyReminderOptions" } ], "returns": "Promise", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "6.7.0" } ], "docs": "Modifies a reminder.", "complexTypes": [ "ModifyReminderOptions" ], "slug": "modifyreminder" }, { "name": "getReminderById", "signature": "(options: GetReminderByIdOptions) => Promise<{ result: Reminder | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "GetReminderByIdOptions" } ], "returns": "Promise<{ result: Reminder | null; }>", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "7.1.0" } ], "docs": "Retrieve a reminder by ID.", "complexTypes": [ "Reminder", "GetReminderByIdOptions" ], "slug": "getreminderbyid" }, { "name": "getRemindersFromLists", "signature": "(options: GetRemindersFromListsOptions) => Promise<{ result: Reminder[]; }>", "parameters": [ { "name": "options", "docs": "", "type": "GetRemindersFromListsOptions" } ], "returns": "Promise<{ result: Reminder[]; }>", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "5.3.0" } ], "docs": "Retrieves reminders from multiple lists.", "complexTypes": [ "Reminder", "GetRemindersFromListsOptions" ], "slug": "getremindersfromlists" }, { "name": "deleteReminderWithPrompt", "signature": "(options: DeleteReminderWithPromptOptions) => Promise<{ deleted: boolean; }>", "parameters": [ { "name": "options", "docs": "", "type": "DeleteReminderWithPromptOptions" } ], "returns": "Promise<{ deleted: boolean; }>", "tags": [ { "name": "platform", "text": "iOS" }, { "name": "since", "text": "7.2.0" } ], "docs": "Opens a dialog to delete a reminder.", "complexTypes": [ "DeleteReminderWithPromptOptions" ], "slug": "deletereminderwithprompt" } ], "properties": [] }, "interfaces": [ { "name": "CreateEventWithPromptOptions", "slug": "createeventwithpromptoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "alerts", "tags": [ { "text": "// -1440 -> 1 day before\n// -60 -> 1 hour before\n// 30 -> 30 minutes after\n[-1440, -60, 30]", "name": "example" }, { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Alert times in minutes relative to the event start.\nUse negative numbers for reminders before the start, and positive numbers for reminders after the start.\nOn iOS only 2 alerts are supported.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability" }, { "name": "calendarId", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "description", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "endDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "invitees", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "An array of emails to invite.", "complexTypes": [], "type": "string[] | undefined" }, { "name": "isAllDay", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | undefined" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "recurrence", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "Rules for creating a recurring event.", "complexTypes": [ "EventRecurrenceRule" ], "type": "EventRecurrenceRule" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "url", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "EventRecurrenceRule", "slug": "eventrecurrencerule", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "byMonth", "tags": [ { "text": "[1, 7] // Means in January and July.", "name": "example" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Limits a yearly recurrence to specific months of the year.\nThe values should be between 1 and 12.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "byMonthDay", "tags": [ { "text": "[1, 15] // The 1st and 15th of each month.", "name": "example" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Limits a monthly recurrence to specific days of the month.\nThe values should be between 1 and 31.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "byWeekDay", "tags": [ { "text": "[1, 3, 5] // Every Monday, Wednesday and Friday", "name": "example" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "Limits a weekly recurrence to specific weekdays.\nThe values should be between 1 and 7.\n1 means Monday and 7 means Sunday.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "count", "tags": [ { "text": "10", "name": "example" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "The total number of occurrences.\nIf set, the recurrence ends after this many occurrences.\nIf `count` is provided, `end` is ignored.", "complexTypes": [], "type": "number | undefined" }, { "name": "daysOfTheYear", "tags": [ { "text": "[1, 100, 364]", "name": "example" }, { "text": "iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "Limits a yearly recurrence to specific days of the year (1 to 366).", "complexTypes": [], "type": "number[] | undefined" }, { "name": "end", "tags": [ { "text": "const date = new Date();\ndate.setMonth(date.getMonth() + 1);\nconst end = date.getTime();", "name": "example" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "End date of the recurrence series as a Unix timestamp in milliseconds.", "complexTypes": [], "type": "number | undefined" }, { "name": "frequency", "tags": [ { "text": "'weekly'", "name": "example" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "How often the event repeats.", "complexTypes": [ "RecurrenceFrequency" ], "type": "RecurrenceFrequency" }, { "name": "interval", "tags": [ { "text": "2", "name": "example" }, { "text": "1", "name": "default" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "The interval between recurrences. Use in combination with `frequency`.\nFor example, a weekly event with an interval of 2, results in the event\noccurring every 2 weeks.", "complexTypes": [], "type": "number | undefined" }, { "name": "weeksOfTheYear", "tags": [ { "text": "[1, 53]", "name": "example" }, { "text": "iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "Limits a yearly recurrence to specific ISO week numbers (1 to 53).", "complexTypes": [], "type": "number[] | undefined" } ] }, { "name": "ModifyEventWithPromptOptions", "slug": "modifyeventwithpromptoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "alerts", "tags": [ { "text": "// -1440 -> 1 day before\n// -60 -> 1 hour before\n// 30 -> 30 minutes after\n[-1440, -60, 30]", "name": "example" }, { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Alert times in minutes relative to the event start.\nUse negative numbers for reminders before the start, and positive numbers for reminders after the start.\nOn iOS only 2 alerts are supported.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability" }, { "name": "calendarId", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "description", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "endDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "invitees", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "An array of emails to invite.", "complexTypes": [], "type": "string[] | undefined" }, { "name": "isAllDay", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | undefined" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "recurrence", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "Rules for creating a recurring event.", "complexTypes": [ "EventRecurrenceRule" ], "type": "EventRecurrenceRule" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "url", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "id", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "The ID of the event to be modified.", "complexTypes": [], "type": "string" } ] }, { "name": "CreateEventOptions", "slug": "createeventoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "alerts", "tags": [ { "text": "// -1440 -> 1 day before\n// -60 -> 1 hour before\n// 30 -> 30 minutes after\n[-1440, -60, 30]", "name": "example" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Alert times in minutes relative to the event start.\nUse negative numbers for alerts before the start, and positive numbers for alerts after the start.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "attendees", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "The event guests.", "complexTypes": [ "EventGuest" ], "type": "EventGuest[] | undefined" }, { "name": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability" }, { "name": "calendarId", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "color", "tags": [ { "text": "#6750A4", "name": "example" }, { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "commit", "tags": [ { "text": "true", "name": "default" }, { "text": "iOS", "name": "platform" }, { "text": "{", "name": "see" }, { "text": "CalendarOperations#commit}", "name": "link" }, { "text": "7.1.0", "name": "since" } ], "docs": "Whether to save immediately (`true`) or batch changes for later (`false`).", "complexTypes": [], "type": "boolean | undefined" }, { "name": "description", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "duration", "tags": [ { "text": "P1D (1 day), P3W (3 weeks), P2DT4H30M (2 days, 4 hours, and 30 minutes).", "name": "example" }, { "text": "Android", "name": "platform" }, { "text": "{", "name": "see" }, { "text": "https://datatracker.ietf.org/doc/html/rfc2445}", "name": "link" }, { "text": "7.1.0", "name": "since" } ], "docs": "Duration of the event in RFC2445 format.", "complexTypes": [], "type": "string | undefined" }, { "name": "endDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "isAllDay", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | undefined" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "organizer", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Email of the event organizer.", "complexTypes": [], "type": "string | undefined" }, { "name": "recurrence", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "Rules for creating a recurring event.", "complexTypes": [ "EventRecurrenceRule" ], "type": "EventRecurrenceRule" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.4.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "url", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "EventGuest", "slug": "eventguest", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "name", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "email", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" } ] }, { "name": "ModifyEventOptions", "slug": "modifyeventoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "alerts", "tags": [ { "text": "// -1440 -> 1 day before\n// -60 -> 1 hour before\n// 30 -> 30 minutes after\n[-1440, -60, 30]", "name": "example" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Alert times in minutes relative to the event start.\nUse negative numbers for alerts before the start, and positive numbers for alerts after the start.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "attendees", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "The event guests.", "complexTypes": [ "EventGuest" ], "type": "EventGuest[] | undefined" }, { "name": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability" }, { "name": "calendarId", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "color", "tags": [ { "text": "#6750A4", "name": "example" }, { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "description", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "duration", "tags": [ { "text": "P1D (1 day), P3W (3 weeks), P2DT4H30M (2 days, 4 hours, and 30 minutes).", "name": "example" }, { "text": "Android", "name": "platform" }, { "text": "{", "name": "see" }, { "text": "https://datatracker.ietf.org/doc/html/rfc2445}", "name": "link" }, { "text": "7.1.0", "name": "since" } ], "docs": "Duration of the event in RFC2445 format.", "complexTypes": [], "type": "string | undefined" }, { "name": "endDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "id", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "The ID of the event to be modified.", "complexTypes": [], "type": "string" }, { "name": "isAllDay", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | undefined" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "recurrence", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.3.0", "name": "since" } ], "docs": "Rules for creating a recurring event.", "complexTypes": [ "EventRecurrenceRule" ], "type": "EventRecurrenceRule" }, { "name": "organizer", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Email of the event organizer.", "complexTypes": [], "type": "string | undefined" }, { "name": "span", "tags": [ { "text": "EventSpan.THIS_EVENT", "name": "default" }, { "text": "iOS", "name": "platform" }, { "text": " 7.1.0", "name": "see" } ], "docs": "The span of modifications.", "complexTypes": [ "EventSpan" ], "type": "EventSpan" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.4.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "url", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "DeleteEventsByIdResult", "slug": "deleteeventsbyidresult", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "deleted", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string[]" }, { "name": "failed", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string[]" } ] }, { "name": "DeleteEventsByIdOptions", "slug": "deleteeventsbyidoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "ids", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string[]" }, { "name": "span", "tags": [ { "text": "EventSpan.THIS_EVENT", "name": "default" }, { "text": "iOS", "name": "platform" }, { "text": " 7.1.0", "name": "see" } ], "docs": "The span of deletion.", "complexTypes": [ "EventSpan" ], "type": "EventSpan" } ] }, { "name": "DeleteEventOptions", "slug": "deleteeventoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "span", "tags": [ { "text": "EventSpan.THIS_EVENT", "name": "default" }, { "text": "iOS", "name": "platform" }, { "text": " 7.1.0", "name": "see" } ], "docs": "The span of deletion.", "complexTypes": [ "EventSpan" ], "type": "EventSpan" } ] }, { "name": "DeleteEventWithPromptOptions", "slug": "deleteeventwithpromptoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "span", "tags": [ { "text": "EventSpan.THIS_EVENT", "name": "default" }, { "text": "iOS", "name": "platform" }, { "text": " 7.1.0", "name": "see" } ], "docs": "The span of deletion.", "complexTypes": [ "EventSpan" ], "type": "EventSpan" }, { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Title of the dialog.", "complexTypes": [], "type": "string" }, { "name": "message", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Message of the dialog.", "complexTypes": [], "type": "string" }, { "name": "confirmButtonText", "tags": [ { "text": "'Delete'", "name": "default" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Text to show on the confirm button.", "complexTypes": [], "type": "string | undefined" }, { "name": "cancelButtonText", "tags": [ { "text": "'Cancel'", "name": "default" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Text to show on the cancel button.", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "CalendarEvent", "slug": "calendarevent", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "calendarId", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number" }, { "name": "endDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number" }, { "name": "isAllDay", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean" }, { "name": "alerts", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Alert times in minutes relative to the event start.", "complexTypes": [], "type": "number[]" }, { "name": "url", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "description", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability | null" }, { "name": "organizer", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "color", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "duration", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "isDetached", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | null" }, { "name": "birthdayContactIdentifier", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "{", "name": "see" }, { "text": "https://developer.apple.com/documentation/eventkit/ekevent/birthdaycontactidentifier}", "name": "link" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "status", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventStatus" ], "type": "EventStatus | null" }, { "name": "creationDate", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | null" }, { "name": "lastModifiedDate", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | null" }, { "name": "attendees", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "AttendeeRole", "AttendeeStatus", "AttendeeType" ], "type": "{ email: string | null; name: string | null; role: AttendeeRole | null; status: AttendeeStatus | null; type: AttendeeType | null; }[]" }, { "name": "timezone", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" } ] }, { "name": "ListEventsInRangeOptions", "slug": "listeventsinrangeoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "from", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "The timestamp in milliseconds.", "complexTypes": [], "type": "number" }, { "name": "to", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "The timestamp in milliseconds.", "complexTypes": [], "type": "number" } ] }, { "name": "Calendar", "slug": "calendar", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "internalTitle", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Internal name of the calendar (`CalendarContract.Calendars.NAME`).", "complexTypes": [], "type": "string | null" }, { "name": "color", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "isImmutable", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | null" }, { "name": "allowsContentModifications", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | null" }, { "name": "type", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "CalendarType" ], "type": "CalendarType | null" }, { "name": "isSubscribed", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | null" }, { "name": "source", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "CalendarSource" ], "type": "CalendarSource | null" }, { "name": "visible", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Indicates if the events from this calendar should be shown.", "complexTypes": [], "type": "boolean | null" }, { "name": "accountName", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "The account under which the calendar is registered.", "complexTypes": [], "type": "string | null" }, { "name": "ownerAccount", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "The owner of the calendar.", "complexTypes": [], "type": "string | null" }, { "name": "maxReminders", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Maximum number of reminders allowed per event.", "complexTypes": [], "type": "number | null" }, { "name": "location", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" } ] }, { "name": "CalendarSource", "slug": "calendarsource", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "type", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "CalendarSourceType" ], "type": "CalendarSourceType" }, { "name": "id", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "title", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" } ] }, { "name": "SelectCalendarsWithPromptOptions", "slug": "selectcalendarswithpromptoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "displayStyle", "tags": [ { "text": "CalendarChooserDisplayStyle.ALL_CALENDARS", "name": "default" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "CalendarChooserDisplayStyle" ], "type": "CalendarChooserDisplayStyle" }, { "name": "multiple", "tags": [ { "text": "false", "name": "default" }, { "text": "7.1.0", "name": "since" } ], "docs": "Allow multiple selections.", "complexTypes": [], "type": "boolean | undefined" } ] }, { "name": "OpenCalendarOptions", "slug": "opencalendaroptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "date", "tags": [ { "text": "Date.now()", "name": "default" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number" } ] }, { "name": "CreateCalendarOptions", "slug": "createcalendaroptions", "docs": "", "tags": [ { "text": "5.2.0", "name": "since" } ], "methods": [], "properties": [ { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "5.2.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "color", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "#0000FF", "name": "example" }, { "text": "5.2.0", "name": "since" } ], "docs": "The color of the calendar.\nShould be provided on Android.", "complexTypes": [], "type": "string | undefined" }, { "name": "sourceId", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "5.2.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "accountName", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Only needed on Android. Typically set to an email address.", "complexTypes": [], "type": "string | undefined" }, { "name": "ownerAccount", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Only needed on Android. Typically set to an email address.", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "DeleteCalendarOptions", "slug": "deletecalendaroptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" } ] }, { "name": "ModifyCalendarOptions", "slug": "modifycalendaroptions", "docs": "", "tags": [ { "text": "7.2.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.2.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.2.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "color", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "#0000FF", "name": "example" }, { "text": "7.2.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "CreateReminderOptions", "slug": "createreminderoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "title", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "listId", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "priority", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "isCompleted", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | undefined" }, { "name": "startDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "dueDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "completionDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "notes", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "url", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "location", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "recurrence", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "RecurrenceRule" ], "type": "RecurrenceRule" }, { "name": "alerts", "tags": [ { "text": "// -1440 -> 1 day before\n// -60 -> 1 hour before\n// 30 -> 30 minutes after\n[-1440, -60, 30]", "name": "example" }, { "text": "7.1.0", "name": "since" } ], "docs": "Alert times in minutes relative to the reminder start.\nUse negative numbers for alerts before the start, and positive numbers for alerts after the start.", "complexTypes": [], "type": "number[] | undefined" } ] }, { "name": "RecurrenceRule", "slug": "recurrencerule", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "frequency", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "RecurrenceFrequency" ], "type": "RecurrenceFrequency" }, { "name": "interval", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "How often it repeats (e.g. 1 for every occurrence, 2 for every second occurrence).", "complexTypes": [], "type": "number" }, { "name": "end", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "Timestamp of when the recurrence ends.", "complexTypes": [], "type": "number | undefined" } ] }, { "name": "DeleteRemindersByIdResult", "slug": "deleteremindersbyidresult", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "deleted", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string[]" }, { "name": "failed", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string[]" } ] }, { "name": "DeleteRemindersByIdOptions", "slug": "deleteremindersbyidoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "ids", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string[]" } ] }, { "name": "DeleteReminderOptions", "slug": "deletereminderoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" } ] }, { "name": "ModifyReminderOptions", "slug": "modifyreminderoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "title", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "listId", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "priority", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "isCompleted", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean | undefined" }, { "name": "startDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "dueDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "completionDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "notes", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "url", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "location", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "recurrence", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "RecurrenceRule" ], "type": "RecurrenceRule" }, { "name": "alerts", "tags": [ { "text": "// -1440 -> 1 day before\n// -60 -> 1 hour before\n// 30 -> 30 minutes after\n[-1440, -60, 30]", "name": "example" }, { "text": "7.1.0", "name": "since" } ], "docs": "Alert times in minutes relative to the reminder start.\nUse negative numbers for alerts before the start, and positive numbers for alerts after the start.\n\nOn iOS only 2 alerts are supported.", "complexTypes": [], "type": "number[] | undefined" } ] }, { "name": "Reminder", "slug": "reminder", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "title", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "listId", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "isCompleted", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "boolean" }, { "name": "priority", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | null" }, { "name": "notes", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "location", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "url", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | null" }, { "name": "startDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | null" }, { "name": "dueDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | null" }, { "name": "completionDate", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | null" }, { "name": "recurrence", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "RecurrenceRule" ], "type": "RecurrenceRule[]" }, { "name": "alerts", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number[]" } ] }, { "name": "GetReminderByIdOptions", "slug": "getreminderbyidoptions", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" } ] }, { "name": "GetRemindersFromListsOptions", "slug": "getremindersfromlistsoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "listIds", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string[]" } ] }, { "name": "DeleteReminderWithPromptOptions", "slug": "deletereminderwithpromptoptions", "docs": "", "tags": [ { "text": "7.2.0", "name": "since" } ], "methods": [], "properties": [ { "name": "id", "tags": [ { "text": "7.2.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "title", "tags": [ { "text": "7.2.0", "name": "since" } ], "docs": "Title of the dialog.", "complexTypes": [], "type": "string" }, { "name": "message", "tags": [ { "text": "7.2.0", "name": "since" } ], "docs": "Message of the dialog.", "complexTypes": [], "type": "string" }, { "name": "confirmButtonText", "tags": [ { "text": "'Delete'", "name": "default" }, { "text": "7.2.0", "name": "since" } ], "docs": "Text to show on the confirm button.", "complexTypes": [], "type": "string | undefined" }, { "name": "cancelButtonText", "tags": [ { "text": "'Cancel'", "name": "default" }, { "text": "7.2.0", "name": "since" } ], "docs": "Text to show on the cancel button.", "complexTypes": [], "type": "string | undefined" } ] } ], "enums": [ { "name": "CalendarPermissionScope", "slug": "calendarpermissionscope", "members": [ { "name": "READ_CALENDAR", "value": "'readCalendar'", "tags": [ { "text": "| Platform | Required |\n|-----------|---------------------|\n| iOS 17+ | `NSCalendarsFullAccessUsageDescription` |\n| iOS 13-16 | `NSCalendarsUsageDescription` |\n| Android | `android.permission.READ_CALENDAR` |", "name": "permissions" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Permission required for reading calendar events." }, { "name": "READ_REMINDERS", "value": "'readReminders'", "tags": [ { "text": "| Platform | Required |\n|-----------|---------------------|\n| iOS 17+ | `NSRemindersFullAccessUsageDescription` |\n| iOS 10-16 | `NSRemindersUsageDescription` |", "name": "permissions" }, { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Permission required for reading reminders." }, { "name": "WRITE_CALENDAR", "value": "'writeCalendar'", "tags": [ { "text": "| Platform | Required |\n|-----------|---------------------|\n| iOS 17+ | `NSCalendarsWriteOnlyAccessUsageDescription` |\n| iOS 13-16 | `NSCalendarsUsageDescription` |\n| Android | `android.permission.WRITE_CALENDAR` |", "name": "permissions" }, { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Permission required for adding or modifying calendar events." }, { "name": "WRITE_REMINDERS", "value": "'writeReminders'", "tags": [ { "text": "| Platform | Required |\n|-----------|---------------------|\n| iOS 17+ | `NSRemindersFullAccessUsageDescription` |\n| iOS 13-16 | `NSRemindersUsageDescription` |", "name": "permissions" }, { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Permission required for adding or modifying reminders." } ] }, { "name": "EventAvailability", "slug": "eventavailability", "members": [ { "name": "NOT_SUPPORTED", "value": "-1", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "BUSY", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "FREE", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "TENTATIVE", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "UNAVAILABLE", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" } ] }, { "name": "EventSpan", "slug": "eventspan", "members": [ { "name": "THIS_EVENT", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "THIS_AND_FUTURE_EVENTS", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" } ] }, { "name": "EventStatus", "slug": "eventstatus", "members": [ { "name": "NONE", "value": "'none'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "CONFIRMED", "value": "'confirmed'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "TENTATIVE", "value": "'tentative'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "CANCELED", "value": "'canceled'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" } ] }, { "name": "AttendeeRole", "slug": "attendeerole", "members": [ { "name": "UNKNOWN", "value": "'unknown'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "REQUIRED", "value": "'required'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "OPTIONAL", "value": "'optional'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "CHAIR", "value": "'chair'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "NON_PARTICIPANT", "value": "'nonParticipant'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "ATTENDEE", "value": "'attendee'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "ORGANIZER", "value": "'organizer'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "PERFORMER", "value": "'performer'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "SPEAKER", "value": "'speaker'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" } ] }, { "name": "AttendeeStatus", "slug": "attendeestatus", "members": [ { "name": "NONE", "value": "'none'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "ACCEPTED", "value": "'accepted'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "DECLINED", "value": "'declined'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "INVITED", "value": "'invited'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "UNKNOWN", "value": "'unknown'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "PENDING", "value": "'pending'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "TENTATIVE", "value": "'tentative'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "DELEGATED", "value": "'delegated'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "COMPLETED", "value": "'completed'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "IN_PROCESS", "value": "'inProcess'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" } ] }, { "name": "AttendeeType", "slug": "attendeetype", "members": [ { "name": "UNKNOWN", "value": "'unknown'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "PERSON", "value": "'person'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "ROOM", "value": "'room'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "RESOURCE", "value": "'resource'", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "GROUP", "value": "'group'", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "REQUIRED", "value": "'required'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "NONE", "value": "'none'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "OPTIONAL", "value": "'optional'", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "" } ] }, { "name": "CalendarType", "slug": "calendartype", "members": [ { "name": "LOCAL", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "CAL_DAV", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "EXCHANGE", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "SUBSCRIPTION", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "BIRTHDAY", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" } ] }, { "name": "CalendarSourceType", "slug": "calendarsourcetype", "members": [ { "name": "LOCAL", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "EXCHANGE", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "CAL_DAV", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "MOBILE_ME", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "SUBSCRIBED", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" }, { "name": "BIRTHDAYS", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "" } ] }, { "name": "CalendarChooserDisplayStyle", "slug": "calendarchooserdisplaystyle", "members": [ { "name": "ALL_CALENDARS", "tags": [ { "text": "0.2.0", "name": "since" } ], "docs": "" }, { "name": "WRITABLE_CALENDARS_ONLY", "tags": [ { "text": "0.2.0", "name": "since" } ], "docs": "" } ] } ], "typeAliases": [ { "name": "PermissionState", "slug": "permissionstate", "docs": "", "types": [ { "text": "'prompt'", "complexTypes": [] }, { "text": "'prompt-with-rationale'", "complexTypes": [] }, { "text": "'granted'", "complexTypes": [] }, { "text": "'denied'", "complexTypes": [] } ] }, { "name": "CheckAllPermissionsResult", "slug": "checkallpermissionsresult", "docs": "", "types": [ { "text": "Record", "complexTypes": [ "Record", "CalendarPermissionScope", "PermissionState" ] } ] }, { "name": "Record", "slug": "record", "docs": "Construct a type with a set of properties K of type T", "types": [ { "text": "{\r\n [P in K]: T;\r\n}", "complexTypes": [ "K", "T" ] } ] }, { "name": "RequestAllPermissionsResult", "slug": "requestallpermissionsresult", "docs": "", "types": [ { "text": "CheckAllPermissionsResult", "complexTypes": [ "CheckAllPermissionsResult" ] } ] }, { "name": "RecurrenceFrequency", "slug": "recurrencefrequency", "docs": "", "types": [ { "text": "'daily'", "complexTypes": [] }, { "text": "'weekly'", "complexTypes": [] }, { "text": "'monthly'", "complexTypes": [] }, { "text": "'yearly'", "complexTypes": [] } ] }, { "name": "EventEditAction", "slug": "eventeditaction", "docs": "", "types": [ { "text": "'canceled'", "complexTypes": [] }, { "text": "'saved'", "complexTypes": [] }, { "text": "'deleted'", "complexTypes": [] } ] }, { "name": "RemindersList", "slug": "reminderslist", "docs": "", "types": [ { "text": "Calendar", "complexTypes": [ "Calendar" ] } ] } ], "pluginConfigs": [] }