Calendar

Installation

Configuration

Example Usage

import React, { useEffect } from 'react';
import { View, Text, Button, Platform } from 'react-native';
import * as Calendar from 'expo-calendar';

export default function App() {
  useEffect(() => {
    (async () => {
      const { status } = await Calendar.requestCalendarPermissionsAsync();
      if (status === 'granted') {
        const calendars = await Calendar.getCalendarsAsync();
        console.log('Here are all your calendars:');
        console.log({ calendars });
      }
    })();
  }, []);

  return (
    <View
      style={{
        flex: 1,
        backgroundColor: '#fff',
        alignItems: 'center',
        justifyContent: 'space-around',
      }}>
      <Text>Calendar Module Example</Text>
      <Button title="Create a new calendar" onPress={createCalendar} />
    </View>
  );
}

async function getDefaultCalendarSource() {
  const calendars = await Calendar.getCalendarsAsync();
  const defaultCalendars = calendars.filter(each => each.source.name === 'Default');
  return defaultCalendars[0].source;
}

async function createCalendar() {
  const defaultCalendarSource =
    Platform.OS === 'ios'
      ? await getDefaultCalendarSource()
      : { isLocalAccount: true, name: 'Expo Calendar' };
  const newCalendarID = await Calendar.createCalendarAsync({
    title: 'Expo Calendar',
    color: 'blue',
    entityType: Calendar.EntityTypes.EVENT,
    sourceId: defaultCalendarSource.id,
    source: defaultCalendarSource,
    name: 'internalCalendarName',
    ownerAccount: 'personal',
    accessLevel: Calendar.CalendarAccessLevel.OWNER,
  });
  console.log(`Your new calendar ID is: ${newCalendarID}`);
}

API

import * as Calendar from 'expo-calendar';

Methods

Calendar.getCalendarsAsync(entityType)

Arguments

• entityType (string) -- (iOS only) Not required, but if defined, filters the returned calendars to a specific entity type. Possible values are Calendar.EntityTypes.EVENT (for calendars shown in the Calendar app) and Calendar.EntityTypes.REMINDER (for the Reminders app).

Returns

Calendar.getDefaultCalendarAsync()

Returns

Calendar.requestCalendarPermissionsAsync()

Returns

Calendar.requestRemindersPermissionsAsync()

Returns

Calendar.getCalendarPermissionsAsync()

Returns

Calendar.getRemindersPermissionsAsync()

Returns

Calendar.createCalendarAsync(details)

Arguments

• details (object) --
  A map of details for the calendar to be created (see below for a description of these fields):
  • title (string) -- Required
  • color (string) -- Required
  • entityType (string) -- Required (iOS only)
  • sourceId (string) -- (iOS only) ID of the source to be used for the calendar. Likely the same as the source for any other locally stored calendars.
  • source (object) -- Required (Android only). Object representing the source to be used for the calendar.
    • isLocalAccount (boolean) -- Whether this source is the local phone account. Must be true if type is undefined.
    • name (string) -- Required. Name for the account that owns this calendar and was used to sync the calendar to the device.
    • type (string) -- Type of the account that owns this calendar and was used to sync it to the device. If isLocalAccount is falsy then this must be defined, and must match an account on the device along with name, or the OS will delete the calendar.
  • name (string) -- Required (Android only)
  • ownerAccount (string) -- Required (Android only)
  • timeZone (string) -- (Android only)
  • allowedAvailabilities (array) -- (Android only)
  • allowedReminders (array) -- (Android only)
  • allowedAttendeeTypes (array) -- (Android only)
  • isVisible (boolean) -- (Android only)
  • isSynced (boolean) -- (Android only) Whether or not the calendar is synced from a remote source. Unexpected behavior may occur if this is not set to true.
  • accessLevel (string) -- (Android only)

Returns

Calendar.updateCalendarAsync(id, details)

Arguments

• id (string) -- ID of the calendar to update. Required.
• details (object) --
  A map of properties to be updated (see below for a description of these fields):
  • title (string)
  • sourceId (string) -- (iOS only)
  • color (string) -- (iOS only)
  • name (string) -- (Android only)
  • isVisible (boolean) -- (Android only)
  • isSynced (boolean) -- (Android only)

Calendar.deleteCalendarAsync(id)

Arguments

• id (string) -- ID of the calendar to delete.

Calendar.getEventsAsync(calendarIds, startDate, endDate)

Arguments

• calendarIds (array) -- Array of IDs of calendars to search for events in. Required.
• startDate (Date) -- Beginning of time period to search for events in. Required.
• endDate (Date) -- End of time period to search for events in. Required.

Returns

Calendar.getEventAsync(id, recurringEventOptions)

Arguments

• id (string) -- ID of the event to return. Required.
• recurringEventOptions (object) --
  A map of options for recurring events:
  • instanceStartDate (Date) -- Date object representing the start time of the desired instance, if looking for a single instance of a recurring event. If this is not provided and id represents a recurring event, the first instance of that event will be returned by default.

Returns

Calendar.createEventAsync(calendarId, details)

Arguments

• calendarId (string) -- ID of the calendar to create this event in. Required.
• details (object) --
  A map of details for the event to be created (see below for a description of these fields):
  • title (string)
  • startDate (Date) -- Required.
  • endDate (Date) -- Required.
  • allDay (boolean)
  • location (string)
  • notes (string)
  • alarms (Array\<Alarm>)
  • recurrenceRule (RecurrenceRule)
  • availability (string)
  • timeZone (string) -- Required on Android.
  • endTimeZone (string) -- (Android only)
  • url (string) -- (iOS only)
  • organizerEmail (string) -- (Android only)
  • accessLevel (string) -- (Android only)
  • guestsCanModify (boolean) -- (Android only)
  • guestsCanInviteOthers (boolean) -- (Android only)
  • guestsCanSeeGuests (boolean) -- (Android only)

