@ebarooni/capacitor-calendar
Advanced tools
Comparing version 0.6.1 to 0.7.0
@@ -275,3 +275,3 @@ { | ||
"name": "createEvent", | ||
"signature": "(options: { title: string; calendarId?: string; location?: string; startDate?: Date; endDate?: Date; isAllDay?: boolean; }) => Promise<{ eventCreated: boolean; }>", | ||
"signature": "(options: { title: string; calendarId?: string; location?: string; startDate?: number; endDate?: number; isAllDay?: boolean; }) => Promise<{ eventCreated: boolean; }>", | ||
"parameters": [ | ||
@@ -281,3 +281,3 @@ { | ||
"docs": "- Options for creating the event.", | ||
"type": "{ title: string; calendarId?: string | undefined; location?: string | undefined; startDate?: Date | undefined; endDate?: Date | undefined; isAllDay?: boolean | undefined; }" | ||
"type": "{ title: string; calendarId?: string | undefined; location?: string | undefined; startDate?: number | undefined; endDate?: number | undefined; isAllDay?: boolean | undefined; }" | ||
} | ||
@@ -305,9 +305,7 @@ ], | ||
"name": "example", | ||
"text": "const now = Date.now();\nconst eventOptions = {\n title: 'Team Meeting',\n location: 'Conference Room A',\n startDate: new Date(now),\n endDate: new Date(now + 2 * 60 * 60 * 1000),\n isAllDay: false\n};\nconst { eventCreated } = await createEvent(eventOptions);\nconsole.log(eventCreated); // true" | ||
"text": "const now = Date.now();\nconst eventOptions = {\n title: 'Team Meeting',\n location: 'Conference Room A',\n startDate: now,\n endDate: now + 2 * 60 * 60 * 1000,\n isAllDay: false\n};\nconst { eventCreated } = await createEvent(eventOptions);\nconsole.log(eventCreated); // true" | ||
} | ||
], | ||
"docs": "Creates an event with the provided options.", | ||
"complexTypes": [ | ||
"Date" | ||
], | ||
"complexTypes": [], | ||
"slug": "createevent" | ||
@@ -414,2 +412,38 @@ }, | ||
"slug": "createreminder" | ||
}, | ||
{ | ||
"name": "openCalendar", | ||
"signature": "(options: { date?: number; }) => Promise<void>", | ||
"parameters": [ | ||
{ | ||
"name": "options", | ||
"docs": "- Options for opening the calendar.", | ||
"type": "{ date?: number | undefined; }" | ||
} | ||
], | ||
"returns": "Promise<void>", | ||
"tags": [ | ||
{ | ||
"name": "method", | ||
"text": "openCalendar" | ||
}, | ||
{ | ||
"name": "platform", | ||
"text": "iOS, Android" | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "options - Options for opening the calendar." | ||
}, | ||
{ | ||
"name": "returns" | ||
}, | ||
{ | ||
"name": "example", | ||
"text": "void CapacitorCalendar.openCalendar({ date: Date.now() })" | ||
} | ||
], | ||
"docs": "Opens the calendar app. Since the user leaves your app, use this method with caution.", | ||
"complexTypes": [], | ||
"slug": "opencalendar" | ||
} | ||
@@ -431,3 +465,3 @@ ], | ||
"slug": "calendar", | ||
"docs": "Represents a calendar object with an ID and title.", | ||
"docs": "Represents a calendar object.", | ||
"tags": [ | ||
@@ -470,774 +504,2 @@ { | ||
{ | ||
"name": "Date", | ||
"slug": "date", | ||
"docs": "Enables basic storage and retrieval of dates and times.", | ||
"tags": [], | ||
"methods": [ | ||
{ | ||
"name": "toString", | ||
"signature": "() => string", | ||
"parameters": [], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Returns a string representation of a date. The format of the string depends on the locale.", | ||
"complexTypes": [], | ||
"slug": "tostring" | ||
}, | ||
{ | ||
"name": "toDateString", | ||
"signature": "() => string", | ||
"parameters": [], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Returns a date as a string value.", | ||
"complexTypes": [], | ||
"slug": "todatestring" | ||
}, | ||
{ | ||
"name": "toTimeString", | ||
"signature": "() => string", | ||
"parameters": [], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Returns a time as a string value.", | ||
"complexTypes": [], | ||
"slug": "totimestring" | ||
}, | ||
{ | ||
"name": "toLocaleString", | ||
"signature": "() => string", | ||
"parameters": [], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Returns a value as a string value appropriate to the host environment's current locale.", | ||
"complexTypes": [], | ||
"slug": "tolocalestring" | ||
}, | ||
{ | ||
"name": "toLocaleDateString", | ||
"signature": "() => string", | ||
"parameters": [], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Returns a date as a string value appropriate to the host environment's current locale.", | ||
"complexTypes": [], | ||
"slug": "tolocaledatestring" | ||
}, | ||
{ | ||
"name": "toLocaleTimeString", | ||
"signature": "() => string", | ||
"parameters": [], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Returns a time as a string value appropriate to the host environment's current locale.", | ||
"complexTypes": [], | ||
"slug": "tolocaletimestring" | ||
}, | ||
{ | ||
"name": "valueOf", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.", | ||
"complexTypes": [], | ||
"slug": "valueof" | ||
}, | ||
{ | ||
"name": "getTime", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the time value in milliseconds.", | ||
"complexTypes": [], | ||
"slug": "gettime" | ||
}, | ||
{ | ||
"name": "getFullYear", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the year, using local time.", | ||
"complexTypes": [], | ||
"slug": "getfullyear" | ||
}, | ||
{ | ||
"name": "getUTCFullYear", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the year using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "getutcfullyear" | ||
}, | ||
{ | ||
"name": "getMonth", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the month, using local time.", | ||
"complexTypes": [], | ||
"slug": "getmonth" | ||
}, | ||
{ | ||
"name": "getUTCMonth", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the month of a Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "getutcmonth" | ||
}, | ||
{ | ||
"name": "getDate", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the day-of-the-month, using local time.", | ||
"complexTypes": [], | ||
"slug": "getdate" | ||
}, | ||
{ | ||
"name": "getUTCDate", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the day-of-the-month, using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "getutcdate" | ||
}, | ||
{ | ||
"name": "getDay", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the day of the week, using local time.", | ||
"complexTypes": [], | ||
"slug": "getday" | ||
}, | ||
{ | ||
"name": "getUTCDay", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the day of the week using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "getutcday" | ||
}, | ||
{ | ||
"name": "getHours", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the hours in a date, using local time.", | ||
"complexTypes": [], | ||
"slug": "gethours" | ||
}, | ||
{ | ||
"name": "getUTCHours", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the hours value in a Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "getutchours" | ||
}, | ||
{ | ||
"name": "getMinutes", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the minutes of a Date object, using local time.", | ||
"complexTypes": [], | ||
"slug": "getminutes" | ||
}, | ||
{ | ||
"name": "getUTCMinutes", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the minutes of a Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "getutcminutes" | ||
}, | ||
{ | ||
"name": "getSeconds", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the seconds of a Date object, using local time.", | ||
"complexTypes": [], | ||
"slug": "getseconds" | ||
}, | ||
{ | ||
"name": "getUTCSeconds", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the seconds of a Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "getutcseconds" | ||
}, | ||
{ | ||
"name": "getMilliseconds", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the milliseconds of a Date, using local time.", | ||
"complexTypes": [], | ||
"slug": "getmilliseconds" | ||
}, | ||
{ | ||
"name": "getUTCMilliseconds", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "getutcmilliseconds" | ||
}, | ||
{ | ||
"name": "getTimezoneOffset", | ||
"signature": "() => number", | ||
"parameters": [], | ||
"returns": "number", | ||
"tags": [], | ||
"docs": "Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "gettimezoneoffset" | ||
}, | ||
{ | ||
"name": "setTime", | ||
"signature": "(time: number) => number", | ||
"parameters": [ | ||
{ | ||
"name": "time", | ||
"docs": "A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT.", | ||
"type": "number" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "time A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT." | ||
} | ||
], | ||
"docs": "Sets the date and time value in the Date object.", | ||
"complexTypes": [], | ||
"slug": "settime" | ||
}, | ||
{ | ||
"name": "setMilliseconds", | ||
"signature": "(ms: number) => number", | ||
"parameters": [ | ||
{ | ||
"name": "ms", | ||
"docs": "A numeric value equal to the millisecond value.", | ||
"type": "number" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "ms A numeric value equal to the millisecond value." | ||
} | ||
], | ||
"docs": "Sets the milliseconds value in the Date object using local time.", | ||
"complexTypes": [], | ||
"slug": "setmilliseconds" | ||
}, | ||
{ | ||
"name": "setUTCMilliseconds", | ||
"signature": "(ms: number) => number", | ||
"parameters": [ | ||
{ | ||
"name": "ms", | ||
"docs": "A numeric value equal to the millisecond value.", | ||
"type": "number" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "ms A numeric value equal to the millisecond value." | ||
} | ||
], | ||
"docs": "Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "setutcmilliseconds" | ||
}, | ||
{ | ||
"name": "setSeconds", | ||
"signature": "(sec: number, ms?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "sec", | ||
"docs": "A numeric value equal to the seconds value.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "ms", | ||
"docs": "A numeric value equal to the milliseconds value.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "sec A numeric value equal to the seconds value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "ms A numeric value equal to the milliseconds value." | ||
} | ||
], | ||
"docs": "Sets the seconds value in the Date object using local time.", | ||
"complexTypes": [], | ||
"slug": "setseconds" | ||
}, | ||
{ | ||
"name": "setUTCSeconds", | ||
"signature": "(sec: number, ms?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "sec", | ||
"docs": "A numeric value equal to the seconds value.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "ms", | ||
"docs": "A numeric value equal to the milliseconds value.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "sec A numeric value equal to the seconds value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "ms A numeric value equal to the milliseconds value." | ||
} | ||
], | ||
"docs": "Sets the seconds value in the Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "setutcseconds" | ||
}, | ||
{ | ||
"name": "setMinutes", | ||
"signature": "(min: number, sec?: number | undefined, ms?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "min", | ||
"docs": "A numeric value equal to the minutes value.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "sec", | ||
"docs": "A numeric value equal to the seconds value.", | ||
"type": "number | undefined" | ||
}, | ||
{ | ||
"name": "ms", | ||
"docs": "A numeric value equal to the milliseconds value.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "min A numeric value equal to the minutes value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "sec A numeric value equal to the seconds value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "ms A numeric value equal to the milliseconds value." | ||
} | ||
], | ||
"docs": "Sets the minutes value in the Date object using local time.", | ||
"complexTypes": [], | ||
"slug": "setminutes" | ||
}, | ||
{ | ||
"name": "setUTCMinutes", | ||
"signature": "(min: number, sec?: number | undefined, ms?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "min", | ||
"docs": "A numeric value equal to the minutes value.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "sec", | ||
"docs": "A numeric value equal to the seconds value.", | ||
"type": "number | undefined" | ||
}, | ||
{ | ||
"name": "ms", | ||
"docs": "A numeric value equal to the milliseconds value.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "min A numeric value equal to the minutes value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "sec A numeric value equal to the seconds value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "ms A numeric value equal to the milliseconds value." | ||
} | ||
], | ||
"docs": "Sets the minutes value in the Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "setutcminutes" | ||
}, | ||
{ | ||
"name": "setHours", | ||
"signature": "(hours: number, min?: number | undefined, sec?: number | undefined, ms?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "hours", | ||
"docs": "A numeric value equal to the hours value.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "min", | ||
"docs": "A numeric value equal to the minutes value.", | ||
"type": "number | undefined" | ||
}, | ||
{ | ||
"name": "sec", | ||
"docs": "A numeric value equal to the seconds value.", | ||
"type": "number | undefined" | ||
}, | ||
{ | ||
"name": "ms", | ||
"docs": "A numeric value equal to the milliseconds value.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "hours A numeric value equal to the hours value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "min A numeric value equal to the minutes value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "sec A numeric value equal to the seconds value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "ms A numeric value equal to the milliseconds value." | ||
} | ||
], | ||
"docs": "Sets the hour value in the Date object using local time.", | ||
"complexTypes": [], | ||
"slug": "sethours" | ||
}, | ||
{ | ||
"name": "setUTCHours", | ||
"signature": "(hours: number, min?: number | undefined, sec?: number | undefined, ms?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "hours", | ||
"docs": "A numeric value equal to the hours value.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "min", | ||
"docs": "A numeric value equal to the minutes value.", | ||
"type": "number | undefined" | ||
}, | ||
{ | ||
"name": "sec", | ||
"docs": "A numeric value equal to the seconds value.", | ||
"type": "number | undefined" | ||
}, | ||
{ | ||
"name": "ms", | ||
"docs": "A numeric value equal to the milliseconds value.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "hours A numeric value equal to the hours value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "min A numeric value equal to the minutes value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "sec A numeric value equal to the seconds value." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "ms A numeric value equal to the milliseconds value." | ||
} | ||
], | ||
"docs": "Sets the hours value in the Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "setutchours" | ||
}, | ||
{ | ||
"name": "setDate", | ||
"signature": "(date: number) => number", | ||
"parameters": [ | ||
{ | ||
"name": "date", | ||
"docs": "A numeric value equal to the day of the month.", | ||
"type": "number" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "date A numeric value equal to the day of the month." | ||
} | ||
], | ||
"docs": "Sets the numeric day-of-the-month value of the Date object using local time.", | ||
"complexTypes": [], | ||
"slug": "setdate" | ||
}, | ||
{ | ||
"name": "setUTCDate", | ||
"signature": "(date: number) => number", | ||
"parameters": [ | ||
{ | ||
"name": "date", | ||
"docs": "A numeric value equal to the day of the month.", | ||
"type": "number" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "date A numeric value equal to the day of the month." | ||
} | ||
], | ||
"docs": "Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "setutcdate" | ||
}, | ||
{ | ||
"name": "setMonth", | ||
"signature": "(month: number, date?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "month", | ||
"docs": "A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "date", | ||
"docs": "A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "month A numeric value equal to the month. The value for January is 0, and other month values follow consecutively." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "date A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used." | ||
} | ||
], | ||
"docs": "Sets the month value in the Date object using local time.", | ||
"complexTypes": [], | ||
"slug": "setmonth" | ||
}, | ||
{ | ||
"name": "setUTCMonth", | ||
"signature": "(month: number, date?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "month", | ||
"docs": "A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "date", | ||
"docs": "A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "month A numeric value equal to the month. The value for January is 0, and other month values follow consecutively." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "date A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used." | ||
} | ||
], | ||
"docs": "Sets the month value in the Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "setutcmonth" | ||
}, | ||
{ | ||
"name": "setFullYear", | ||
"signature": "(year: number, month?: number | undefined, date?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "year", | ||
"docs": "A numeric value for the year.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "month", | ||
"docs": "A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified.", | ||
"type": "number | undefined" | ||
}, | ||
{ | ||
"name": "date", | ||
"docs": "A numeric value equal for the day of the month.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "year A numeric value for the year." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "month A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "date A numeric value equal for the day of the month." | ||
} | ||
], | ||
"docs": "Sets the year of the Date object using local time.", | ||
"complexTypes": [], | ||
"slug": "setfullyear" | ||
}, | ||
{ | ||
"name": "setUTCFullYear", | ||
"signature": "(year: number, month?: number | undefined, date?: number | undefined) => number", | ||
"parameters": [ | ||
{ | ||
"name": "year", | ||
"docs": "A numeric value equal to the year.", | ||
"type": "number" | ||
}, | ||
{ | ||
"name": "month", | ||
"docs": "A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied.", | ||
"type": "number | undefined" | ||
}, | ||
{ | ||
"name": "date", | ||
"docs": "A numeric value equal to the day of the month.", | ||
"type": "number | undefined" | ||
} | ||
], | ||
"returns": "number", | ||
"tags": [ | ||
{ | ||
"name": "param", | ||
"text": "year A numeric value equal to the year." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "month A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied." | ||
}, | ||
{ | ||
"name": "param", | ||
"text": "date A numeric value equal to the day of the month." | ||
} | ||
], | ||
"docs": "Sets the year value in the Date object using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "setutcfullyear" | ||
}, | ||
{ | ||
"name": "toUTCString", | ||
"signature": "() => string", | ||
"parameters": [], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Returns a date converted to a string using Universal Coordinated Time (UTC).", | ||
"complexTypes": [], | ||
"slug": "toutcstring" | ||
}, | ||
{ | ||
"name": "toISOString", | ||
"signature": "() => string", | ||
"parameters": [], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Returns a date as a string value in ISO format.", | ||
"complexTypes": [], | ||
"slug": "toisostring" | ||
}, | ||
{ | ||
"name": "toJSON", | ||
"signature": "(key?: any) => string", | ||
"parameters": [ | ||
{ | ||
"name": "key", | ||
"docs": "", | ||
"type": "any" | ||
} | ||
], | ||
"returns": "string", | ||
"tags": [], | ||
"docs": "Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization.", | ||
"complexTypes": [], | ||
"slug": "tojson" | ||
} | ||
], | ||
"properties": [] | ||
}, | ||
{ | ||
"name": "RemindersList", | ||
@@ -1310,2 +572,6 @@ "slug": "reminderslist", | ||
"name": "platform" | ||
}, | ||
{ | ||
"text": "<h3>Manifest Permissions:</h3>\n<ul>\n <li><strong>iOS 17 ≤:</strong> NSCalendarsFullAccessUsageDescription</li>\n <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li>\n <li><strong>Android:</strong> android.permission.READ_CALENDAR</li>\n</ul>", | ||
"name": "permissions" | ||
} | ||
@@ -1322,2 +588,6 @@ ], | ||
"name": "platform" | ||
}, | ||
{ | ||
"text": "<h3>Manifest Permissions:</h3>\n<ul>\n <li><strong>iOS 17 ≤:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li>\n <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li>\n <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li>\n</ul>", | ||
"name": "permissions" | ||
} | ||
@@ -1334,2 +604,6 @@ ], | ||
"name": "platform" | ||
}, | ||
{ | ||
"text": "<h3>Manifest Permissions:</h3>\n<ul>\n <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li>\n <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li>\n</ul>", | ||
"name": "permissions" | ||
} | ||
@@ -1346,2 +620,6 @@ ], | ||
"name": "platform" | ||
}, | ||
{ | ||
"text": "<h3>Manifest Permissions:</h3>\n<ul>\n <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li>\n <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li>\n</ul>", | ||
"name": "permissions" | ||
} | ||
@@ -1392,3 +670,3 @@ ], | ||
"tags": [], | ||
"docs": "" | ||
"docs": "The reminder repeats on a daily basis" | ||
}, | ||
@@ -1398,3 +676,3 @@ { | ||
"tags": [], | ||
"docs": "" | ||
"docs": "The reminder repeats on a weekly basis" | ||
}, | ||
@@ -1404,3 +682,3 @@ { | ||
"tags": [], | ||
"docs": "" | ||
"docs": "The reminder repeats on a monthly basis" | ||
}, | ||
@@ -1410,3 +688,3 @@ { | ||
"tags": [], | ||
"docs": "" | ||
"docs": "The reminder repeats on a yearly basis" | ||
} | ||
@@ -1413,0 +691,0 @@ ] |
@@ -145,4 +145,4 @@ import { CalendarChooserDisplayStyle } from './schemas/enums/calendar-chooser-display-style'; | ||
* @param {string} [options.location] - The location of the event. (Optional) | ||
* @param {Date} [options.startDate] - The start date and time of the event. (Optional) | ||
* @param {Date} [options.endDate] - The end date and time of the event. (Optional) | ||
* @param {number} [options.startDate] - The start date and time of the event. (Optional) | ||
* @param {number} [options.endDate] - The end date and time of the event. (Optional) | ||
* @param {boolean} [options.isAllDay] - Weather the event is for the entire day or not. (Optional) | ||
@@ -156,4 +156,4 @@ * @returns {Promise<{ eventCreated: boolean }>} A Promise that resolves with an object indicating whether the event was created successfully. | ||
* location: 'Conference Room A', | ||
* startDate: new Date(now), | ||
* endDate: new Date(now + 2 * 60 * 60 * 1000), | ||
* startDate: now, | ||
* endDate: now + 2 * 60 * 60 * 1000, | ||
* isAllDay: false | ||
@@ -168,4 +168,4 @@ * }; | ||
location?: string; | ||
startDate?: Date; | ||
endDate?: Date; | ||
startDate?: number; | ||
endDate?: number; | ||
isAllDay?: boolean; | ||
@@ -261,2 +261,16 @@ }): Promise<{ | ||
}>; | ||
/** | ||
* Opens the calendar app. Since the user leaves your app, use this method with caution. | ||
* | ||
* @method openCalendar | ||
* @platform iOS, Android | ||
* @param {object} options - Options for opening the calendar. | ||
* @param {number} options.date - The date at which the calendar should be opened. (Optional) | ||
* @returns {Promise<void>} | ||
* @example | ||
* void CapacitorCalendar.openCalendar({ date: Date.now() }) | ||
*/ | ||
openCalendar(options: { | ||
date?: number; | ||
}): Promise<void>; | ||
} |
/** | ||
* Enum representing the display styles for the calendar chooser. | ||
* @enum | ||
* | ||
* @enum CalendarChooserDisplayStyle | ||
* @platform iOS | ||
@@ -5,0 +6,0 @@ */ |
/** | ||
* Enum representing the display styles for the calendar chooser. | ||
* @enum | ||
* | ||
* @enum CalendarChooserDisplayStyle | ||
* @platform iOS | ||
@@ -5,0 +6,0 @@ */ |
/** | ||
* Enum representing the selection style for the calendar chooser. | ||
* @enum | ||
* | ||
* @enum CalendarChooserSelectionStyle | ||
* @platform iOS | ||
@@ -5,0 +6,0 @@ */ |
/** | ||
* Enum representing the selection style for the calendar chooser. | ||
* @enum | ||
* | ||
* @enum CalendarChooserSelectionStyle | ||
* @platform iOS | ||
@@ -5,0 +6,0 @@ */ |
@@ -0,5 +1,19 @@ | ||
/** | ||
* Enum representing the available runtime permissions for the plugin. | ||
* | ||
* @enum PluginPermission | ||
* @platform iOS, Android | ||
*/ | ||
export declare enum PluginPermission { | ||
/** | ||
* Represents the permission state for reading calendar. | ||
* | ||
* @platform iOS, Android | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSCalendarsFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li> | ||
* <li><strong>Android:</strong> android.permission.READ_CALENDAR</li> | ||
* </ul> | ||
*/ | ||
@@ -9,3 +23,11 @@ READ_CALENDAR = "readCalendar", | ||
* Represents the permission state for writing calendar. | ||
* | ||
* @platform iOS, Android | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li> | ||
* <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li> | ||
* </ul> | ||
*/ | ||
@@ -15,3 +37,10 @@ WRITE_CALENDAR = "writeCalendar", | ||
* Represents the permission state for reading reminders. | ||
* | ||
* @platform iOS | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li> | ||
* </ul> | ||
*/ | ||
@@ -21,5 +50,12 @@ READ_REMINDERS = "readReminders", | ||
* Represents the permission state for writing reminders. | ||
* | ||
* @platform iOS | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li> | ||
* </ul> | ||
*/ | ||
WRITE_REMINDERS = "writeReminders" | ||
} |
@@ -0,1 +1,7 @@ | ||
/** | ||
* Enum representing the available runtime permissions for the plugin. | ||
* | ||
* @enum PluginPermission | ||
* @platform iOS, Android | ||
*/ | ||
export var PluginPermission; | ||
@@ -5,3 +11,11 @@ (function (PluginPermission) { | ||
* Represents the permission state for reading calendar. | ||
* | ||
* @platform iOS, Android | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSCalendarsFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li> | ||
* <li><strong>Android:</strong> android.permission.READ_CALENDAR</li> | ||
* </ul> | ||
*/ | ||
@@ -11,3 +25,11 @@ PluginPermission["READ_CALENDAR"] = "readCalendar"; | ||
* Represents the permission state for writing calendar. | ||
* | ||
* @platform iOS, Android | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li> | ||
* <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li> | ||
* </ul> | ||
*/ | ||
@@ -17,3 +39,10 @@ PluginPermission["WRITE_CALENDAR"] = "writeCalendar"; | ||
* Represents the permission state for reading reminders. | ||
* | ||
* @platform iOS | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li> | ||
* </ul> | ||
*/ | ||
@@ -23,3 +52,10 @@ PluginPermission["READ_REMINDERS"] = "readReminders"; | ||
* Represents the permission state for writing reminders. | ||
* | ||
* @platform iOS | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li> | ||
* </ul> | ||
*/ | ||
@@ -26,0 +62,0 @@ PluginPermission["WRITE_REMINDERS"] = "writeReminders"; |
@@ -0,6 +1,24 @@ | ||
/** | ||
* Enum representing the repeating frequency of the reminder. | ||
* | ||
* @enum ReminderRecurrenceFrequency | ||
* @platform iOS | ||
*/ | ||
export declare enum ReminderRecurrenceFrequency { | ||
/** | ||
* The reminder repeats on a daily basis | ||
*/ | ||
DAILY = 0, | ||
/** | ||
* The reminder repeats on a weekly basis | ||
*/ | ||
WEEKLY = 1, | ||
/** | ||
* The reminder repeats on a monthly basis | ||
*/ | ||
MONTHLY = 2, | ||
/** | ||
* The reminder repeats on a yearly basis | ||
*/ | ||
YEARLY = 3 | ||
} |
@@ -0,8 +1,26 @@ | ||
/** | ||
* Enum representing the repeating frequency of the reminder. | ||
* | ||
* @enum ReminderRecurrenceFrequency | ||
* @platform iOS | ||
*/ | ||
export var ReminderRecurrenceFrequency; | ||
(function (ReminderRecurrenceFrequency) { | ||
/** | ||
* The reminder repeats on a daily basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["DAILY"] = 0] = "DAILY"; | ||
/** | ||
* The reminder repeats on a weekly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["WEEKLY"] = 1] = "WEEKLY"; | ||
/** | ||
* The reminder repeats on a monthly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["MONTHLY"] = 2] = "MONTHLY"; | ||
/** | ||
* The reminder repeats on a yearly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["YEARLY"] = 3] = "YEARLY"; | ||
})(ReminderRecurrenceFrequency || (ReminderRecurrenceFrequency = {})); | ||
//# sourceMappingURL=reminder-recurrence-frequency.js.map |
/** | ||
* Represents a calendar object with an ID and title. | ||
* Represents a calendar object. | ||
* | ||
@@ -4,0 +4,0 @@ * @interface Calendar |
@@ -37,4 +37,4 @@ import { PermissionState, WebPlugin } from '@capacitor/core'; | ||
location?: string; | ||
startDate?: Date; | ||
endDate?: Date; | ||
startDate?: number; | ||
endDate?: number; | ||
isAllDay?: boolean; | ||
@@ -65,2 +65,5 @@ }): Promise<{ | ||
}>; | ||
openCalendar(_options: { | ||
date?: number; | ||
}): Promise<void>; | ||
} |
@@ -40,3 +40,6 @@ /* eslint-disable @typescript-eslint/no-unused-vars */ | ||
} | ||
openCalendar(_options) { | ||
throw this.unimplemented(`${this.createReminder.name} is not implemented on the web`); | ||
} | ||
} | ||
//# sourceMappingURL=web.js.map |
@@ -7,3 +7,4 @@ 'use strict'; | ||
* Enum representing the display styles for the calendar chooser. | ||
* @enum | ||
* | ||
* @enum CalendarChooserDisplayStyle | ||
* @platform iOS | ||
@@ -25,3 +26,4 @@ */ | ||
* Enum representing the selection style for the calendar chooser. | ||
* @enum | ||
* | ||
* @enum CalendarChooserSelectionStyle | ||
* @platform iOS | ||
@@ -41,2 +43,8 @@ */ | ||
/** | ||
* Enum representing the available runtime permissions for the plugin. | ||
* | ||
* @enum PluginPermission | ||
* @platform iOS, Android | ||
*/ | ||
exports.PluginPermission = void 0; | ||
@@ -46,3 +54,11 @@ (function (PluginPermission) { | ||
* Represents the permission state for reading calendar. | ||
* | ||
* @platform iOS, Android | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSCalendarsFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li> | ||
* <li><strong>Android:</strong> android.permission.READ_CALENDAR</li> | ||
* </ul> | ||
*/ | ||
@@ -52,3 +68,11 @@ PluginPermission["READ_CALENDAR"] = "readCalendar"; | ||
* Represents the permission state for writing calendar. | ||
* | ||
* @platform iOS, Android | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li> | ||
* <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li> | ||
* </ul> | ||
*/ | ||
@@ -58,3 +82,10 @@ PluginPermission["WRITE_CALENDAR"] = "writeCalendar"; | ||
* Represents the permission state for reading reminders. | ||
* | ||
* @platform iOS | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li> | ||
* </ul> | ||
*/ | ||
@@ -64,3 +95,10 @@ PluginPermission["READ_REMINDERS"] = "readReminders"; | ||
* Represents the permission state for writing reminders. | ||
* | ||
* @platform iOS | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li> | ||
* </ul> | ||
*/ | ||
@@ -70,7 +108,25 @@ PluginPermission["WRITE_REMINDERS"] = "writeReminders"; | ||
/** | ||
* Enum representing the repeating frequency of the reminder. | ||
* | ||
* @enum ReminderRecurrenceFrequency | ||
* @platform iOS | ||
*/ | ||
exports.ReminderRecurrenceFrequency = void 0; | ||
(function (ReminderRecurrenceFrequency) { | ||
/** | ||
* The reminder repeats on a daily basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["DAILY"] = 0] = "DAILY"; | ||
/** | ||
* The reminder repeats on a weekly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["WEEKLY"] = 1] = "WEEKLY"; | ||
/** | ||
* The reminder repeats on a monthly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["MONTHLY"] = 2] = "MONTHLY"; | ||
/** | ||
* The reminder repeats on a yearly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["YEARLY"] = 3] = "YEARLY"; | ||
@@ -121,2 +177,5 @@ })(exports.ReminderRecurrenceFrequency || (exports.ReminderRecurrenceFrequency = {})); | ||
} | ||
openCalendar(_options) { | ||
throw this.unimplemented(`${this.createReminder.name} is not implemented on the web`); | ||
} | ||
} | ||
@@ -123,0 +182,0 @@ |
@@ -6,3 +6,4 @@ var capacitorCapacitorCalendar = (function (exports, core) { | ||
* Enum representing the display styles for the calendar chooser. | ||
* @enum | ||
* | ||
* @enum CalendarChooserDisplayStyle | ||
* @platform iOS | ||
@@ -24,3 +25,4 @@ */ | ||
* Enum representing the selection style for the calendar chooser. | ||
* @enum | ||
* | ||
* @enum CalendarChooserSelectionStyle | ||
* @platform iOS | ||
@@ -40,2 +42,8 @@ */ | ||
/** | ||
* Enum representing the available runtime permissions for the plugin. | ||
* | ||
* @enum PluginPermission | ||
* @platform iOS, Android | ||
*/ | ||
exports.PluginPermission = void 0; | ||
@@ -45,3 +53,11 @@ (function (PluginPermission) { | ||
* Represents the permission state for reading calendar. | ||
* | ||
* @platform iOS, Android | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSCalendarsFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li> | ||
* <li><strong>Android:</strong> android.permission.READ_CALENDAR</li> | ||
* </ul> | ||
*/ | ||
@@ -51,3 +67,11 @@ PluginPermission["READ_CALENDAR"] = "readCalendar"; | ||
* Represents the permission state for writing calendar. | ||
* | ||
* @platform iOS, Android | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSCalendarsUsageDescription</li> | ||
* <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li> | ||
* </ul> | ||
*/ | ||
@@ -57,3 +81,10 @@ PluginPermission["WRITE_CALENDAR"] = "writeCalendar"; | ||
* Represents the permission state for reading reminders. | ||
* | ||
* @platform iOS | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li> | ||
* </ul> | ||
*/ | ||
@@ -63,3 +94,10 @@ PluginPermission["READ_REMINDERS"] = "readReminders"; | ||
* Represents the permission state for writing reminders. | ||
* | ||
* @platform iOS | ||
* @permissions | ||
* <h3>Manifest Permissions:</h3> | ||
* <ul> | ||
* <li><strong>iOS 17 ≤:</strong> NSRemindersFullAccessUsageDescription</li> | ||
* <li><strong>iOS 10 ≤ x ≤ iOS 16:</strong> NSRemindersUsageDescription</li> | ||
* </ul> | ||
*/ | ||
@@ -69,7 +107,25 @@ PluginPermission["WRITE_REMINDERS"] = "writeReminders"; | ||
/** | ||
* Enum representing the repeating frequency of the reminder. | ||
* | ||
* @enum ReminderRecurrenceFrequency | ||
* @platform iOS | ||
*/ | ||
exports.ReminderRecurrenceFrequency = void 0; | ||
(function (ReminderRecurrenceFrequency) { | ||
/** | ||
* The reminder repeats on a daily basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["DAILY"] = 0] = "DAILY"; | ||
/** | ||
* The reminder repeats on a weekly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["WEEKLY"] = 1] = "WEEKLY"; | ||
/** | ||
* The reminder repeats on a monthly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["MONTHLY"] = 2] = "MONTHLY"; | ||
/** | ||
* The reminder repeats on a yearly basis | ||
*/ | ||
ReminderRecurrenceFrequency[ReminderRecurrenceFrequency["YEARLY"] = 3] = "YEARLY"; | ||
@@ -120,2 +176,5 @@ })(exports.ReminderRecurrenceFrequency || (exports.ReminderRecurrenceFrequency = {})); | ||
} | ||
openCalendar(_options) { | ||
throw this.unimplemented(`${this.createReminder.name} is not implemented on the web`); | ||
} | ||
} | ||
@@ -122,0 +181,0 @@ |
{ | ||
"name": "@ebarooni/capacitor-calendar", | ||
"version": "0.6.1", | ||
"version": "0.7.0", | ||
"description": "The Capacitor Calendar Plugin enables full calendar functionality on iOS and Android, with added reminder support for iOS devices.", | ||
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js", |
@@ -54,2 +54,3 @@ <p align="center"> | ||
- ✅️ Create reminders (only supported on iOS) | ||
- ✅ Open calendar app at a specific date | ||
- ⌛️ Find calendar events | ||
@@ -82,2 +83,3 @@ - ⌛️ Delete calendar events | ||
* [`createReminder(...)`](#createreminder) | ||
* [`openCalendar(...)`](#opencalendar) | ||
* [Interfaces](#interfaces) | ||
@@ -215,3 +217,3 @@ * [Type Aliases](#type-aliases) | ||
```typescript | ||
createEvent(options: { title: string; calendarId?: string; location?: string; startDate?: Date; endDate?: Date; isAllDay?: boolean; }) => Promise<{ eventCreated: boolean; }> | ||
createEvent(options: { title: string; calendarId?: string; location?: string; startDate?: number; endDate?: number; isAllDay?: boolean; }) => Promise<{ eventCreated: boolean; }> | ||
``` | ||
@@ -221,5 +223,5 @@ | ||
| Param | Type | Description | | ||
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | ||
| **`options`** | <code>{ title: string; calendarId?: string; location?: string; startDate?: <a href="#date">Date</a>; endDate?: <a href="#date">Date</a>; isAllDay?: boolean; }</code> | - Options for creating the event. | | ||
| Param | Type | Description | | ||
| ------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | ||
| **`options`** | <code>{ title: string; calendarId?: string; location?: string; startDate?: number; endDate?: number; isAllDay?: boolean; }</code> | - Options for creating the event. | | ||
@@ -274,2 +276,17 @@ **Returns:** <code>Promise<{ eventCreated: boolean; }></code> | ||
### openCalendar(...) | ||
```typescript | ||
openCalendar(options: { date?: number; }) => Promise<void> | ||
``` | ||
Opens the calendar app. Since the user leaves your app, use this method with caution. | ||
| Param | Type | Description | | ||
| ------------- | ------------------------------- | ----------------------------------- | | ||
| **`options`** | <code>{ date?: number; }</code> | - Options for opening the calendar. | | ||
-------------------- | ||
### Interfaces | ||
@@ -283,3 +300,3 @@ | ||
Represents a calendar object with an ID and title. | ||
Represents a calendar object. | ||
@@ -292,53 +309,2 @@ | Prop | Type | | ||
#### Date | ||
Enables basic storage and retrieval of dates and times. | ||
| Method | Signature | Description | | ||
| ---------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | | ||
| **toString** | () => string | Returns a string representation of a date. The format of the string depends on the locale. | | ||
| **toDateString** | () => string | Returns a date as a string value. | | ||
| **toTimeString** | () => string | Returns a time as a string value. | | ||
| **toLocaleString** | () => string | Returns a value as a string value appropriate to the host environment's current locale. | | ||
| **toLocaleDateString** | () => string | Returns a date as a string value appropriate to the host environment's current locale. | | ||
| **toLocaleTimeString** | () => string | Returns a time as a string value appropriate to the host environment's current locale. | | ||
| **valueOf** | () => number | Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC. | | ||
| **getTime** | () => number | Gets the time value in milliseconds. | | ||
| **getFullYear** | () => number | Gets the year, using local time. | | ||
| **getUTCFullYear** | () => number | Gets the year using Universal Coordinated Time (UTC). | | ||
| **getMonth** | () => number | Gets the month, using local time. | | ||
| **getUTCMonth** | () => number | Gets the month of a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **getDate** | () => number | Gets the day-of-the-month, using local time. | | ||
| **getUTCDate** | () => number | Gets the day-of-the-month, using Universal Coordinated Time (UTC). | | ||
| **getDay** | () => number | Gets the day of the week, using local time. | | ||
| **getUTCDay** | () => number | Gets the day of the week using Universal Coordinated Time (UTC). | | ||
| **getHours** | () => number | Gets the hours in a date, using local time. | | ||
| **getUTCHours** | () => number | Gets the hours value in a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **getMinutes** | () => number | Gets the minutes of a <a href="#date">Date</a> object, using local time. | | ||
| **getUTCMinutes** | () => number | Gets the minutes of a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **getSeconds** | () => number | Gets the seconds of a <a href="#date">Date</a> object, using local time. | | ||
| **getUTCSeconds** | () => number | Gets the seconds of a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **getMilliseconds** | () => number | Gets the milliseconds of a <a href="#date">Date</a>, using local time. | | ||
| **getUTCMilliseconds** | () => number | Gets the milliseconds of a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **getTimezoneOffset** | () => number | Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC). | | ||
| **setTime** | (time: number) => number | Sets the date and time value in the <a href="#date">Date</a> object. | | ||
| **setMilliseconds** | (ms: number) => number | Sets the milliseconds value in the <a href="#date">Date</a> object using local time. | | ||
| **setUTCMilliseconds** | (ms: number) => number | Sets the milliseconds value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **setSeconds** | (sec: number, ms?: number \| undefined) => number | Sets the seconds value in the <a href="#date">Date</a> object using local time. | | ||
| **setUTCSeconds** | (sec: number, ms?: number \| undefined) => number | Sets the seconds value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **setMinutes** | (min: number, sec?: number \| undefined, ms?: number \| undefined) => number | Sets the minutes value in the <a href="#date">Date</a> object using local time. | | ||
| **setUTCMinutes** | (min: number, sec?: number \| undefined, ms?: number \| undefined) => number | Sets the minutes value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **setHours** | (hours: number, min?: number \| undefined, sec?: number \| undefined, ms?: number \| undefined) => number | Sets the hour value in the <a href="#date">Date</a> object using local time. | | ||
| **setUTCHours** | (hours: number, min?: number \| undefined, sec?: number \| undefined, ms?: number \| undefined) => number | Sets the hours value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **setDate** | (date: number) => number | Sets the numeric day-of-the-month value of the <a href="#date">Date</a> object using local time. | | ||
| **setUTCDate** | (date: number) => number | Sets the numeric day of the month in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **setMonth** | (month: number, date?: number \| undefined) => number | Sets the month value in the <a href="#date">Date</a> object using local time. | | ||
| **setUTCMonth** | (month: number, date?: number \| undefined) => number | Sets the month value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **setFullYear** | (year: number, month?: number \| undefined, date?: number \| undefined) => number | Sets the year of the <a href="#date">Date</a> object using local time. | | ||
| **setUTCFullYear** | (year: number, month?: number \| undefined, date?: number \| undefined) => number | Sets the year value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| **toUTCString** | () => string | Returns a date converted to a string using Universal Coordinated Time (UTC). | | ||
| **toISOString** | () => string | Returns a date as a string value in ISO format. | | ||
| **toJSON** | (key?: any) => string | Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization. | | ||
#### RemindersList | ||
@@ -395,9 +361,9 @@ | ||
| Members | | ||
| ------------- | | ||
| **`DAILY`** | | ||
| **`WEEKLY`** | | ||
| **`MONTHLY`** | | ||
| **`YEARLY`** | | ||
| Members | Description | | ||
| ------------- | --------------------------------------- | | ||
| **`DAILY`** | The reminder repeats on a daily basis | | ||
| **`WEEKLY`** | The reminder repeats on a weekly basis | | ||
| **`MONTHLY`** | The reminder repeats on a monthly basis | | ||
| **`YEARLY`** | The reminder repeats on a yearly basis | | ||
</docgen-api> |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
184443
1753
362