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.

new Reminder()

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


-addRecurrenceRule

Adds a recurrence rule.

addRecurrenceRule(recurrenceRule: RecurrenceRule)

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

Parameters

recurrenceRule
RecurrenceRule
Recurrence rule to add to the reminder.


-removeAllRecurrenceRules

Removes all recurrence rules.

removeAllRecurrenceRules()

-save

Saves reminder.

save()

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


-remove

Removes reminder from calendar.

remove()

+scheduled

Fetches the schedule of reminders.

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

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.

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+all

Fetches all reminders.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allCompleted

Fetches all completed reminders.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allIncomplete

Fetches all incomplete reminders.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allDueToday

Fetches all reminders due today.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedDueToday

Fetches completed reminders due today.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+incompleteDueToday

Fetches incomplete reminders due today.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allDueTomorrow

Fetches all reminders due tomorrow.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedDueTomorrow

Fetches completed reminders due tomorrow.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+incompleteDueTomorrow

Fetches incomplete reminders due tomorrow.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allDueYesterday

Fetches all reminders due yesterday.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedDueYesterday

Fetches completed reminders due yesterday.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+incompleteDueYesterday

Fetches incomplete reminders due yesterday.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allDueThisWeek

Fetches all reminders due this week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedDueThisWeek

Fetches completed reminders due this week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+incompleteDueThisWeek

Fetches incomplete reminders due this week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allDueNextWeek

Fetches all reminders due next week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedDueNextWeek

Fetches completed reminders due next week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+incompleteDueNextWeek

Fetches incomplete reminders due next week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allDueLastWeek

Fetches all reminders due last week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedDueLastWeek

Fetches completed reminders due last week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+incompleteDueLastWeek

Fetches incomplete reminders due last week.

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedToday

Fetches reminders completed today.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedThisWeek

Fetches reminders completed this week.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedLastWeek

Fetches reminders completed last week.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+allDueBetween

Fetches due reminders.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedDueBetween

Fetches completed reminders.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+incompleteDueBetween

Fetches incomplete reminders.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.


+completedBetween

Fetches completed reminders.

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

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

Parameters

calendars
[Calendar]
Calendars to fetch reminders for. Defaults to all calendars.

Return value

Promise<[Reminder]>
Promise that provides the reminders when fulfilled.