Returns

Calendar.updateEventAsync(id, details, recurringEventOptions)

Arguments

• id (string) -- ID of the event to be updated. Required.
• details (object) --
  A map of properties to be updated (see below for a description of these fields):
  • title (string)
  • startDate (Date)
  • endDate (Date)
  • allDay (boolean)
  • location (string)
  • notes (string)
  • alarms (Array\<Alarm>)
  • recurrenceRule (RecurrenceRule)
  • availability (string)
  • timeZone (string)
  • endTimeZone (string) -- (Android only)
  • url (string) -- (iOS only)
  • organizerEmail (string) -- (Android only)
  • accessLevel (string) -- (Android only)
  • guestsCanModify (boolean) -- (Android only)
  • guestsCanInviteOthers (boolean) -- (Android only)
  • guestsCanSeeGuests (boolean) -- (Android only)
• recurringEventOptions (object) --
  A map of options for recurring events:
  • instanceStartDate (Date) -- Date object representing the start time of the desired instance, if wanting to update a single instance of a recurring event. If this is not provided and id represents a recurring event, the first instance of that event will be updated by default.
  • futureEvents (boolean) -- Whether or not future events in the recurring series should also be updated. If true, will apply the given changes to the recurring instance specified by instanceStartDate and all future events in the series. If false, will only apply the given changes to the instance specified by instanceStartDate.

Calendar.deleteEventAsync(id, recurringEventOptions)

Arguments

• id (string) -- ID of the event to be deleted. Required.
• recurringEventOptions (object) --
  A map of options for recurring events:
  • instanceStartDate (Date) -- Date object representing the start time of the desired instance, if wanting to delete a single instance of a recurring event. If this is not provided and id represents a recurring event, the first instance of that event will be deleted by default.
  • futureEvents (boolean) -- Whether or not future events in the recurring series should also be deleted. If true, will delete the instance specified by instanceStartDate and all future events in the series. If false, will only delete the instance specified by instanceStartDate.

Calendar.getAttendeesForEventAsync(eventId, recurringEventOptions)

Arguments

• eventId (string) -- ID of the event to return attendees for. Required.
• recurringEventOptions (object) --
  A map of options for recurring events:
  • instanceStartDate (Date) -- Date object representing the start time of the desired instance, if looking for a single instance of a recurring event. If this is not provided and eventId represents a recurring event, the attendees of the first instance of that event will be returned by default.

Returns

Calendar.createAttendeeAsync(eventId, details)

Arguments

• eventId (string) -- ID of the event to add this attendee to. Required.
• details (object) --
  A map of details for the attendee to be created (see below for a description of these fields):
  • id (string) Required.
  • email (string) Required.
  • name (string)
  • role (string) Required.
  • status (string) Required.
  • type (string) Required.

Returns

Calendar.updateAttendeeAsync(id, details)

Arguments

• id (string) -- ID of the attendee record to be updated. Required.
• details (object) --
  A map of properties to be updated (see below for a description of these fields):
  • id (string)
  • email (string)
  • name (string)
  • role (string)
  • status (string)
  • type (string)

Calendar.deleteAttendeeAsync(id)

Arguments

• id (string) -- ID of the attendee to delete.

Calendar.getRemindersAsync(calendarIds, status, startDate, endDate)

Arguments

• calendarIds (array) -- Array of IDs of calendars to search for reminders in. Required.
• status (string) -- One of Calendar.ReminderStatus.COMPLETED or Calendar.ReminderStatus.INCOMPLETE.
• startDate (Date) -- Beginning of time period to search for reminders in. Required if status is defined.
• endDate (Date) -- End of time period to search for reminders in. Required if status is defined.

Returns

Calendar.getReminderAsync(id)

Arguments

• id (string) -- ID of the reminder to return. Required.

Returns

Calendar.createReminderAsync(calendarId, details)

Arguments

• calendarId (string) -- ID of the calendar to create this reminder in (or null to add the calendar to the OS-specified default calendar for reminders). Required.
• details (object) --
  A map of details for the reminder to be created: (see below for a description of these fields)
  • title (string)
  • startDate (Date)
  • dueDate (Date)
  • completed (boolean)
  • completionDate (Date)
  • location (string)
  • notes (string)
  • alarms (array)
  • recurrenceRule (RecurrenceRule)
  • timeZone (string)
  • url (string)

Returns

Calendar.updateReminderAsync(id, details)

Arguments

• id (string) -- ID of the reminder to be updated. Required.
• details (object) --
  A map of properties to be updated (see below for a description of these fields):
  • title (string)
  • startDate (Date)
  • dueDate (Date)
  • completionDate (Date) -- Setting this property of a nonnull Date will automatically set the reminder's completed value to true.
  • location (string)
  • notes (string)
  • alarms (array)
  • recurrenceRule (RecurrenceRule)
  • timeZone (string)
  • url (string)

Calendar.deleteReminderAsync(id)

Arguments

• id (string) -- ID of the reminder to be deleted. Required.

Calendar.getSourcesAsync()

Returns

Calendar.getSourceAsync(id)

Arguments

• id (string) -- ID of the source to return. Required.

Returns

Calendar.openEventInCalendar(id)

Arguments

• id (string) -- ID of the event to open. Required.

Object Types

Calendar

Event

Reminder

Attendee

RecurrenceRule

Alarm

Source

Enum Types

Calendar.DayOfTheWeek

Calendar.MonthOfTheYear