Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReminderList

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

Examples

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

Hierarchy

  • ReminderList

Index

Properties

completeTasks

completeTasks: Reminder[]

Reminders in the list which have been marked completed.

incompleteTasks

incompleteTasks: Reminder[]

Reminders in the list which are NOT completed.

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

  • update(): boolean
  • Save changes to the list.

    Returns boolean

Static default

  • Returns the system default reminder list configured for new reminders.

    Returns ReminderList

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

  • Get an array all known reminder lists on the device.

    Returns ReminderList[]

Generated using TypeDoc