Interface CapacitorCalendarPlugin

interface CapacitorCalendarPlugin {
    checkAllPermissions(): Promise<{
        result: CheckAllPermissionsResult;
    }>;
    checkPermission(options: {
        scope: CalendarPermissionScope;
    }): Promise<{
        result: PermissionState;
    }>;
    commit(): Promise<void>;
    createCalendar(options: CreateCalendarOptions): Promise<{
        id: string;
    }>;
    createEvent(options: CreateEventOptions): Promise<{
        id: string;
    }>;
    createEventWithPrompt(options?: CreateEventWithPromptOptions): Promise<{
        id: null | string;
    }>;
    createReminder(options: CreateReminderOptions): Promise<{
        id: string;
    }>;
    deleteCalendar(options: DeleteCalendarOptions): Promise<void>;
    deleteEvent(options: DeleteEventOptions): Promise<void>;
    deleteEventWithPrompt(options: DeleteEventWithPromptOptions): Promise<{
        deleted: boolean;
    }>;
    deleteEventsById(options: DeleteEventsByIdOptions): Promise<{
        result: DeleteEventsByIdResult;
    }>;
    deleteReminder(options: DeleteReminderOptions): Promise<void>;
    deleteReminderWithPrompt(options: DeleteReminderWithPromptOptions): Promise<{
        deleted: boolean;
    }>;
    deleteRemindersById(options: DeleteRemindersByIdOptions): Promise<{
        result: DeleteRemindersByIdResult;
    }>;
    fetchAllCalendarSources(): Promise<{
        result: CalendarSource[];
    }>;
    fetchAllRemindersSources(): Promise<{
        result: CalendarSource[];
    }>;
    getDefaultCalendar(): Promise<{
        result: null | Calendar;
    }>;
    getDefaultRemindersList(): Promise<{
        result: null | Calendar;
    }>;
    getReminderById(options: GetReminderByIdOptions): Promise<{
        result: null | Reminder;
    }>;
    getRemindersFromLists(options: GetRemindersFromListsOptions): Promise<{
        result: Reminder[];
    }>;
    getRemindersLists(): Promise<{
        result: Calendar[];
    }>;
    listCalendars(): Promise<{
        result: Calendar[];
    }>;
    listEventsInRange(options: ListEventsInRangeOptions): Promise<{
        result: CalendarEvent[];
    }>;
    modifyCalendar(options: ModifyCalendarOptions): Promise<void>;
    modifyEvent(options: ModifyEventOptions): Promise<void>;
    modifyEventWithPrompt(options: ModifyEventWithPromptOptions): Promise<{
        result: null | EventEditAction;
    }>;
    modifyReminder(options: ModifyReminderOptions): Promise<void>;
    openCalendar(options?: OpenCalendarOptions): Promise<void>;
    openReminders(): Promise<void>;
    requestAllPermissions(): Promise<{
        result: CheckAllPermissionsResult;
    }>;
    requestFullCalendarAccess(): Promise<{
        result: PermissionState;
    }>;
    requestFullRemindersAccess(): Promise<{
        result: PermissionState;
    }>;
    requestPermission(options: {
        scope: CalendarPermissionScope;
    }): Promise<{
        result: PermissionState;
    }>;
    requestReadOnlyCalendarAccess(): Promise<{
        result: PermissionState;
    }>;
    requestWriteOnlyCalendarAccess(): Promise<{
        result: PermissionState;
    }>;
    selectCalendarsWithPrompt(options?: SelectCalendarsWithPromptOptions): Promise<{
        result: Calendar[];
    }>;
}

Hierarchy

  • CalendarAccess
  • RemindersAccess
  • EventOperations
  • CalendarOperations
  • RemindersOperations
    • CapacitorCalendarPlugin

Methods

checkAllPermissions checkPermission commit createCalendar createEvent createEventWithPrompt createReminder deleteCalendar deleteEvent deleteEventWithPrompt deleteEventsById deleteReminder deleteReminderWithPrompt deleteRemindersById fetchAllCalendarSources fetchAllRemindersSources getDefaultCalendar getDefaultRemindersList getReminderById getRemindersFromLists getRemindersLists listCalendars listEventsInRange modifyCalendar modifyEvent modifyEventWithPrompt modifyReminder openCalendar openReminders requestAllPermissions requestFullCalendarAccess requestFullRemindersAccess requestPermission requestReadOnlyCalendarAccess requestWriteOnlyCalendarAccess selectCalendarsWithPrompt

Methods

checkAllPermissions

checkPermission

  • checkPermission(options): Promise<{
        result: PermissionState;
    }>

  • Retrieves the current permission state for a given scope.

    Parameters

    Returns Promise<{
        result: PermissionState;
    }>

    Example

    CapacitorCalendar.checkPermission({ scope: CalendarPermissionScope.READ_CALENDAR });

    Platform

    Android, iOS

    Since

    0.1.0

commit

createCalendar

