@ebarooni/capacitor-calendar

{ "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<void>", "parameters": [ { "name": "options", "docs": "", "type": "ModifyEventOptions" } ], "returns": "Promise<void>", "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<void>", "parameters": [ { "name": "options", "docs": "", "type": "DeleteEventOptions" } ], "returns": "Promise<void>", "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<void>", "parameters": [], "returns": "Promise<void>", "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<void>", "parameters": [ { "name": "options", "docs": "", "type": "OpenCalendarOptions | undefined" } ], "returns": "Promise<void>", "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<void>", "parameters": [ { "name": "options", "docs": "", "type": "DeleteCalendarOptions" } ], "returns": "Promise<void>", "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<void>", "parameters": [ { "name": "options", "docs": "", "type": "ModifyCalendarOptions" } ], "returns": "Promise<void>", "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<void>", "parameters": [], "returns": "Promise<void>", "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<void>", "parameters": [ { "name": "options", "docs": "", "type": "DeleteReminderOptions" } ], "returns": "Promise<void>", "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<void>", "parameters": [ { "name": "options", "docs": "", "type": "ModifyReminderOptions" } ], "returns": "Promise<void>", "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": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "calendarId", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | 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": "alerts", "tags": [ { "text": "// 10mins before and 30mins after the event\nconst alerts: [-10, 30]", "name": "example" }, { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Sets alerts before or after the start of the event in minutes.\nOn iOS only 2 alerts are supported.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "url", "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": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability" }, { "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": "ModifyEventWithPromptOptions", "slug": "modifyeventwithpromptoptions", "docs": "", "tags": [ { "text": "7.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "calendarId", "tags": [ { "text": "iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | 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": "alerts", "tags": [ { "text": "// 10mins before and 30mins after the event\nconst alerts: [-10, 30]", "name": "example" }, { "text": "iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Sets alerts before or after the start of the event in minutes.\nOn iOS only 2 alerts are supported.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "url", "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": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability" }, { "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": "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": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.4.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string" }, { "name": "calendarId", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | 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": "alerts", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number[] | undefined" }, { "name": "url", "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": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability" }, { "name": "organizer", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Email of the event organizer.", "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": "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": "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": "attendees", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "The event guests.", "complexTypes": [ "EventGuest" ], "type": "EventGuest[] | 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": "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": "title", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.4.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "calendarId", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "location", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "string | undefined" }, { "name": "startDate", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "0.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number | 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": "alerts", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [], "type": "number[] | undefined" }, { "name": "url", "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": "availability", "tags": [ { "text": "Android, iOS", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "", "complexTypes": [ "EventAvailability" ], "type": "EventAvailability" }, { "name": "organizer", "tags": [ { "text": "Android", "name": "platform" }, { "text": "7.1.0", "name": "since" } ], "docs": "Email of the event organizer.", "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": "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": [],