Skip to content

Reminder

Manages reminders in calendars.

Used for creating, fetching and removing reminders from your calendars.

identifier

Identifier of reminder.

identifier: string

title

Title of reminder.

title: string

notes

Notes associated with reminder.

notes: string

isCompleted

Whether the reminder is completed

isCompleted: bool

priority

Priority of reminder.

Specifies the prirority of the reminder with 0 representing an undefined priority, 1 the highest priority, and 9 the lowest priority.

priority: number

dueDate

Due date of reminder.

dueDate: Date

completionDate

Completion date of reminder.

completionDate: Date

creationDate

Creation date of reminder.

creationDate: Date

calendar

Calendar the reminder is stored in.

calendar: Calendar

-new Reminder

Constructs a reminder.

In order to add the reminder to your calendar, you must call the save() function.

new Reminder()

-addRecurrenceRule

Adds a recurrence rule.

Recurrence rules specify when the reminder should be repeated. See the documentation of RecurrenceRule for more information on creating rules.

addRecurrenceRule(recurrenceRule: RecurrenceRule)

-removeAllRecurrenceRules

Removes all recurrence removes.

removeAllRecurrenceRules()

-save

Saves reminder.

Saves changes to a reminder, inserting it into the calendar if it is newly created.

save()

-remove

Removes reminder from calendar.

remove()

+scheduled

Fetches the schedule of reminders.

The fetched result contains reminders that are due today and reminders that are overdue. This is similar to the reminders shown in the Reminders apps "Scheduled" list. For performance reasons iOS limits fetched results to events within a four year timespan.

static scheduled(calendars: [Calendar]): Promise<[Reminder]>

+all

Fetches all reminders.

For performance reasons iOS limits fetched results to events within a four year timespan.

static all(calendars: [Calendar]): Promise<[Reminder]>

+allCompleted

Fetches all completed reminders.

For performance reasons iOS limits fetched results to events within a four year timespan.

static allCompleted(calendars: [Calendar]): Promise<[Reminder]>

+allIncomplete

Fetches all incomplete reminders.

For performance reasons iOS limits fetched results to events within a four year timespan.

static allIncomplete(calendars: [Calendar]): Promise<[Reminder]>

+allDueToday

Fetches all reminders due today.

static allDueToday(calendars: [Calendar]): Promise<[Reminder]>

+completedDueToday

Fetches completed reminders due today.

static completedDueToday(calendars: [Calendar]): Promise<[Reminder]>

+incompleteDueToday

Fetches incomplete reminders due today.

static incompleteDueToday(calendars: [Calendar]): Promise<[Reminder]>

+allDueTomorrow

Fetches all reminders due tomorrow.

static allDueTomorrow(calendars: [Calendar]): Promise<[Reminder]>

+completedDueTomorrow

Fetches completed reminders due tomorrow.

static completedDueTomorrow(calendars: [Calendar]): Promise<[Reminder]>

+incompleteDueTomorrow

Fetches incomplete reminders due tomorrow.

static incompleteDueTomorrow(calendars: [Calendar]): Promise<[Reminder]>

+allDueYesterday

Fetches all reminders due yesterday.

static allDueYesterday(calendars: [Calendar]): Promise<[Reminder]>

+completedDueYesterday

Fetches completed reminders due yesterday.

static completedDueYesterday(calendars: [Calendar]): Promise<[Reminder]>

+incompleteDueYesterday

Fetches incomplete reminders due yesterday.

static incompleteDueYesterday(calendars: [Calendar]): Promise<[Reminder]>

+allDueThisWeek

Fetches all reminders due this week.

static allDueThisWeek(calendars: [Calendar]): Promise<[Reminder]>

+completedDueThisWeek

Fetches completed reminders due this week.

static completedDueThisWeek(calendars: [Calendar]): Promise<[Reminder]>

+incompleteDueThisWeek

Fetches incomplete reminders due this week.

static incompleteDueThisWeek(calendars: [Calendar]): Promise<[Reminder]>

+allDueNextWeek

Fetches all reminders due next week.

static allDueNextWeek(calendars: [Calendar]): Promise<[Reminder]>

+completedDueNextWeek

Fetches completed reminders due next week.

static completedDueNextWeek(calendars: [Calendar]): Promise<[Reminder]>

+incompleteDueNextWeek

Fetches incomplete reminders due next week.

static incompleteDueNextWeek(calendars: [Calendar]): Promise<[Reminder]>

+allDueLastWeek

Fetches all reminders due last week.

static allDueLastWeek(calendars: [Calendar]): Promise<[Reminder]>

+completedDueLastWeek

Fetches completed reminders due last week.

static completedDueLastWeek(calendars: [Calendar]): Promise<[Reminder]>

+incompleteDueLastWeek

Fetches incomplete reminders due last week.

static incompleteDueLastWeek(calendars: [Calendar]): Promise<[Reminder]>

+completedToday

Fetches reminders completed today.

Note that this does not take the due date into account. This will return all reminders that you have completed today.

static completedToday(calendars: [Calendar]): Promise<[Reminder]>

+completedThisWeek

Fetches reminders completed this week.

Note that this does not take the due date into account. This will return all reminders that you have completed this week.

static completedThisWeek(calendars: [Calendar]): Promise<[Reminder]>

+completedLastWeek

Fetches reminders completed last week.

Note that this does not take the due date into account. This will return all reminders that you have completed last week.

static completedLastWeek(calendars: [Calendar]): Promise<[Reminder]>

+allDueBetween

Fetches due reminders.

Fetches reminders that are due within the time interval constituted by the start and end dates.

static allDueBetween(startDate: Date, endDate: Date, calendars: [Calendar]): Promise<[Reminder]>

+completedDueBetween

Fetches completed reminders.

Fetches reminders that are completed and that were due within the time interval constituted by the start and end dates.

static completedDueBetween(startDate: Date, endDate: Date, calendars: [Calendar]): Promise<[Reminder]>

+incompleteDueBetween

Fetches incomplete reminders.

Fetches reminders that are incomplete and that were due within the time interval constituted by the start and end dates.

static incompleteDueBetween(startDate: Date, endDate: Date, calendars: [Calendar]): Promise<[Reminder]>

+completedBetween

Fetches completed reminders.

Fetches reminders that were completed within the time interval constituted by the start and end dates.

static completedBetween(startDate: Date, endDate: Date, calendars: [Calendar]): Promise<[Reminder]>