RTMTask

RTMTask

RTM List

This Class is used to represent the combined properties of an RTM TaskSeries combined with an RTM Task. If an RTM TaskSeries has more than one task property then there will be multiple RTMTask instances representing the data (which will duplicate the TaskSeries properties).

Each instance of an RTMTask contains a list_id, taskseries_id and task_id property.

All of the taskseries and task properties from the RTM API are directly accessible as RTMTask properties.

let task = new RTMTask(..., ..., ...);
let name = task.name;
let priority = task.priority;

Constructor

new RTMTask(userId, listId, series, task)

Source:

Create a new RTM Task

Parameters:
Name Type Description
userId number

RTM User ID
listId number

RTM List ID
series object

Taskseries properties (resp.task.list[].taskseries[])
task object

Task properties (resp.task.list[].taskseries[].task)

Members

added :Date|undefined

Source:

Task Added Date

Type:
  • Date | undefined

completed :Date|undefined

Source:

Task Completed Date

Type:
  • Date | undefined

created :Date|undefined

Source:

Task Creation Date

Type:
  • Date | undefined

deleted :Date|undefined

Source:

Task Deleted Flag

Type:
  • Date | undefined

due :Date|undefined

Source:

Task Due Date

Type:
  • Date | undefined

estimate :string|undefined

Source:

Task Time Estimate

Type:
  • string | undefined

has_due_time :boolean

Source:

Task Due Time Flag (true when due includes a Due Time)

Type:
  • boolean

has_start_time :boolean

Source:

Task Start Time Flag (true when start includes a Start Time)

Type:
  • boolean

index :int

Source:

An index added to each RTMTask based on the task_id

Type:
  • int

isCompleted :boolean

Source:

Task Completed Flag (true when task is marked as completed)

Type:
  • boolean

list :RTMList

Source:

The RTMList this Task is in

Type:

list_id :Number

Source:

List ID

Type:
  • Number

location_id :number|undefined

Source:

Task Location ID

Type:
  • number | undefined

modified :Date|undefined

Source:

Task Modification Date

Type:
  • Date | undefined

name :string

Source:

Task Name

Type:
  • string

notes :Array.<RTMTask~Note>

Source:

Task Notes

Type:

participants :Array

Source:

Task Participants

Type:
  • Array

postponed :boolean

Source:

Task Postponed Flag

Type:
  • boolean

priority :int

Source:

Task Priority (0, 1, 2, or 3)

Type:
  • int

props :object

Source:

All of the RTM TaskSeries properties

Type:
  • object

source :string

Source:

Task Creation Source

Type:
  • string

start :Date|undefined

Source:

Task Start Date

Type:
  • Date | undefined

tags :Array.<string>

Source:

Task Tags

Type:
  • Array.<string>

task_id :Number

Source:

Task ID

Type:
  • Number

taskseries_id :Number

Source:

TaskSeries ID

Type:
  • Number

url :string|undefined

Source:

Task Reference URL

Type:
  • string | undefined

Type Definitions

Note

Source:
Properties:
Name Type Description
id number

Note ID
created Date

Note Creation Date
modified Date

Note Modified Date
title string

Note Title
body string

Note Body

Task Note

Type:
  • Object