Options
All
  • Public
  • Public/Protected
  • All
Menu

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

update

  • update(): 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

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc