Calendar

Improve this doc

This plugin allows you to add events to the Calendar of the mobile device.

Requires Cordova plugin: cordova-plugin-calendar. For more info, please see the Calendar plugin docs.

Repo: https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-calendar
   $ npm install --save @ionic-native/calendar@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS

Usage

import { Calendar } from '@ionic-native/calendar';

constructor(private calendar: Calendar) { }


this.calendar.createCalendar('MyCalendar').then(
  (msg) => { console.log(msg); },
  (err) => { console.log(err); }
);

Instance Members

hasReadWritePermission()

This function checks if we have permission to read/write from/to the calendar. The promise will resolve with true when:

• You’re running on iOS, or
• You’re targeting API level lower than 23, or
• You’re using Android < 6, or
• You’ve already granted permission

If this returns false, you should call the requestReadWritePermission function

hasReadPermission()

Check if we have read permission

hasWritePermission()

Check if we have write permission

requestWritePermission()

Request write permission

requestReadPermission()

Request read permission

requestReadWritePermission()

Requests read/write permissions

createCalendar(nameOrOptions)

Create a calendar. (iOS only)

deleteCalendar(name)

Delete a calendar. (iOS only)

getCalendarOptions()

Returns the default calendar options.

getCreateCalendarOptions()

Returns options for a custom calender with specific color

createEvent(title, location, notes, startDate, endDate)

Silently create an event.

createEventWithOptions(title, location, notes, startDate, endDate, options)

Silently create an event with additional options.

createEventInteractively(title, location, notes, startDate, endDate)

Interactively create an event.

createEventInteractivelyWithOptions(title, location, notes, startDate, endDate, options)

Interactively create an event with additional options.

findEvent(title, location, notes, startDate, endDate)

Find an event.

findEventWithOptions(title, location, notes, startDate, endDate, options)

Find an event with additional options.

listEventsInRange(startDate, endDate)

Platforms:Android 

Find a list of events within the specified date range. (Android only)

listCalendars()

Get a list of all calendars.

findAllEventsInNamedCalendar()

Platforms:iOS 

Get a list of all future events in the specified calendar. (iOS only)

modifyEvent(title, location, notes, startDate, endDate, newTitle, newLocation, newNotes, newStartDate, newEndDate)

Platforms:iOS 

Modify an event. (iOS only)

modifyEventWithOptions(title, location, notes, startDate, endDate, newTitle, newLocation, newNotes, newStartDate, newEndDate, filterOptions, newOptions)

Platforms:iOS 

Modify an event with additional options. (iOS only)

deleteEvent(title, location, notes, startDate, endDate)

Delete an event.

deleteEventFromNamedCalendar(title, location, notes, startDate, endDate, calendarName)

Platforms:iOS 

Delete an event from the specified Calendar. (iOS only)

openCalendar(date)

Open the calendar at the specified date.

CalendarOptions

NameOrOptions