capacitor-reminders v0.0.8

capacitor-reminders

Read / Write iOS Reminders

Install

npm install capacitor-reminders
npx cap sync

IMPORTANT (iOS)

Add NSRemindersUsageDescription into your Info.plist

API

• requestPermissions()
• checkPermissions()
• readAll()
• write(...)
• delete(...)
• Interfaces
• Enums

requestPermissions()

requestPermissions() => Promise<{ permission: 'notDetermined' | 'restricted' | 'denied' | 'authorized'; }>

Returns: Promise<{ permission: 'notDetermined' | 'restricted' | 'denied' | 'authorized'; }>

checkPermissions()

checkPermissions() => Promise<{ permission: 'notDetermined' | 'restricted' | 'denied' | 'authorized'; }>

Returns: Promise<{ permission: 'notDetermined' | 'restricted' | 'denied' | 'authorized'; }>

readAll()

readAll() => Promise<{ reminders: CapacitorReminder[]; }>

Returns: Promise<{ reminders: CapacitorReminder[]; }>

write(...)

write({ reminder }: { reminder: CapacitorReminder; }) => Promise<void>

delete(...)

delete({ id }: { id: string; }) => Promise<void>

Interfaces

CapacitorReminder

RecurrenceRule

RecurrenceRuleDayOfWeek

Enums

RecurrenceRuleFrequency

DayOfTheWeek