@ebarooni/capacitor-calendar
    Preparing search index...

    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: string | null }>;
        createReminder(options: CreateReminderOptions): Promise<{ id: string }>;
        deleteCalendar(options: DeleteCalendarOptions): Promise<void>;
        deleteEvent(options: DeleteEventOptions): Promise<void>;
        deleteEventsById(
            options: DeleteEventsByIdOptions,
        ): Promise<{ result: DeleteEventsByIdResult }>;
        deleteEventWithPrompt(
            options: DeleteEventWithPromptOptions,
        ): Promise<{ deleted: boolean }>;
        deleteReminder(options: DeleteReminderOptions): Promise<void>;
        deleteRemindersById(
            options: DeleteRemindersByIdOptions,
        ): Promise<{ result: DeleteRemindersByIdResult }>;
        deleteReminderWithPrompt(
            options: DeleteReminderWithPromptOptions,
        ): Promise<{ deleted: boolean }>;
        fetchAllCalendarSources(): Promise<{ result: CalendarSource[] }>;
        fetchAllRemindersSources(): Promise<{ result: CalendarSource[] }>;
        getDefaultCalendar(): Promise<{ result: Calendar | null }>;
        getDefaultRemindersList(): Promise<{ result: Calendar | null }>;
        getReminderById(
            options: GetReminderByIdOptions,
        ): Promise<{ result: Reminder | null }>;
        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: EventEditAction | null }>;
        modifyReminder(options: ModifyReminderOptions): Promise<void>;
        openCalendar(options?: OpenCalendarOptions): Promise<void>;
        openReminders(): Promise<void>;
        requestAllPermissions(): Promise<{ result: RequestAllPermissionsResult }>;
        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
    Index

    Methods

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

    Methods

    • Retrieves the current permission state for a given scope.

      Parameters

      Returns Promise<{ result: PermissionState }>

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

      Android, iOS

      0.1.0

    • 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: string | null }>

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

      Android, iOS

      0.1.0

    • Requests read and write access to the calendar.

      Returns Promise<{ result: PermissionState }>

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

      Android, iOS

      5.4.0

    • Requests read and write access to the reminders.

      Returns Promise<{ result: PermissionState }>

      Platform Required
      iOS 17+ NSRemindersFullAccessUsageDescription
      iOS 10-16 NSRemindersUsageDescription

      iOS

      CalendarPermissionScope

      5.4.0

    • Requests read access to the calendar.

      Returns Promise<{ result: PermissionState }>

      Platform Required
      Android android.permission.READ_CALENDAR

      Android

      5.4.0

    • Requests write access to the calendar.

      Returns Promise<{ result: PermissionState }>

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

      Android, iOS

      5.4.0

    Settings

    Member Visibility

    On This Page

    Methods