Class ReminderList

ReminderList objects are used to manipulate and create lists in the built-in Reminders app.

Example

declare const  list = ReminderList.findOrCreate("Groceries");
let reminder = list.createReminder();
reminder.title = "Bananas";
reminder.notes = "Get slightly green ones."
reminder.update();

Hierarchy

  • ReminderList

Constructors

constructor

Properties

completeTasks incompleteTasks tasks title

Methods

createReminder update default find findOrCreate getAllReminderLists

Constructors

constructor

Properties

Readonly completeTasks

completeTasks: Reminder[]

Reminders in the list which have been marked completed.

Readonly incompleteTasks

incompleteTasks: Reminder[]

Reminders in the list which are NOT completed.

Readonly tasks

tasks: Reminder[]

All reminders in the list.

title

title: string

The name of the list.

Methods

createReminder

  • Create a new Reminder object in this list

    Returns Reminder

update

  • Save changes to the list.

    Returns boolean

Static default

Static find

  • Searches for a reminder lists matching the title. If none is found, return undefined.

    Parameters

    • title: string

    Returns ReminderList

Static findOrCreate

  • Searches for a list in the reminders app matching the title. If none is found, creates a new list with that title. If more than one list with the same name exist in Reminders, the first found will be returned.

    Parameters

    • title: string

    Returns ReminderList

Static getAllReminderLists

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc