Giter Club home page Giter Club logo

capacitor-reminders's Introduction

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'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.