capacitor-reminders
v0.0.8
Published
Read / Write iOS Reminders
Downloads
10
Readme
capacitor-reminders
Read / Write iOS Reminders
Install
npm install capacitor-reminders
npx cap sync
IMPORTANT (iOS)
Add NSRemindersUsageDescription
into your Info.plist
API
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>
| Param | Type |
| --------- | ------------------------------------------------------------------------------ |
| __0
| { reminder: CapacitorReminder; } |
delete(...)
delete({ id }: { id: string; }) => Promise<void>
| Param | Type |
| --------- | ---------------------------- |
| __0
| { id: string; } |
Interfaces
CapacitorReminder
| Prop | Type |
| ------------------------ | ----------------------------- |
| id
| string |
| title
| string |
| dueDate
| string |
| notes
| string |
| isComplete
| boolean |
| completionDate
| string |
| hasRecurrenceRules
| boolean |
| recurrenceRules
| RecurrenceRule[] |
| lastModifiedDate
| string |
RecurrenceRule
| Prop | Type |
| --------------------- | --------------------------------------------------------------------------- |
| frequency
| RecurrenceRuleFrequency |
| interval
| number |
| dateEnd
| string |
| daysOfTheWeek
| RecurrenceRuleDayOfWeek[] |
| daysOfTheMonth
| number[] |
| daysOfTheYear
| number[] |
| weeksOfTheYear
| number[] |
| monthsOfTheYear
| number[] |
RecurrenceRuleDayOfWeek
| Prop | Type |
| ------------------ | ----------------------------------------------------- |
| dayOfTheWeek
| DayOfTheWeek |
| weekNumber
| number |
Enums
RecurrenceRuleFrequency
| Members |
| --------------- |
| 'daily'
|
| 'weekly'
|
| 'monthly'
|
| 'yearly'
|
DayOfTheWeek
| Members |
| ----------------- |
| 'sunday'
|
| 'monday'
|
| 'tuesday'
|
| 'wednesday'
|
| 'thursday'
|
| 'friday'
|
| 'saturday'
|