Inizia

Installa

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Usa poi la seguente richiesta:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-calendar` plugin in my project.

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

npm install @capgo/capacitor-calendar
npx cap sync

Configurazione per iOS

Aggiungi le descrizioni di utilizzo che il tuo app necessita di ios/App/App/Info.plist:

<key>NSCalendarsUsageDescription</key>
<string>This app needs calendar access.</string>
<key>NSCalendarsWriteOnlyAccessUsageDescription</key>
<string>This app needs permission to add calendar events.</string>
<key>NSCalendarsFullAccessUsageDescription</key>
<string>This app needs permission to read and manage calendar events.</string>
<key>NSRemindersUsageDescription</key>
<string>This app needs reminders access.</string>
<key>NSRemindersFullAccessUsageDescription</key>
<string>This app needs permission to read and manage reminders.</string>

A partire da iOS 17, si distinguono tra accesso al calendario scritto e accesso completo. Includi le descrizioni di utilizzo dei rinvii solo se il tuo app chiama le API dei rinvii.

Riferimento di Apple: Migrazione alle ultime autorizzazioni del calendario.

Configurazione Android

Aggiungi le autorizzazioni del calendario che il tuo app richiede android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.READ_CALENDAR" />
<uses-permission android:name="android.permission.WRITE_CALENDAR" />

Riferimento Android: Autorizzazioni utente del Provider di calendario.

Richiedi l'accesso al calendario

import { CapacitorCalendar } from '@capgo/capacitor-calendar';

const permission = await CapacitorCalendar.requestFullCalendarAccess();

if (permission.result !== 'granted') {
  throw new Error('Calendar permission was not granted');
}

Per le app che aggiungono solo eventi, utilizza requestWriteOnlyCalendarAccess()Per flussi di lettura Android esclusivi, utilizza requestReadOnlyCalendarAccess().

Crea un Evento

Le date sono timestamp Unix in millisecondi.

import { CapacitorCalendar } from '@capgo/capacitor-calendar';

const startDate = Date.now() + 60 * 60 * 1000;
const endDate = startDate + 60 * 60 * 1000;

const { id } = await CapacitorCalendar.createEvent({
  title: 'Product review',
  location: 'Capgo',
  startDate,
  endDate,
  description: 'Created with @capgo/capacitor-calendar',
});

console.log('Created event', id);

Apri l'editor degli eventi nativi

await CapacitorCalendar.createEventWithPrompt({
  title: 'Planning session',
  location: 'Office',
  startDate: Date.now() + 24 * 60 * 60 * 1000,
  endDate: Date.now() + 25 * 60 * 60 * 1000,
});

Sui dispositivi Android, le chiamate di creazione e modifica basate sulla richiesta restituiscono null. Elenco gli eventi successivi se desideri trovare l'ID dell'evento creato.

Elenco gli eventi imminenti

const now = Date.now();
const oneWeekFromNow = now + 7 * 24 * 60 * 60 * 1000;

const { result: events } = await CapacitorCalendar.listEventsInRange({
  from: now,
  to: oneWeekFromNow,
});

Scegli un Calendario

const { result: calendars } = await CapacitorCalendar.listCalendars();
const { result: defaultCalendar } = await CapacitorCalendar.getDefaultCalendar();

const calendarId = defaultCalendar?.id ?? calendars[0]?.id;

selectCalendarsWithPrompt() è disponibile su iOS quando desideri mostrare il picker del calendario del sistema.

Crea un Avviso iOS

const permission = await CapacitorCalendar.requestFullRemindersAccess();

if (permission.result === 'granted') {
  await CapacitorCalendar.createReminder({
    title: 'Send launch notes',
    dueDate: Date.now() + 2 * 24 * 60 * 60 * 1000,
    notes: 'Created with @capgo/capacitor-calendar',
  });
}

Le API degli avvisi sono disponibili solo su iOS.

Esempio di App

Il repository include un esempio di app con Capacitor controlli di permesso, creazione di eventi, sollecitazioni di eventi native, elenco dei calendari e elenco degli eventi di intervallo.

iOS	Android

API Reference

La documentazione completa di API è mantenuta nel file README e nelle definizioni TypeScript:

• README
• Definizioni di tipo