createEvent

  • createEvent(options): Promise<{
        id: string;
    }>

  • Creates an event in the calendar.

    Parameters

    Returns Promise<{
        id: string;
    }>

    Platform

    iOS, Android

    Since

    0.4.0

createEventWithPrompt

  • createEventWithPrompt(options?): Promise<{
        id: null | string;
    }>

  • Opens the system calendar interface to create a new event. On Android always returns null. Fetch the events to find the ID of the newly created event.

    Parameters

    Returns Promise<{
        id: null | string;
    }>

    Example

    const options = {
      title: 'Test event',
      startDate: Date.now(),
    }
    await CapacitorCalendar.createEventWithPrompt(options)

    Platform

    Android, iOS

    Since

    0.1.0

createReminder

deleteCalendar

deleteEvent

deleteEventWithPrompt

  • deleteEventWithPrompt(options): Promise<{
        deleted: boolean;
    }>

  • Opens a dialog to delete an event.

    Parameters

    Returns Promise<{
        deleted: boolean;
    }>

    Platform

    Android, iOS

    Since

    7.1.0

deleteEventsById

deleteReminder

deleteReminderWithPrompt

deleteRemindersById

fetchAllCalendarSources

fetchAllRemindersSources

  • fetchAllRemindersSources(): Promise<{
        result: CalendarSource[];
    }>

  • Retrieves a list of calendar sources.

    Returns Promise<{
        result: CalendarSource[];
    }>

    Deprecated

    Duplicates CalendarOperations#fetchAllCalendarSources

    Platform

    iOS

    Since

    6.6.0

getDefaultCalendar

  • getDefaultCalendar(): Promise<{
        result: null | Calendar;
    }>

  • Retrieves the default calendar.

    Returns Promise<{
        result: null | Calendar;
    }>

    Platform

    Android, iOS

    Since

    0.3.0

getDefaultRemindersList

  • getDefaultRemindersList(): Promise<{
        result: null | Calendar;
    }>

  • Retrieves the default reminders list.

    Returns Promise<{
        result: null | Calendar;
    }>

    Platform

    iOS

    Since

    7.1.0

getReminderById

getRemindersFromLists

getRemindersLists

listCalendars

listEventsInRange

modifyCalendar

modifyEvent

modifyEventWithPrompt

  • modifyEventWithPrompt(options): Promise<{
        result: null | EventEditAction;
    }>

  • Opens a system calendar interface to modify an event. On Android always returns null.

    Parameters

    Returns Promise<{
        result: null | EventEditAction;
    }>

    Example

    const options = {
      id: 'EVENT_ID',
      title: 'New title',
    }
    await CapacitorCalendar.modifyEventWithPrompt(options);

    Platform

    Android, iOS

    Since

    6.6.0

modifyReminder

openCalendar

  • openCalendar(options?): Promise<void>

  • Opens the calendar app.

    Parameters

    Returns Promise<void>

    Example

    CapacitorCalendar.openCalendar({ date: Date.now() });

    Platform

    Android, iOS

    Since

    7.1.0

openReminders

requestAllPermissions

requestFullCalendarAccess

  • requestFullCalendarAccess(): Promise<{
        result: PermissionState;
    }>

  • Requests read and write access to the calendar.

    Returns Promise<{
        result: PermissionState;
    }>

    Permissions

    Platform Required
    iOS 17+ NSCalendarsFullAccessUsageDescription
    iOS 13-16 NSCalendarsUsageDescription
    Android android.permission.READ_CALENDAR & android.permission.WRITE_CALENDAR

    Platform

    Android, iOS

    Since

    5.4.0

requestFullRemindersAccess

  • requestFullRemindersAccess(): Promise<{
        result: PermissionState;
    }>

  • Requests read and write access to the reminders.

    Returns Promise<{
        result: PermissionState;
    }>

    Permissions

    Platform Required
    iOS 17+ NSRemindersFullAccessUsageDescription
    iOS 10-16 NSRemindersUsageDescription

    Platform

    iOS

    See

    CalendarPermissionScope

    Since

    5.4.0

requestPermission

requestReadOnlyCalendarAccess

  • requestReadOnlyCalendarAccess(): Promise<{
        result: PermissionState;
    }>

  • Requests read access to the calendar.

    Returns Promise<{
        result: PermissionState;
    }>

    Permissions

    Platform Required
    Android android.permission.READ_CALENDAR

    Platform

    Android

    Since

    5.4.0

requestWriteOnlyCalendarAccess

  • requestWriteOnlyCalendarAccess(): Promise<{
        result: PermissionState;
    }>

  • Requests write access to the calendar.

    Returns Promise<{
        result: PermissionState;
    }>

    Permissions

    Platform Required
    iOS 17+ NSCalendarsWriteOnlyAccessUsageDescription
    iOS 13-16 NSCalendarsUsageDescription
    Android android.permission.WRITE_CALENDAR

    Platform

    Android, iOS

    Since

    5.4.0

selectCalendarsWithPrompt

Settings

Member Visibility

On This Page

Methods