@beauraines/rtm-api 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +285 -0
  3. package/config.js +22 -0
  4. package/docs/RTMClient.html +2798 -0
  5. package/docs/RTMError.html +1029 -0
  6. package/docs/RTMList.html +966 -0
  7. package/docs/RTMResponse.html +868 -0
  8. package/docs/RTMSuccess.html +337 -0
  9. package/docs/RTMTask.html +2461 -0
  10. package/docs/RTMUser.html +6761 -0
  11. package/docs/client_auth.js.html +123 -0
  12. package/docs/client_index.js.html +241 -0
  13. package/docs/client_user.js.html +170 -0
  14. package/docs/global.html +386 -0
  15. package/docs/index.html +305 -0
  16. package/docs/list_index.js.html +159 -0
  17. package/docs/response_error.js.html +172 -0
  18. package/docs/response_response.js.html +160 -0
  19. package/docs/response_success.js.html +104 -0
  20. package/docs/scripts/linenumber.js +25 -0
  21. package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
  22. package/docs/scripts/prettify/lang-css.js +2 -0
  23. package/docs/scripts/prettify/prettify.js +28 -0
  24. package/docs/styles/jsdoc.css +664 -0
  25. package/docs/styles/prettify.css +79 -0
  26. package/docs/task_helper.js.html +531 -0
  27. package/docs/task_index.js.html +304 -0
  28. package/docs/user_index.js.html +347 -0
  29. package/docs/user_lists.js.html +208 -0
  30. package/docs/user_tasks.js.html +703 -0
  31. package/jsdoc.json +13 -0
  32. package/package.json +33 -0
  33. package/src/client/auth.js +65 -0
  34. package/src/client/index.js +182 -0
  35. package/src/client/user.js +112 -0
  36. package/src/list/helper.js +131 -0
  37. package/src/list/index.js +101 -0
  38. package/src/response/error.js +114 -0
  39. package/src/response/index.js +8 -0
  40. package/src/response/parse.js +51 -0
  41. package/src/response/response.js +102 -0
  42. package/src/response/success.js +46 -0
  43. package/src/task/helper.js +469 -0
  44. package/src/task/index.js +264 -0
  45. package/src/user/index.js +288 -0
  46. package/src/user/lists.js +150 -0
  47. package/src/user/tasks.js +708 -0
  48. package/src/utils/auth.js +188 -0
  49. package/src/utils/fetch.js +67 -0
  50. package/src/utils/get.js +247 -0
  51. package/src/utils/sign.js +93 -0
  52. package/src/utils/taskIds.js +188 -0
