Class: List

Models~List(properties)

List model

Constructor

new List(properties)

Parameters:
Name Type Description
properties Object Properties of the List
Properties
Name Type Attributes Default Description
id string <optional>
 ObjectID() Object ID of the list, only defined when this is an instantiation of a pre-existing list. On new lists this must be empty in order to generate a new ObjectID
name string Name of the list
isOwner bool <optional>
 True Whether the authenticated user is the owner of the list,defaults to true when creating new lists.
color string <optional>
 Color of the list
closed bool <optional>
 False Whether the list is closed
muted muted <optional>
 False Whether the list is muted
groupId string <optional>
 If the list belongs to a group, this is its id.
Source:

Methods

(async) addSimpleTask(title, contentopt, dateopt, isAllDayopt, reminders)

Adds a task to the current List
Parameters:
Name Type Attributes Description
title string Title of the task
content string <optional>
 Description of the task
date Date <optional>
 Date assigned to the task
isAllDay boolean <optional>
 Whether the task is assigned for date's entire day or the specifc time
reminders Array.<Reminder> Reminders of the task
Source:

(async, private) getCompletedTasks() → {Array.<Task>}

Get all tasks from the list that are completed
Source:
Returns:
Tasks with status equal to COMPLETED
Type
Array.<Task>

(async, private) getTodoTasks() → {Array.<Task>}

Get all tasks from the list that are uncompleted
Source:
Returns:
Tasks with status equal to TODO
Type
Array.<Task>