rtm-api
Version:
Remember the Milk API Interface
2,310 lines (574 loc) • 28.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>RTMTask - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RTMClient.html">RTMClient</a><ul class='methods'><li data-type='method'><a href="RTMClient.html#get">get</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthToken">auth/getAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthUrl">auth/getAuthUrl</a></li><li data-type='method'><a href="RTMClient.html#~auth/verifyAuthToken">auth/verifyAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~user/create">user/create</a></li><li data-type='method'><a href="RTMClient.html#~user/export">user/export</a></li><li data-type='method'><a href="RTMClient.html#~user/exportToString">user/exportToString</a></li><li data-type='method'><a href="RTMClient.html#~user/import">user/import</a></li><li data-type='method'><a href="RTMClient.html#~user/importFromString">user/importFromString</a></li></ul></li><li><a href="RTMError.html">RTMError</a><ul class='methods'><li data-type='method'><a href="RTMError.html#.networkError">networkError</a></li><li data-type='method'><a href="RTMError.html#.rateLimitError">rateLimitError</a></li><li data-type='method'><a href="RTMError.html#.referenceError">referenceError</a></li><li data-type='method'><a href="RTMError.html#.responseError">responseError</a></li><li data-type='method'><a href="RTMError.html#.serverError">serverError</a></li><li data-type='method'><a href="RTMError.html#toString">toString</a></li></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMResponse.html">RTMResponse</a><ul class='methods'><li data-type='method'><a href="RTMResponse.html#has">has</a></li><li data-type='method'><a href="RTMResponse.html#toString">toString</a></li></ul></li><li><a href="RTMSuccess.html">RTMSuccess</a><ul class='methods'><li data-type='method'><a href="RTMSuccess.html#toString">toString</a></li></ul></li><li><a href="RTMTask.html">RTMTask</a></li><li><a href="RTMUser.html">RTMUser</a><ul class='methods'><li data-type='method'><a href="RTMUser.html#clearTaskIndexCache">clearTaskIndexCache</a></li><li data-type='method'><a href="RTMUser.html#get">get</a></li><li data-type='method'><a href="RTMUser.html#verifyAuthToken">verifyAuthToken</a></li><li data-type='method'><a href="RTMUser.html#~lists/add">lists/add</a></li><li data-type='method'><a href="RTMUser.html#~lists/archive">lists/archive</a></li><li data-type='method'><a href="RTMUser.html#~lists/get">lists/get</a></li><li data-type='method'><a href="RTMUser.html#~lists/remove">lists/remove</a></li><li data-type='method'><a href="RTMUser.html#~lists/rename">lists/rename</a></li><li data-type='method'><a href="RTMUser.html#~tasks/add">tasks/add</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addTags">tasks/addTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/complete">tasks/complete</a></li><li data-type='method'><a href="RTMUser.html#~tasks/decreasePriority">tasks/decreasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/get">tasks/get</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/increasePriority">tasks/increasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/move">tasks/move</a></li><li data-type='method'><a href="RTMUser.html#~tasks/postpone">tasks/postpone</a></li><li data-type='method'><a href="RTMUser.html#~tasks/priority">tasks/priority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/remove">tasks/remove</a></li><li data-type='method'><a href="RTMUser.html#~tasks/removeTags">tasks/removeTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setDueDate">tasks/setDueDate</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setName">tasks/setName</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setURL">tasks/setURL</a></li><li data-type='method'><a href="RTMUser.html#~tasks/uncomplete">tasks/uncomplete</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">RTMTask</h1>
<section>
<header>
<h2>
RTMTask
</h2>
<div class="class-description"><h3>RTM List</h3><p>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 <code>RTMTask</code> instances representing the
data (which will duplicate the TaskSeries properties).</p>
<p>Each instance of an <code>RTMTask</code> contains a <code>list_id</code>, <code>taskseries_id</code> and
<code>task_id</code> property.</p>
<p>All of the taskseries and task properties from the RTM API are directly
accessible as <code>RTMTask</code> properties.</p>
<pre class="prettyprint source"><code>let task = new RTMTask(..., ..., ...);
let name = task.name;
let priority = task.priority;</code></pre></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="RTMTask"><span class="type-signature"></span>new RTMTask<span class="signature">(userId, listId, series, task)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Create a new RTM Task</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>userId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>RTM User ID</p></td>
</tr>
<tr>
<td class="name"><code>listId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>RTM List ID</p></td>
</tr>
<tr>
<td class="name"><code>series</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Taskseries properties (resp.task.list[].taskseries[])</p></td>
</tr>
<tr>
<td class="name"><code>task</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Task properties (resp.task.list[].taskseries[].task)</p></td>
</tr>
</tbody>
</table>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="added"><span class="type-signature"></span>added<span class="type-signature"> :Date|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line154">line 154</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Added Date</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h4 class="name" id="completed"><span class="type-signature"></span>completed<span class="type-signature"> :Date|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line160">line 160</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Completed Date</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h4 class="name" id="created"><span class="type-signature"></span>created<span class="type-signature"> :Date|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Creation Date</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h4 class="name" id="deleted"><span class="type-signature"></span>deleted<span class="type-signature"> :Date|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line172">line 172</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Deleted Flag</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h4 class="name" id="due"><span class="type-signature"></span>due<span class="type-signature"> :Date|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line142">line 142</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Due Date</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h4 class="name" id="estimate"><span class="type-signature"></span>estimate<span class="type-signature"> :string|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line190">line 190</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Time Estimate</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h4 class="name" id="has_due_time"><span class="type-signature"></span>has_due_time<span class="type-signature"> :boolean</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line148">line 148</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Due Time Flag (true when <code>due</code> includes a Due Time)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<h4 class="name" id="index"><span class="type-signature"></span>index<span class="type-signature"> :int</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line203">line 203</a>
</li></ul></dd>
</dl>
<div class="description">
<p>An index added to each RTMTask based on the <code>task_id</code></p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">int</span>
</li>
</ul>
<h4 class="name" id="isCompleted"><span class="type-signature"></span>isCompleted<span class="type-signature"> :boolean</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line166">line 166</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Completed Flag (true when task is marked as completed)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<h4 class="name" id="list"><span class="type-signature"></span>list<span class="type-signature"> :<a href="RTMList.html">RTMList</a></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line211">line 211</a>
</li></ul></dd>
</dl>
<div class="description">
<p>The <code>RTMList</code> this Task is in</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="RTMList.html">RTMList</a></span>
</li>
</ul>
<h4 class="name" id="list_id"><span class="type-signature"></span>list_id<span class="type-signature"> :Number</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<div class="description">
<p>List ID</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<h4 class="name" id="location_id"><span class="type-signature"></span>location_id<span class="type-signature"> :number|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line87">line 87</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Location ID</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h4 class="name" id="modified"><span class="type-signature"></span>modified<span class="type-signature"> :Date|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line63">line 63</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Modification Date</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line69">line 69</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Name</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h4 class="name" id="notes"><span class="type-signature"></span>notes<span class="type-signature"> :Array.<<a href="RTMTask.html#~Note">RTMTask~Note</a>></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line119">line 119</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Notes</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="RTMTask.html#~Note">RTMTask~Note</a>></span>
</li>
</ul>
<h4 class="name" id="participants"><span class="type-signature"></span>participants<span class="type-signature"> :Array</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line102">line 102</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Participants</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array</span>
</li>
</ul>
<h4 class="name" id="postponed"><span class="type-signature"></span>postponed<span class="type-signature"> :boolean</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line184">line 184</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Postponed Flag</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<h4 class="name" id="priority"><span class="type-signature"></span>priority<span class="type-signature"> :int</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line178">line 178</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Priority (0, 1, 2, or 3)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">int</span>
</li>
</ul>
<h4 class="name" id="props"><span class="type-signature"></span>props<span class="type-signature"> :object</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line222">line 222</a>
</li></ul></dd>
</dl>
<div class="description">
<p>All of the RTM TaskSeries properties</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<h4 class="name" id="source"><span class="type-signature"></span>source<span class="type-signature"> :string</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Creation Source</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h4 class="name" id="tags"><span class="type-signature"></span>tags<span class="type-signature"> :Array.<string></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line93">line 93</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Tags</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<string></span>
</li>
</ul>
<h4 class="name" id="task_id"><span class="type-signature"></span>task_id<span class="type-signature"> :Number</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line136">line 136</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task ID</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<h4 class="name" id="taskseries_id"><span class="type-signature"></span>taskseries_id<span class="type-signature"> :Number</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<div class="description">
<p>TaskSeries ID</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"> :string|undefined</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line81">line 81</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Task Reference URL</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="~Note">Note</h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Note ID</p></td>
</tr>
<tr>
<td class="name"><code>created</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>Note Creation Date</p></td>
</tr>
<tr>
<td class="name"><code>modified</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>Note Modified Date</p></td>
</tr>
<tr>
<td class="name"><code>title</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Note Title</p></td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Note Body</p></td>
</tr>
</tbody>
</table>
<div class="description">
<p>Task Note</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 09 2019 17:57:03 GMT-0500 (EST) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>