package/docs/RTMClient.html ADDED
@@ -0,0 +1,2798 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>RTMClient - Documentation</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
14
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
+ </head>
16
+ <body>
17
+
18
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
19
+ <label for="nav-trigger" class="navicon-button x">
20
+ <div class="navicon"></div>
21
+ </label>
22
+
23
+ <label for="nav-trigger" class="overlay"></label>
24
+
25
+ <nav>
26
+ <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/addNotes">tasks/addNotes</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><h3>Global</h3><ul><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
27
+ </nav>
28
+
29
+ <div id="main">
30
+
31
+ <h1 class="page-title">RTMClient</h1>
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+ <section>
40
+
41
+ <header>
42
+
43
+ <h2>
44
+ RTMClient
45
+ </h2>
46
+
47
+ <div class="class-description"><h3>RTM API Client</h3>
48
+ <p>This Class is used to represent an RTM API Client. The Client contains
49
+ the API Key, API Secret and access permissions used to access the
50
+ RTM API endpoints.</p>
51
+ <p>It also includes API wrapper functions for making a general RTM API request
52
+ as well as the auth-related functions.</p>
53
+ <h4>Usage</h4>
54
+ <p>The <code>RTMClient</code> Class is what is exported when the entire <code>rtm-api</code> module
55
+ is loaded via <code>require</code>.</p>
56
+ <pre class="prettyprint source"><code>const RTM = require('rtm-api');
57
+ let client = new RTM(API_KEY, API_SECRET, RTM.PERM_DELETE);
58
+ </code></pre>
59
+ <h4>Auth Example</h4>
60
+ <p>This example gets an Auth URL to be opened by the RTM User</p>
61
+ <pre class="prettyprint source"><code>client.auth.getAuthUrl(function(err, authUrl, frob) {
62
+ // Have user authenticate and authorize the program with the authUrl
63
+ // Once authorized by the user, use the frob to get an authToken
64
+ )};
65
+ </code></pre>
66
+ <h4>RTM API Example</h4>
67
+ <p>This example makes an RTM API request using the method <code>rtm.method</code> and the
68
+ parameter foo=bar.</p>
69
+ <pre class="prettyprint source"><code>client.get('rtm.method', {foo: &quot;bar&quot;}, function(err, resp) {
70
+ if ( err ) {
71
+ // handle error
72
+ }
73
+ // use the response
74
+ });
75
+ </code></pre>
76
+ <p>See <a href="RTMUser.html#get">RTMUser.get</a> for making User-authenticated API requests.</p></div>
77
+
78
+
79
+ </header>
80
+
81
+ <article>
82
+ <div class="container-overview">
83
+
84
+
85
+
86
+
87
+ <h2>Constructor</h2>
88
+
89
+
90
+ <h4 class="name" id="RTMClient"><span class="type-signature"></span>new RTMClient<span class="signature">(key, secret, perms<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl class="details">
98
+
99
+
100
+ <dt class="tag-source">Source:</dt>
101
+ <dd class="tag-source"><ul class="dummy"><li>
102
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line53">line 53</a>
103
+ </li></ul></dd>
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ </dl>
136
+
137
+
138
+
139
+
140
+
141
+ <div class="description">
142
+ <p>Create a new RTM Client with the specified API access information</p>
143
+ </div>
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+ <h5>Parameters:</h5>
156
+
157
+
158
+ <table class="params">
159
+ <thead>
160
+ <tr>
161
+
162
+ <th>Name</th>
163
+
164
+
165
+ <th>Type</th>
166
+
167
+
168
+ <th>Attributes</th>
169
+
170
+
171
+
172
+ <th>Default</th>
173
+
174
+
175
+ <th class="last">Description</th>
176
+ </tr>
177
+ </thead>
178
+
179
+ <tbody>
180
+
181
+
182
+ <tr>
183
+
184
+ <td class="name"><code>key</code></td>
185
+
186
+
187
+ <td class="type">
188
+
189
+
190
+ <span class="param-type">string</span>
191
+
192
+
193
+
194
+ </td>
195
+
196
+
197
+ <td class="attributes">
198
+
199
+
200
+
201
+
202
+
203
+ </td>
204
+
205
+
206
+
207
+ <td class="default">
208
+
209
+ </td>
210
+
211
+
212
+ <td class="description last"><p>RTM API Client Key</p></td>
213
+ </tr>
214
+
215
+
216
+
217
+ <tr>
218
+
219
+ <td class="name"><code>secret</code></td>
220
+
221
+
222
+ <td class="type">
223
+
224
+
225
+ <span class="param-type">string</span>
226
+
227
+
228
+
229
+ </td>
230
+
231
+
232
+ <td class="attributes">
233
+
234
+
235
+
236
+
237
+
238
+ </td>
239
+
240
+
241
+
242
+ <td class="default">
243
+
244
+ </td>
245
+
246
+
247
+ <td class="description last"><p>RTM API Client Secret</p></td>
248
+ </tr>
249
+
250
+
251
+
252
+ <tr>
253
+
254
+ <td class="name"><code>perms</code></td>
255
+
256
+
257
+ <td class="type">
258
+
259
+
260
+ <span class="param-type">string</span>
261
+
262
+
263
+
264
+ </td>
265
+
266
+
267
+ <td class="attributes">
268
+
269
+ &lt;optional><br>
270
+
271
+
272
+
273
+
274
+
275
+ </td>
276
+
277
+
278
+
279
+ <td class="default">
280
+
281
+ <code>RTMClient.PERM_READ</code>
282
+
283
+ </td>
284
+
285
+
286
+ <td class="description last"><p>RTM API Client Access Permissions. This
287
+ should be one of <a href="RTMClient.html#.PERM_READ">RTMClient.PERM_READ</a>, <a href="RTMClient.html#.PERM_WRITE">RTMClient.PERM_WRITE</a> or
288
+ <a href="RTMClient.html#.PERM_DELETE">RTMClient.PERM_DELETE</a>.</p></td>
289
+ </tr>
290
+
291
+
292
+ </tbody>
293
+ </table>
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+ </div>
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+ <h3 class="subsection-title">Members</h3>
325
+
326
+
327
+
328
+ <h4 class="name" id=".PERM_DELETE"><span class="type-signature">(static) </span>PERM_DELETE<span class="type-signature"> :string</span></h4>
329
+
330
+
331
+
332
+
333
+
334
+ <dl class="details">
335
+
336
+
337
+ <dt class="tag-source">Source:</dt>
338
+ <dd class="tag-source"><ul class="dummy"><li>
339
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line178">line 178</a>
340
+ </li></ul></dd>
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+ <dt class="tag-default">Default Value:</dt>
367
+ <dd class="tag-default"><ul class="dummy">
368
+ <li>delete</li>
369
+ </ul></dd>
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+ </dl>
378
+
379
+
380
+
381
+
382
+
383
+ <div class="description">
384
+ <p>RTM API Access: <code>delete</code> -
385
+ gives the ability to delete task, contacts, groups and list (also allows
386
+ you to <code>read</code> and <code>write</code>).</p>
387
+ </div>
388
+
389
+
390
+
391
+ <h5>Type:</h5>
392
+ <ul>
393
+ <li>
394
+
395
+ <span class="param-type">string</span>
396
+
397
+
398
+ </li>
399
+ </ul>
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+ <h4 class="name" id=".PERM_READ"><span class="type-signature">(static) </span>PERM_READ<span class="type-signature"> :string</span></h4>
409
+
410
+
411
+
412
+
413
+
414
+ <dl class="details">
415
+
416
+
417
+ <dt class="tag-source">Source:</dt>
418
+ <dd class="tag-source"><ul class="dummy"><li>
419
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line160">line 160</a>
420
+ </li></ul></dd>
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+ <dt class="tag-default">Default Value:</dt>
447
+ <dd class="tag-default"><ul class="dummy">
448
+ <li>read</li>
449
+ </ul></dd>
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+ </dl>
458
+
459
+
460
+
461
+
462
+
463
+ <div class="description">
464
+ <p>RTM API Access: <code>read</code> -
465
+ gives the ability to read task, contact, group and list details and contents.</p>
466
+ </div>
467
+
468
+
469
+
470
+ <h5>Type:</h5>
471
+ <ul>
472
+ <li>
473
+
474
+ <span class="param-type">string</span>
475
+
476
+
477
+ </li>
478
+ </ul>
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+ <h4 class="name" id=".PERM_WRITE"><span class="type-signature">(static) </span>PERM_WRITE<span class="type-signature"> :string</span></h4>
488
+
489
+
490
+
491
+
492
+
493
+ <dl class="details">
494
+
495
+
496
+ <dt class="tag-source">Source:</dt>
497
+ <dd class="tag-source"><ul class="dummy"><li>
498
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line169">line 169</a>
499
+ </li></ul></dd>
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+ <dt class="tag-default">Default Value:</dt>
526
+ <dd class="tag-default"><ul class="dummy">
527
+ <li>write</li>
528
+ </ul></dd>
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+ </dl>
537
+
538
+
539
+
540
+
541
+
542
+ <div class="description">
543
+ <p>RTM API Access: <code>write</code> -
544
+ gives the ability to add and modify task, contact, group and list details and
545
+ contents (also allows you to <code>read</code>).</p>
546
+ </div>
547
+
548
+
549
+
550
+ <h5>Type:</h5>
551
+ <ul>
552
+ <li>
553
+
554
+ <span class="param-type">string</span>
555
+
556
+
557
+ </li>
558
+ </ul>
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+ <h4 class="name" id="auth"><span class="type-signature"></span>auth<span class="type-signature"></span></h4>
568
+
569
+
570
+
571
+
572
+
573
+ <dl class="details">
574
+
575
+
576
+ <dt class="tag-source">Source:</dt>
577
+ <dd class="tag-source"><ul class="dummy"><li>
578
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line144">line 144</a>
579
+ </li></ul></dd>
580
+
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+ </dl>
612
+
613
+
614
+
615
+
616
+
617
+ <div class="description">
618
+ <p>Auth-related functions:</p>
619
+ <ul>
620
+ <li><a href="RTMClient.html#~auth/getAuthUrl">getAuthUrl</a></li>
621
+ <li><a href="RTMClient.html#~auth/getAuthToken">getAuthToken</a></li>
622
+ <li><a href="RTMClient.html#~auth/verifyAuthToken">verifyAuthToken</a></li>
623
+ </ul>
624
+ </div>
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+ <h4 class="name" id="key"><span class="type-signature"></span>key<span class="type-signature"> :string</span></h4>
636
+
637
+
638
+
639
+
640
+
641
+ <dl class="details">
642
+
643
+
644
+ <dt class="tag-source">Source:</dt>
645
+ <dd class="tag-source"><ul class="dummy"><li>
646
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line75">line 75</a>
647
+ </li></ul></dd>
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+ </dl>
680
+
681
+
682
+
683
+
684
+
685
+ <div class="description">
686
+ <p>RTM API Client Key</p>
687
+ </div>
688
+
689
+
690
+
691
+ <h5>Type:</h5>
692
+ <ul>
693
+ <li>
694
+
695
+ <span class="param-type">string</span>
696
+
697
+
698
+ </li>
699
+ </ul>
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+ <h4 class="name" id="perms"><span class="type-signature"></span>perms<span class="type-signature"> :string</span></h4>
709
+
710
+
711
+
712
+
713
+
714
+ <dl class="details">
715
+
716
+
717
+ <dt class="tag-source">Source:</dt>
718
+ <dd class="tag-source"><ul class="dummy"><li>
719
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line91">line 91</a>
720
+ </li></ul></dd>
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+ </dl>
753
+
754
+
755
+
756
+
757
+
758
+ <div class="description">
759
+ <p>RTM API Client Access Permissions</p>
760
+ </div>
761
+
762
+
763
+
764
+ <h5>Type:</h5>
765
+ <ul>
766
+ <li>
767
+
768
+ <span class="param-type">string</span>
769
+
770
+
771
+ </li>
772
+ </ul>
773
+
774
+
775
+
776
+
777
+
778
+
779
+
780
+
781
+ <h4 class="name" id="secret"><span class="type-signature"></span>secret<span class="type-signature"> :string</span></h4>
782
+
783
+
784
+
785
+
786
+
787
+ <dl class="details">
788
+
789
+
790
+ <dt class="tag-source">Source:</dt>
791
+ <dd class="tag-source"><ul class="dummy"><li>
792
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line83">line 83</a>
793
+ </li></ul></dd>
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+
825
+ </dl>
826
+
827
+
828
+
829
+
830
+
831
+ <div class="description">
832
+ <p>RTM API Client Secret</p>
833
+ </div>
834
+
835
+
836
+
837
+ <h5>Type:</h5>
838
+ <ul>
839
+ <li>
840
+
841
+ <span class="param-type">string</span>
842
+
843
+
844
+ </li>
845
+ </ul>
846
+
847
+
848
+
849
+
850
+
851
+
852
+
853
+
854
+ <h4 class="name" id="user"><span class="type-signature"></span>user<span class="type-signature"></span></h4>
855
+
856
+
857
+
858
+
859
+
860
+ <dl class="details">
861
+
862
+
863
+ <dt class="tag-source">Source:</dt>
864
+ <dd class="tag-source"><ul class="dummy"><li>
865
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line108">line 108</a>
866
+ </li></ul></dd>
867
+
868
+
869
+
870
+
871
+
872
+
873
+
874
+
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+
898
+ </dl>
899
+
900
+
901
+
902
+
903
+
904
+ <div class="description">
905
+ <p>User export/import-related functions:</p>
906
+ <ul>
907
+ <li><a href="RTMClient.html#~user/create">create</a></li>
908
+ <li><a href="RTMClient.html#~user/export">export</a></li>
909
+ <li><a href="RTMClient.html#~user/exportToString">exportToString</a></li>
910
+ <li><a href="RTMClient.html#~user/import">import</a></li>
911
+ <li><a href="RTMClient.html#~user/importFromString">importFromString</a></li>
912
+ </ul>
913
+ </div>
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+ <h3 class="subsection-title">Methods</h3>
927
+
928
+
929
+
930
+
931
+
932
+
933
+ <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(method, params<span class="signature-attributes">opt</span>, user<span class="signature-attributes">opt</span>, callback)</span><span class="type-signature"></span></h4>
934
+
935
+
936
+
937
+
938
+
939
+
940
+ <dl class="details">
941
+
942
+
943
+ <dt class="tag-source">Source:</dt>
944
+ <dd class="tag-source"><ul class="dummy"><li>
945
+ <a href="client_index.js.html">client/index.js</a>, <a href="client_index.js.html#line133">line 133</a>
946
+ </li></ul></dd>
947
+
948
+
949
+
950
+
951
+
952
+
953
+
954
+
955
+
956
+
957
+
958
+
959
+
960
+
961
+
962
+
963
+
964
+
965
+
966
+
967
+
968
+
969
+
970
+
971
+
972
+
973
+
974
+
975
+
976
+
977
+
978
+ </dl>
979
+
980
+
981
+
982
+
983
+
984
+ <div class="description">
985
+ <p>Make the specified RTM API call.</p>
986
+ <p>The <code>method</code> should be the name of the RTM API method. Any necessary
987
+ parameters should be provided with <code>params</code> as an object with the properties
988
+ of the object as the parameters' key/value pairs.</p>
989
+ <p>RTM API methods that require an AuthToken should set the <code>params</code> <code>auth_token</code>
990
+ property or provide a valid <code>RTMUser</code> with an AuthToken.</p>
991
+ </div>
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+ <h5>Parameters:</h5>
1004
+
1005
+
1006
+ <table class="params">
1007
+ <thead>
1008
+ <tr>
1009
+
1010
+ <th>Name</th>
1011
+
1012
+
1013
+ <th>Type</th>
1014
+
1015
+
1016
+ <th>Attributes</th>
1017
+
1018
+
1019
+
1020
+
1021
+ <th class="last">Description</th>
1022
+ </tr>
1023
+ </thead>
1024
+
1025
+ <tbody>
1026
+
1027
+
1028
+ <tr>
1029
+
1030
+ <td class="name"><code>method</code></td>
1031
+
1032
+
1033
+ <td class="type">
1034
+
1035
+
1036
+ <span class="param-type">string</span>
1037
+
1038
+
1039
+
1040
+ </td>
1041
+
1042
+
1043
+ <td class="attributes">
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+ </td>
1050
+
1051
+
1052
+
1053
+
1054
+ <td class="description last"><p>RTM API Method</p></td>
1055
+ </tr>
1056
+
1057
+
1058
+
1059
+ <tr>
1060
+
1061
+ <td class="name"><code>params</code></td>
1062
+
1063
+
1064
+ <td class="type">
1065
+
1066
+
1067
+ <span class="param-type">object</span>
1068
+
1069
+
1070
+
1071
+ </td>
1072
+
1073
+
1074
+ <td class="attributes">
1075
+
1076
+ &lt;optional><br>
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+ </td>
1083
+
1084
+
1085
+
1086
+
1087
+ <td class="description last"><p>RTM Method Parameters (as an object with key/value pairs)</p></td>
1088
+ </tr>
1089
+
1090
+
1091
+
1092
+ <tr>
1093
+
1094
+ <td class="name"><code>user</code></td>
1095
+
1096
+
1097
+ <td class="type">
1098
+
1099
+
1100
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
1101
+
1102
+
1103
+
1104
+ </td>
1105
+
1106
+
1107
+ <td class="attributes">
1108
+
1109
+ &lt;optional><br>
1110
+
1111
+
1112
+
1113
+
1114
+
1115
+ </td>
1116
+
1117
+
1118
+
1119
+
1120
+ <td class="description last"><p>The RTM User making the request</p></td>
1121
+ </tr>
1122
+
1123
+
1124
+
1125
+ <tr>
1126
+
1127
+ <td class="name"><code>callback</code></td>
1128
+
1129
+
1130
+ <td class="type">
1131
+
1132
+
1133
+ <span class="param-type">function</span>
1134
+
1135
+
1136
+
1137
+ </td>
1138
+
1139
+
1140
+ <td class="attributes">
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+ </td>
1147
+
1148
+
1149
+
1150
+
1151
+ <td class="description last"><p>Callback function(err, resp)</p>
1152
+ <h6>Properties</h6>
1153
+
1154
+
1155
+ <table class="params">
1156
+ <thead>
1157
+ <tr>
1158
+
1159
+ <th>Name</th>
1160
+
1161
+
1162
+ <th>Type</th>
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+ <th class="last">Description</th>
1169
+ </tr>
1170
+ </thead>
1171
+
1172
+ <tbody>
1173
+
1174
+
1175
+ <tr>
1176
+
1177
+ <td class="name"><code>err</code></td>
1178
+
1179
+
1180
+ <td class="type">
1181
+
1182
+
1183
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
1184
+
1185
+
1186
+
1187
+ </td>
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+ <td class="description last"><p>RTM Error Response, if encountered</p></td>
1194
+ </tr>
1195
+
1196
+
1197
+
1198
+ <tr>
1199
+
1200
+ <td class="name"><code>resp</code></td>
1201
+
1202
+
1203
+ <td class="type">
1204
+
1205
+
1206
+ <span class="param-type"><a href="RTMSuccess.html">RTMSuccess</a></span>
1207
+
1208
+
1209
+
1210
+ </td>
1211
+
1212
+
1213
+
1214
+
1215
+
1216
+ <td class="description last"><p>The parsed RTM API Response, if successful</p></td>
1217
+ </tr>
1218
+
1219
+
1220
+ </tbody>
1221
+ </table>
1222
+
1223
+ </td>
1224
+ </tr>
1225
+
1226
+
1227
+ </tbody>
1228
+ </table>
1229
+
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+ <h4 class="name" id="~auth/getAuthToken"><span class="type-signature">(inner) </span>auth/getAuthToken<span class="signature">(frob, callback)</span><span class="type-signature"></span></h4>
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+ <dl class="details">
1258
+
1259
+
1260
+ <dt class="tag-source">Source:</dt>
1261
+ <dd class="tag-source"><ul class="dummy"><li>
1262
+ <a href="client_auth.js.html">client/auth.js</a>, <a href="client_auth.js.html#line31">line 31</a>
1263
+ </li></ul></dd>
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+
1291
+
1292
+
1293
+
1294
+
1295
+ </dl>
1296
+
1297
+
1298
+
1299
+
1300
+
1301
+ <div class="description">
1302
+ <p>Get an Auth Token.</p>
1303
+ <p>This function takes the frob that was generated by <code>getAuthUrl()</code> and
1304
+ requests an Auth Token. The callback function will return an <code>RTMUser</code>
1305
+ which will include the RTM User's information and an Auth Token to be
1306
+ used in future API calls.</p>
1307
+ </div>
1308
+
1309
+
1310
+
1311
+
1312
+
1313
+
1314
+
1315
+
1316
+
1317
+
1318
+
1319
+ <h5>Parameters:</h5>
1320
+
1321
+
1322
+ <table class="params">
1323
+ <thead>
1324
+ <tr>
1325
+
1326
+ <th>Name</th>
1327
+
1328
+
1329
+ <th>Type</th>
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+ <th class="last">Description</th>
1336
+ </tr>
1337
+ </thead>
1338
+
1339
+ <tbody>
1340
+
1341
+
1342
+ <tr>
1343
+
1344
+ <td class="name"><code>frob</code></td>
1345
+
1346
+
1347
+ <td class="type">
1348
+
1349
+
1350
+ <span class="param-type">string</span>
1351
+
1352
+
1353
+
1354
+ </td>
1355
+
1356
+
1357
+
1358
+
1359
+
1360
+ <td class="description last"><p>Auth Frob from <code>getAuthUrl()</code></p></td>
1361
+ </tr>
1362
+
1363
+
1364
+
1365
+ <tr>
1366
+
1367
+ <td class="name"><code>callback</code></td>
1368
+
1369
+
1370
+ <td class="type">
1371
+
1372
+
1373
+ <span class="param-type">function</span>
1374
+
1375
+
1376
+
1377
+ </td>
1378
+
1379
+
1380
+
1381
+
1382
+
1383
+ <td class="description last"><p>Callback function(err, user)</p>
1384
+ <h6>Properties</h6>
1385
+
1386
+
1387
+ <table class="params">
1388
+ <thead>
1389
+ <tr>
1390
+
1391
+ <th>Name</th>
1392
+
1393
+
1394
+ <th>Type</th>
1395
+
1396
+
1397
+
1398
+
1399
+
1400
+ <th class="last">Description</th>
1401
+ </tr>
1402
+ </thead>
1403
+
1404
+ <tbody>
1405
+
1406
+
1407
+ <tr>
1408
+
1409
+ <td class="name"><code>err</code></td>
1410
+
1411
+
1412
+ <td class="type">
1413
+
1414
+
1415
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
1416
+
1417
+
1418
+
1419
+ </td>
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+ <td class="description last"><p>RTM Error Response, if encountered</p></td>
1426
+ </tr>
1427
+
1428
+
1429
+
1430
+ <tr>
1431
+
1432
+ <td class="name"><code>user</code></td>
1433
+
1434
+
1435
+ <td class="type">
1436
+
1437
+
1438
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
1439
+
1440
+
1441
+
1442
+ </td>
1443
+
1444
+
1445
+
1446
+
1447
+
1448
+ <td class="description last"><p>RTM User, with user information and auth token</p></td>
1449
+ </tr>
1450
+
1451
+
1452
+ </tbody>
1453
+ </table>
1454
+
1455
+ </td>
1456
+ </tr>
1457
+
1458
+
1459
+ </tbody>
1460
+ </table>
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+
1468
+
1469
+
1470
+
1471
+
1472
+
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+
1479
+
1480
+
1481
+
1482
+ <h4 class="name" id="~auth/getAuthUrl"><span class="type-signature">(inner) </span>auth/getAuthUrl<span class="signature">(callback)</span><span class="type-signature"></span></h4>
1483
+
1484
+
1485
+
1486
+
1487
+
1488
+
1489
+ <dl class="details">
1490
+
1491
+
1492
+ <dt class="tag-source">Source:</dt>
1493
+ <dd class="tag-source"><ul class="dummy"><li>
1494
+ <a href="client_auth.js.html">client/auth.js</a>, <a href="client_auth.js.html#line15">line 15</a>
1495
+ </li></ul></dd>
1496
+
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+
1516
+
1517
+
1518
+
1519
+
1520
+
1521
+
1522
+
1523
+
1524
+
1525
+
1526
+
1527
+ </dl>
1528
+
1529
+
1530
+
1531
+
1532
+
1533
+ <div class="description">
1534
+ <p>Get an Auth URL.</p>
1535
+ <p>This function will generate an Auth URL that will be given to the RTM User
1536
+ to authorize the RTM Client to access their account. It will also request
1537
+ a frob that will be used to gain an auth token in <code>getAuthToken()</code>.</p>
1538
+ </div>
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+ <h5>Parameters:</h5>
1551
+
1552
+
1553
+ <table class="params">
1554
+ <thead>
1555
+ <tr>
1556
+
1557
+ <th>Name</th>
1558
+
1559
+
1560
+ <th>Type</th>
1561
+
1562
+
1563
+
1564
+
1565
+
1566
+ <th class="last">Description</th>
1567
+ </tr>
1568
+ </thead>
1569
+
1570
+ <tbody>
1571
+
1572
+
1573
+ <tr>
1574
+
1575
+ <td class="name"><code>callback</code></td>
1576
+
1577
+
1578
+ <td class="type">
1579
+
1580
+
1581
+ <span class="param-type">function</span>
1582
+
1583
+
1584
+
1585
+ </td>
1586
+
1587
+
1588
+
1589
+
1590
+
1591
+ <td class="description last"><p>Callback function(err, authUrl, frob)</p>
1592
+ <h6>Properties</h6>
1593
+
1594
+
1595
+ <table class="params">
1596
+ <thead>
1597
+ <tr>
1598
+
1599
+ <th>Name</th>
1600
+
1601
+
1602
+ <th>Type</th>
1603
+
1604
+
1605
+
1606
+
1607
+
1608
+ <th class="last">Description</th>
1609
+ </tr>
1610
+ </thead>
1611
+
1612
+ <tbody>
1613
+
1614
+
1615
+ <tr>
1616
+
1617
+ <td class="name"><code>err</code></td>
1618
+
1619
+
1620
+ <td class="type">
1621
+
1622
+
1623
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
1624
+
1625
+
1626
+
1627
+ </td>
1628
+
1629
+
1630
+
1631
+
1632
+
1633
+ <td class="description last"><p>RTM Error Response, if encountered</p></td>
1634
+ </tr>
1635
+
1636
+
1637
+
1638
+ <tr>
1639
+
1640
+ <td class="name"><code>authUrl</code></td>
1641
+
1642
+
1643
+ <td class="type">
1644
+
1645
+
1646
+ <span class="param-type">string</span>
1647
+
1648
+
1649
+
1650
+ </td>
1651
+
1652
+
1653
+
1654
+
1655
+
1656
+ <td class="description last"><p>Auth URL to be given to User</p></td>
1657
+ </tr>
1658
+
1659
+
1660
+
1661
+ <tr>
1662
+
1663
+ <td class="name"><code>frob</code></td>
1664
+
1665
+
1666
+ <td class="type">
1667
+
1668
+
1669
+ <span class="param-type">string</span>
1670
+
1671
+
1672
+
1673
+ </td>
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+ <td class="description last"><p>Auth Frob to be used in <code>getAuthToken()</code></p></td>
1680
+ </tr>
1681
+
1682
+
1683
+ </tbody>
1684
+ </table>
1685
+
1686
+ </td>
1687
+ </tr>
1688
+
1689
+
1690
+ </tbody>
1691
+ </table>
1692
+
1693
+
1694
+
1695
+
1696
+
1697
+
1698
+
1699
+
1700
+
1701
+
1702
+
1703
+
1704
+
1705
+
1706
+
1707
+
1708
+
1709
+
1710
+
1711
+
1712
+
1713
+ <h4 class="name" id="~auth/verifyAuthToken"><span class="type-signature">(inner) </span>auth/verifyAuthToken<span class="signature">(token, callback)</span><span class="type-signature"></span></h4>
1714
+
1715
+
1716
+
1717
+
1718
+
1719
+
1720
+ <dl class="details">
1721
+
1722
+
1723
+ <dt class="tag-source">Source:</dt>
1724
+ <dd class="tag-source"><ul class="dummy"><li>
1725
+ <a href="client_auth.js.html">client/auth.js</a>, <a href="client_auth.js.html#line48">line 48</a>
1726
+ </li></ul></dd>
1727
+
1728
+
1729
+
1730
+
1731
+
1732
+
1733
+
1734
+
1735
+
1736
+
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+
1743
+
1744
+
1745
+
1746
+
1747
+
1748
+
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+
1755
+
1756
+
1757
+
1758
+ </dl>
1759
+
1760
+
1761
+
1762
+
1763
+
1764
+ <div class="description">
1765
+ <p>Verify Auth Token.</p>
1766
+ <p>This function will check if the User's Auth Token is still valid and
1767
+ can be used to make authenticated RTM API requests.</p>
1768
+ </div>
1769
+
1770
+
1771
+
1772
+
1773
+
1774
+
1775
+
1776
+
1777
+
1778
+
1779
+
1780
+ <h5>Parameters:</h5>
1781
+
1782
+
1783
+ <table class="params">
1784
+ <thead>
1785
+ <tr>
1786
+
1787
+ <th>Name</th>
1788
+
1789
+
1790
+ <th>Type</th>
1791
+
1792
+
1793
+
1794
+
1795
+
1796
+ <th class="last">Description</th>
1797
+ </tr>
1798
+ </thead>
1799
+
1800
+ <tbody>
1801
+
1802
+
1803
+ <tr>
1804
+
1805
+ <td class="name"><code>token</code></td>
1806
+
1807
+
1808
+ <td class="type">
1809
+
1810
+
1811
+ <span class="param-type">string</span>
1812
+ |
1813
+
1814
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
1815
+
1816
+
1817
+
1818
+ </td>
1819
+
1820
+
1821
+
1822
+
1823
+
1824
+ <td class="description last"><p>Auth Token or RTMUser containing an auth token</p></td>
1825
+ </tr>
1826
+
1827
+
1828
+
1829
+ <tr>
1830
+
1831
+ <td class="name"><code>callback</code></td>
1832
+
1833
+
1834
+ <td class="type">
1835
+
1836
+
1837
+ <span class="param-type">function</span>
1838
+
1839
+
1840
+
1841
+ </td>
1842
+
1843
+
1844
+
1845
+
1846
+
1847
+ <td class="description last"><p>Callback function(err, verified)</p>
1848
+ <h6>Properties</h6>
1849
+
1850
+
1851
+ <table class="params">
1852
+ <thead>
1853
+ <tr>
1854
+
1855
+ <th>Name</th>
1856
+
1857
+
1858
+ <th>Type</th>
1859
+
1860
+
1861
+
1862
+
1863
+
1864
+ <th class="last">Description</th>
1865
+ </tr>
1866
+ </thead>
1867
+
1868
+ <tbody>
1869
+
1870
+
1871
+ <tr>
1872
+
1873
+ <td class="name"><code>err</code></td>
1874
+
1875
+
1876
+ <td class="type">
1877
+
1878
+
1879
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
1880
+
1881
+
1882
+
1883
+ </td>
1884
+
1885
+
1886
+
1887
+
1888
+
1889
+ <td class="description last"><p>RTM Error, if encountered (excluding a <code>Login failed / Invalid auth token</code> error)</p></td>
1890
+ </tr>
1891
+
1892
+
1893
+
1894
+ <tr>
1895
+
1896
+ <td class="name"><code>verified</code></td>
1897
+
1898
+
1899
+ <td class="type">
1900
+
1901
+
1902
+ <span class="param-type">boolean</span>
1903
+
1904
+
1905
+
1906
+ </td>
1907
+
1908
+
1909
+
1910
+
1911
+
1912
+ <td class="description last"><p><code>true</code> if the User's auth token was successfully verified or <code>false</code> if
1913
+ a <code>Login failed / Invalid auth token</code> error was encountered</p></td>
1914
+ </tr>
1915
+
1916
+
1917
+ </tbody>
1918
+ </table>
1919
+
1920
+ </td>
1921
+ </tr>
1922
+
1923
+
1924
+ </tbody>
1925
+ </table>
1926
+
1927
+
1928
+
1929
+
1930
+
1931
+
1932
+
1933
+
1934
+
1935
+
1936
+
1937
+
1938
+
1939
+
1940
+
1941
+
1942
+
1943
+
1944
+
1945
+
1946
+
1947
+ <h4 class="name" id="~user/create"><span class="type-signature">(inner) </span>user/create<span class="signature">(id, username, fullname, authToken)</span><span class="type-signature"> &rarr; {<a href="RTMUser.html">RTMUser</a>}</span></h4>
1948
+
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+ <dl class="details">
1955
+
1956
+
1957
+ <dt class="tag-source">Source:</dt>
1958
+ <dd class="tag-source"><ul class="dummy"><li>
1959
+ <a href="client_user.js.html">client/user.js</a>, <a href="client_user.js.html#line15">line 15</a>
1960
+ </li></ul></dd>
1961
+
1962
+
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+
1969
+
1970
+
1971
+
1972
+
1973
+
1974
+
1975
+
1976
+
1977
+
1978
+
1979
+
1980
+
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+ </dl>
1993
+
1994
+
1995
+
1996
+
1997
+
1998
+ <div class="description">
1999
+ <p>Create a new <code>RTMUser</code> manually.</p>
2000
+ <p>This will also set the User's RTM API Client to this <code>RTMClient</code>.</p>
2001
+ </div>
2002
+
2003
+
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+ <h5>Parameters:</h5>
2014
+
2015
+
2016
+ <table class="params">
2017
+ <thead>
2018
+ <tr>
2019
+
2020
+ <th>Name</th>
2021
+
2022
+
2023
+ <th>Type</th>
2024
+
2025
+
2026
+
2027
+
2028
+
2029
+ <th class="last">Description</th>
2030
+ </tr>
2031
+ </thead>
2032
+
2033
+ <tbody>
2034
+
2035
+
2036
+ <tr>
2037
+
2038
+ <td class="name"><code>id</code></td>
2039
+
2040
+
2041
+ <td class="type">
2042
+
2043
+
2044
+ <span class="param-type">number</span>
2045
+
2046
+
2047
+
2048
+ </td>
2049
+
2050
+
2051
+
2052
+
2053
+
2054
+ <td class="description last"><p>The RTM User's ID</p></td>
2055
+ </tr>
2056
+
2057
+
2058
+
2059
+ <tr>
2060
+
2061
+ <td class="name"><code>username</code></td>
2062
+
2063
+
2064
+ <td class="type">
2065
+
2066
+
2067
+ <span class="param-type">string</span>
2068
+
2069
+
2070
+
2071
+ </td>
2072
+
2073
+
2074
+
2075
+
2076
+
2077
+ <td class="description last"><p>The RTM User's username</p></td>
2078
+ </tr>
2079
+
2080
+
2081
+
2082
+ <tr>
2083
+
2084
+ <td class="name"><code>fullname</code></td>
2085
+
2086
+
2087
+ <td class="type">
2088
+
2089
+
2090
+ <span class="param-type">string</span>
2091
+
2092
+
2093
+
2094
+ </td>
2095
+
2096
+
2097
+
2098
+
2099
+
2100
+ <td class="description last"><p>The RTM User's full name</p></td>
2101
+ </tr>
2102
+
2103
+
2104
+
2105
+ <tr>
2106
+
2107
+ <td class="name"><code>authToken</code></td>
2108
+
2109
+
2110
+ <td class="type">
2111
+
2112
+
2113
+ <span class="param-type">string</span>
2114
+
2115
+
2116
+
2117
+ </td>
2118
+
2119
+
2120
+
2121
+
2122
+
2123
+ <td class="description last"><p>The RTM User's Auth Token</p></td>
2124
+ </tr>
2125
+
2126
+
2127
+ </tbody>
2128
+ </table>
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+
2135
+
2136
+
2137
+
2138
+
2139
+
2140
+
2141
+
2142
+
2143
+ <h5>Returns:</h5>
2144
+
2145
+
2146
+
2147
+
2148
+ <dl class="param-type">
2149
+ <dt>
2150
+ Type
2151
+ </dt>
2152
+ <dd>
2153
+
2154
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
2155
+
2156
+
2157
+ </dd>
2158
+ </dl>
2159
+
2160
+
2161
+
2162
+
2163
+
2164
+
2165
+
2166
+
2167
+
2168
+ <h4 class="name" id="~user/export"><span class="type-signature">(inner) </span>user/export<span class="signature">(user)</span><span class="type-signature"> &rarr; {object}</span></h4>
2169
+
2170
+
2171
+
2172
+
2173
+
2174
+
2175
+ <dl class="details">
2176
+
2177
+
2178
+ <dt class="tag-source">Source:</dt>
2179
+ <dd class="tag-source"><ul class="dummy"><li>
2180
+ <a href="client_user.js.html">client/user.js</a>, <a href="client_user.js.html#line32">line 32</a>
2181
+ </li></ul></dd>
2182
+
2183
+
2184
+
2185
+
2186
+
2187
+
2188
+
2189
+
2190
+
2191
+
2192
+
2193
+
2194
+
2195
+
2196
+
2197
+
2198
+
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+
2205
+
2206
+
2207
+
2208
+
2209
+
2210
+
2211
+
2212
+
2213
+ </dl>
2214
+
2215
+
2216
+
2217
+
2218
+
2219
+ <div class="description">
2220
+ <p>Get the User's required information:</p>
2221
+ <ul>
2222
+ <li>id</li>
2223
+ <li>username</li>
2224
+ <li>fullname</li>
2225
+ <li>authToken</li>
2226
+ <li>client (if set or use this <code>RTMClient</code>)</li>
2227
+ </ul>
2228
+ </div>
2229
+
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+
2237
+
2238
+
2239
+
2240
+ <h5>Parameters:</h5>
2241
+
2242
+
2243
+ <table class="params">
2244
+ <thead>
2245
+ <tr>
2246
+
2247
+ <th>Name</th>
2248
+
2249
+
2250
+ <th>Type</th>
2251
+
2252
+
2253
+
2254
+
2255
+
2256
+ <th class="last">Description</th>
2257
+ </tr>
2258
+ </thead>
2259
+
2260
+ <tbody>
2261
+
2262
+
2263
+ <tr>
2264
+
2265
+ <td class="name"><code>user</code></td>
2266
+
2267
+
2268
+ <td class="type">
2269
+
2270
+
2271
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
2272
+
2273
+
2274
+
2275
+ </td>
2276
+
2277
+
2278
+
2279
+
2280
+
2281
+ <td class="description last"><p>The RTMUser to export</p></td>
2282
+ </tr>
2283
+
2284
+
2285
+ </tbody>
2286
+ </table>
2287
+
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+
2295
+
2296
+
2297
+
2298
+
2299
+
2300
+
2301
+ <h5>Returns:</h5>
2302
+
2303
+
2304
+
2305
+
2306
+ <dl class="param-type">
2307
+ <dt>
2308
+ Type
2309
+ </dt>
2310
+ <dd>
2311
+
2312
+ <span class="param-type">object</span>
2313
+
2314
+
2315
+ </dd>
2316
+ </dl>
2317
+
2318
+
2319
+
2320
+
2321
+
2322
+
2323
+
2324
+
2325
+
2326
+ <h4 class="name" id="~user/exportToString"><span class="type-signature">(inner) </span>user/exportToString<span class="signature">(user)</span><span class="type-signature"> &rarr; {string}</span></h4>
2327
+
2328
+
2329
+
2330
+
2331
+
2332
+
2333
+ <dl class="details">
2334
+
2335
+
2336
+ <dt class="tag-source">Source:</dt>
2337
+ <dd class="tag-source"><ul class="dummy"><li>
2338
+ <a href="client_user.js.html">client/user.js</a>, <a href="client_user.js.html#line69">line 69</a>
2339
+ </li></ul></dd>
2340
+
2341
+
2342
+
2343
+
2344
+
2345
+
2346
+
2347
+
2348
+
2349
+
2350
+
2351
+
2352
+
2353
+
2354
+
2355
+
2356
+
2357
+
2358
+
2359
+
2360
+
2361
+
2362
+
2363
+
2364
+
2365
+
2366
+
2367
+
2368
+
2369
+
2370
+
2371
+ </dl>
2372
+
2373
+
2374
+
2375
+
2376
+
2377
+ <div class="description">
2378
+ <p>Get the User's required information as a JSON-string</p>
2379
+ </div>
2380
+
2381
+
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+ <h5>Parameters:</h5>
2392
+
2393
+
2394
+ <table class="params">
2395
+ <thead>
2396
+ <tr>
2397
+
2398
+ <th>Name</th>
2399
+
2400
+
2401
+ <th>Type</th>
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+ <th class="last">Description</th>
2408
+ </tr>
2409
+ </thead>
2410
+
2411
+ <tbody>
2412
+
2413
+
2414
+ <tr>
2415
+
2416
+ <td class="name"><code>user</code></td>
2417
+
2418
+
2419
+ <td class="type">
2420
+
2421
+
2422
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
2423
+
2424
+
2425
+
2426
+ </td>
2427
+
2428
+
2429
+
2430
+
2431
+
2432
+ <td class="description last"><p>The RTMUser to export</p></td>
2433
+ </tr>
2434
+
2435
+
2436
+ </tbody>
2437
+ </table>
2438
+
2439
+
2440
+
2441
+
2442
+
2443
+
2444
+
2445
+
2446
+
2447
+
2448
+
2449
+
2450
+
2451
+
2452
+ <h5>Returns:</h5>
2453
+
2454
+
2455
+
2456
+
2457
+ <dl class="param-type">
2458
+ <dt>
2459
+ Type
2460
+ </dt>
2461
+ <dd>
2462
+
2463
+ <span class="param-type">string</span>
2464
+
2465
+
2466
+ </dd>
2467
+ </dl>
2468
+
2469
+
2470
+
2471
+
2472
+
2473
+
2474
+
2475
+
2476
+
2477
+ <h4 class="name" id="~user/import"><span class="type-signature">(inner) </span>user/import<span class="signature">(properties)</span><span class="type-signature"> &rarr; {<a href="RTMUser.html">RTMUser</a>}</span></h4>
2478
+
2479
+
2480
+
2481
+
2482
+
2483
+
2484
+ <dl class="details">
2485
+
2486
+
2487
+ <dt class="tag-source">Source:</dt>
2488
+ <dd class="tag-source"><ul class="dummy"><li>
2489
+ <a href="client_user.js.html">client/user.js</a>, <a href="client_user.js.html#line79">line 79</a>
2490
+ </li></ul></dd>
2491
+
2492
+
2493
+
2494
+
2495
+
2496
+
2497
+
2498
+
2499
+
2500
+
2501
+
2502
+
2503
+
2504
+
2505
+
2506
+
2507
+
2508
+
2509
+
2510
+
2511
+
2512
+
2513
+
2514
+
2515
+
2516
+
2517
+
2518
+
2519
+
2520
+
2521
+
2522
+ </dl>
2523
+
2524
+
2525
+
2526
+
2527
+
2528
+ <div class="description">
2529
+ <p>Create a new <code>RTMUser</code> from an exported User's properties</p>
2530
+ </div>
2531
+
2532
+
2533
+
2534
+
2535
+
2536
+
2537
+
2538
+
2539
+
2540
+
2541
+
2542
+ <h5>Parameters:</h5>
2543
+
2544
+
2545
+ <table class="params">
2546
+ <thead>
2547
+ <tr>
2548
+
2549
+ <th>Name</th>
2550
+
2551
+
2552
+ <th>Type</th>
2553
+
2554
+
2555
+
2556
+
2557
+
2558
+ <th class="last">Description</th>
2559
+ </tr>
2560
+ </thead>
2561
+
2562
+ <tbody>
2563
+
2564
+
2565
+ <tr>
2566
+
2567
+ <td class="name"><code>properties</code></td>
2568
+
2569
+
2570
+ <td class="type">
2571
+
2572
+
2573
+ <span class="param-type">Object</span>
2574
+
2575
+
2576
+
2577
+ </td>
2578
+
2579
+
2580
+
2581
+
2582
+
2583
+ <td class="description last"><p>The RTM User's required properties</p></td>
2584
+ </tr>
2585
+
2586
+
2587
+ </tbody>
2588
+ </table>
2589
+
2590
+
2591
+
2592
+
2593
+
2594
+
2595
+
2596
+
2597
+
2598
+
2599
+
2600
+
2601
+
2602
+
2603
+ <h5>Returns:</h5>
2604
+
2605
+
2606
+
2607
+
2608
+ <dl class="param-type">
2609
+ <dt>
2610
+ Type
2611
+ </dt>
2612
+ <dd>
2613
+
2614
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
2615
+
2616
+
2617
+ </dd>
2618
+ </dl>
2619
+
2620
+
2621
+
2622
+
2623
+
2624
+
2625
+
2626
+
2627
+
2628
+ <h4 class="name" id="~user/importFromString"><span class="type-signature">(inner) </span>user/importFromString<span class="signature">(string)</span><span class="type-signature"> &rarr; {<a href="RTMUser.html">RTMUser</a>}</span></h4>
2629
+
2630
+
2631
+
2632
+
2633
+
2634
+
2635
+ <dl class="details">
2636
+
2637
+
2638
+ <dt class="tag-source">Source:</dt>
2639
+ <dd class="tag-source"><ul class="dummy"><li>
2640
+ <a href="client_user.js.html">client/user.js</a>, <a href="client_user.js.html#line101">line 101</a>
2641
+ </li></ul></dd>
2642
+
2643
+
2644
+
2645
+
2646
+
2647
+
2648
+
2649
+
2650
+
2651
+
2652
+
2653
+
2654
+
2655
+
2656
+
2657
+
2658
+
2659
+
2660
+
2661
+
2662
+
2663
+
2664
+
2665
+
2666
+
2667
+
2668
+
2669
+
2670
+
2671
+
2672
+
2673
+ </dl>
2674
+
2675
+
2676
+
2677
+
2678
+
2679
+ <div class="description">
2680
+ <p>Create a new <code>RTMUser</code> from an exported User's properties' JSON-string</p>
2681
+ </div>
2682
+
2683
+
2684
+
2685
+
2686
+
2687
+
2688
+
2689
+
2690
+
2691
+
2692
+
2693
+ <h5>Parameters:</h5>
2694
+
2695
+
2696
+ <table class="params">
2697
+ <thead>
2698
+ <tr>
2699
+
2700
+ <th>Name</th>
2701
+
2702
+
2703
+ <th>Type</th>
2704
+
2705
+
2706
+
2707
+
2708
+
2709
+ <th class="last">Description</th>
2710
+ </tr>
2711
+ </thead>
2712
+
2713
+ <tbody>
2714
+
2715
+
2716
+ <tr>
2717
+
2718
+ <td class="name"><code>string</code></td>
2719
+
2720
+
2721
+ <td class="type">
2722
+
2723
+
2724
+ <span class="param-type">string</span>
2725
+
2726
+
2727
+
2728
+ </td>
2729
+
2730
+
2731
+
2732
+
2733
+
2734
+ <td class="description last"><p>JSON-string of RTM User's required properties</p></td>
2735
+ </tr>
2736
+
2737
+
2738
+ </tbody>
2739
+ </table>
2740
+
2741
+
2742
+
2743
+
2744
+
2745
+
2746
+
2747
+
2748
+
2749
+
2750
+
2751
+
2752
+
2753
+
2754
+ <h5>Returns:</h5>
2755
+
2756
+
2757
+
2758
+
2759
+ <dl class="param-type">
2760
+ <dt>
2761
+ Type
2762
+ </dt>
2763
+ <dd>
2764
+
2765
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
2766
+
2767
+
2768
+ </dd>
2769
+ </dl>
2770
+
2771
+
2772
+
2773
+
2774
+
2775
+
2776
+
2777
+
2778
+
2779
+
2780
+ </article>
2781
+
2782
+ </section>
2783
+
2784
+
2785
+
2786
+
2787
+ </div>
2788
+
2789
+ <br class="clear">
2790
+
2791
+ <footer>
2792
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:26:15 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
2793
+ </footer>
2794
+
2795
+ <script>prettyPrint();</script>
2796
+ <script src="scripts/linenumber.js"></script>
2797
+ </body>
2798
+ </html>