1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 | <meta charset="utf-8">
|
5 | <title>JSDoc: Class: User</title>
|
6 |
|
7 | <script src="scripts/prettify/prettify.js"> </script>
|
8 | <script src="scripts/prettify/lang-css.js"> </script>
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
13 | <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
14 | </head>
|
15 |
|
16 | <body>
|
17 |
|
18 | <div id="main">
|
19 |
|
20 | <h1 class="page-title">Class: User</h1>
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 | <section>
|
28 |
|
29 | <header>
|
30 |
|
31 | <h2>User</h2>
|
32 |
|
33 |
|
34 | </header>
|
35 |
|
36 | <article>
|
37 | <div class="container-overview">
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 | <h4 class="name" id="User"><span class="type-signature"></span>new User<span class="signature">(res, container)</span><span class="type-signature"></span></h4>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 | <div class="description">
|
50 | Rapresent an user
|
51 | </div>
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 |
|
59 |
|
60 |
|
61 | <h5>Parameters:</h5>
|
62 |
|
63 |
|
64 | <table class="params">
|
65 | <thead>
|
66 | <tr>
|
67 |
|
68 | <th>Name</th>
|
69 |
|
70 |
|
71 | <th>Type</th>
|
72 |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 | <th class="last">Description</th>
|
78 | </tr>
|
79 | </thead>
|
80 |
|
81 | <tbody>
|
82 |
|
83 |
|
84 | <tr>
|
85 |
|
86 | <td class="name"><code>res</code></td>
|
87 |
|
88 |
|
89 | <td class="type">
|
90 |
|
91 |
|
92 | <span class="param-type">Object</span>
|
93 |
|
94 |
|
95 |
|
96 | </td>
|
97 |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 | <td class="description last">user details</td>
|
103 | </tr>
|
104 |
|
105 |
|
106 |
|
107 | <tr>
|
108 |
|
109 | <td class="name"><code>container</code></td>
|
110 |
|
111 |
|
112 | <td class="type">
|
113 |
|
114 |
|
115 | <span class="param-type"><a href="global.html#Container">Container</a></span>
|
116 |
|
117 |
|
118 |
|
119 | </td>
|
120 |
|
121 |
|
122 |
|
123 |
|
124 |
|
125 | <td class="description last">the main container</td>
|
126 | </tr>
|
127 |
|
128 |
|
129 | </tbody>
|
130 | </table>
|
131 |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 |
|
137 | <dl class="details">
|
138 |
|
139 |
|
140 |
|
141 |
|
142 |
|
143 |
|
144 |
|
145 |
|
146 |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 |
|
154 |
|
155 |
|
156 |
|
157 |
|
158 |
|
159 |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 | <dt class="tag-source">Source:</dt>
|
165 | <dd class="tag-source"><ul class="dummy"><li>
|
166 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line11">line 11</a>
|
167 | </li></ul></dd>
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 |
|
175 | </dl>
|
176 |
|
177 |
|
178 |
|
179 |
|
180 |
|
181 |
|
182 |
|
183 |
|
184 |
|
185 |
|
186 |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 |
|
192 |
|
193 | </div>
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |
|
199 |
|
200 |
|
201 |
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 | <h3 class="subsection-title">Methods</h3>
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 | <h4 class="name" id="login"><span class="type-signature"></span>login<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 | <div class="description">
|
222 | Login the current user and retrieve a session apiKey
|
223 | </div>
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 |
|
230 |
|
231 |
|
232 |
|
233 |
|
234 |
|
235 |
|
236 |
|
237 | <dl class="details">
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 |
|
246 |
|
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 |
|
259 |
|
260 |
|
261 |
|
262 |
|
263 |
|
264 | <dt class="tag-source">Source:</dt>
|
265 | <dd class="tag-source"><ul class="dummy"><li>
|
266 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line53">line 53</a>
|
267 | </li></ul></dd>
|
268 |
|
269 |
|
270 |
|
271 |
|
272 |
|
273 |
|
274 |
|
275 | </dl>
|
276 |
|
277 |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 |
|
283 |
|
284 |
|
285 |
|
286 |
|
287 |
|
288 |
|
289 | <h5>Returns:</h5>
|
290 |
|
291 |
|
292 | <div class="param-desc">
|
293 | token A Promise containing the session apiKey
|
294 | </div>
|
295 |
|
296 |
|
297 |
|
298 | <dl>
|
299 | <dt>
|
300 | Type
|
301 | </dt>
|
302 | <dd>
|
303 |
|
304 | <span class="param-type">Promise</span>
|
305 |
|
306 |
|
307 | </dd>
|
308 | </dl>
|
309 |
|
310 |
|
311 |
|
312 |
|
313 |
|
314 |
|
315 |
|
316 |
|
317 |
|
318 |
|
319 | <h4 class="name" id="login"><span class="type-signature"></span>login<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
320 |
|
321 |
|
322 |
|
323 |
|
324 |
|
325 | <div class="description">
|
326 | Login the current user and retrieve a session apiKey
|
327 | </div>
|
328 |
|
329 |
|
330 |
|
331 |
|
332 |
|
333 |
|
334 |
|
335 |
|
336 |
|
337 |
|
338 |
|
339 |
|
340 |
|
341 | <dl class="details">
|
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 |
|
367 |
|
368 | <dt class="tag-source">Source:</dt>
|
369 | <dd class="tag-source"><ul class="dummy"><li>
|
370 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line53">line 53</a>
|
371 | </li></ul></dd>
|
372 |
|
373 |
|
374 |
|
375 |
|
376 |
|
377 |
|
378 |
|
379 | </dl>
|
380 |
|
381 |
|
382 |
|
383 |
|
384 |
|
385 |
|
386 |
|
387 |
|
388 |
|
389 |
|
390 |
|
391 |
|
392 |
|
393 | <h5>Returns:</h5>
|
394 |
|
395 |
|
396 | <div class="param-desc">
|
397 | token A Promise containing the session apiKey
|
398 | </div>
|
399 |
|
400 |
|
401 |
|
402 | <dl>
|
403 | <dt>
|
404 | Type
|
405 | </dt>
|
406 | <dd>
|
407 |
|
408 | <span class="param-type">Promise</span>
|
409 |
|
410 |
|
411 | </dd>
|
412 | </dl>
|
413 |
|
414 |
|
415 |
|
416 |
|
417 |
|
418 |
|
419 |
|
420 |
|
421 |
|
422 |
|
423 | <h4 class="name" id="logout"><span class="type-signature"></span>logout<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 | <div class="description">
|
430 | Logout the current user
|
431 | </div>
|
432 |
|
433 |
|
434 |
|
435 |
|
436 |
|
437 |
|
438 |
|
439 |
|
440 |
|
441 |
|
442 |
|
443 |
|
444 |
|
445 | <dl class="details">
|
446 |
|
447 |
|
448 |
|
449 |
|
450 |
|
451 |
|
452 |
|
453 |
|
454 |
|
455 |
|
456 |
|
457 |
|
458 |
|
459 |
|
460 |
|
461 |
|
462 |
|
463 |
|
464 |
|
465 |
|
466 |
|
467 |
|
468 |
|
469 |
|
470 |
|
471 |
|
472 | <dt class="tag-source">Source:</dt>
|
473 | <dd class="tag-source"><ul class="dummy"><li>
|
474 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line66">line 66</a>
|
475 | </li></ul></dd>
|
476 |
|
477 |
|
478 |
|
479 |
|
480 |
|
481 |
|
482 |
|
483 | </dl>
|
484 |
|
485 |
|
486 |
|
487 |
|
488 |
|
489 |
|
490 |
|
491 |
|
492 |
|
493 |
|
494 |
|
495 |
|
496 |
|
497 | <h5>Returns:</h5>
|
498 |
|
499 |
|
500 | <div class="param-desc">
|
501 | response
|
502 | </div>
|
503 |
|
504 |
|
505 |
|
506 | <dl>
|
507 | <dt>
|
508 | Type
|
509 | </dt>
|
510 | <dd>
|
511 |
|
512 | <span class="param-type">Promise</span>
|
513 |
|
514 |
|
515 | </dd>
|
516 | </dl>
|
517 |
|
518 |
|
519 |
|
520 |
|
521 |
|
522 |
|
523 |
|
524 |
|
525 |
|
526 |
|
527 | <h4 class="name" id="logout"><span class="type-signature"></span>logout<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
528 |
|
529 |
|
530 |
|
531 |
|
532 |
|
533 | <div class="description">
|
534 | Logout the current user
|
535 | </div>
|
536 |
|
537 |
|
538 |
|
539 |
|
540 |
|
541 |
|
542 |
|
543 |
|
544 |
|
545 |
|
546 |
|
547 |
|
548 |
|
549 | <dl class="details">
|
550 |
|
551 |
|
552 |
|
553 |
|
554 |
|
555 |
|
556 |
|
557 |
|
558 |
|
559 |
|
560 |
|
561 |
|
562 |
|
563 |
|
564 |
|
565 |
|
566 |
|
567 |
|
568 |
|
569 |
|
570 |
|
571 |
|
572 |
|
573 |
|
574 |
|
575 |
|
576 | <dt class="tag-source">Source:</dt>
|
577 | <dd class="tag-source"><ul class="dummy"><li>
|
578 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line66">line 66</a>
|
579 | </li></ul></dd>
|
580 |
|
581 |
|
582 |
|
583 |
|
584 |
|
585 |
|
586 |
|
587 | </dl>
|
588 |
|
589 |
|
590 |
|
591 |
|
592 |
|
593 |
|
594 |
|
595 |
|
596 |
|
597 |
|
598 |
|
599 |
|
600 |
|
601 | <h5>Returns:</h5>
|
602 |
|
603 |
|
604 | <div class="param-desc">
|
605 | response
|
606 | </div>
|
607 |
|
608 |
|
609 |
|
610 | <dl>
|
611 | <dt>
|
612 | Type
|
613 | </dt>
|
614 | <dd>
|
615 |
|
616 | <span class="param-type">Promise</span>
|
617 |
|
618 |
|
619 | </dd>
|
620 | </dl>
|
621 |
|
622 |
|
623 |
|
624 |
|
625 |
|
626 |
|
627 |
|
628 |
|
629 |
|
630 |
|
631 | <h4 class="name" id="read"><span class="type-signature"></span>read<span class="signature">()</span><span class="type-signature"></span></h4>
|
632 |
|
633 |
|
634 |
|
635 |
|
636 |
|
637 | <div class="description">
|
638 | Fetch the user object
|
639 | </div>
|
640 |
|
641 |
|
642 |
|
643 |
|
644 |
|
645 |
|
646 |
|
647 |
|
648 |
|
649 |
|
650 |
|
651 |
|
652 |
|
653 | <dl class="details">
|
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 |
|
680 | <dt class="tag-source">Source:</dt>
|
681 | <dd class="tag-source"><ul class="dummy"><li>
|
682 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line41">line 41</a>
|
683 | </li></ul></dd>
|
684 |
|
685 |
|
686 |
|
687 |
|
688 |
|
689 |
|
690 |
|
691 | </dl>
|
692 |
|
693 |
|
694 |
|
695 |
|
696 |
|
697 |
|
698 |
|
699 |
|
700 |
|
701 |
|
702 |
|
703 |
|
704 |
|
705 |
|
706 |
|
707 |
|
708 |
|
709 |
|
710 |
|
711 |
|
712 |
|
713 | <h4 class="name" id="read"><span class="type-signature"></span>read<span class="signature">()</span><span class="type-signature"></span></h4>
|
714 |
|
715 |
|
716 |
|
717 |
|
718 |
|
719 | <div class="description">
|
720 | Fetch the user object
|
721 | </div>
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 |
|
729 |
|
730 |
|
731 |
|
732 |
|
733 |
|
734 |
|
735 | <dl class="details">
|
736 |
|
737 |
|
738 |
|
739 |
|
740 |
|
741 |
|
742 |
|
743 |
|
744 |
|
745 |
|
746 |
|
747 |
|
748 |
|
749 |
|
750 |
|
751 |
|
752 |
|
753 |
|
754 |
|
755 |
|
756 |
|
757 |
|
758 |
|
759 |
|
760 |
|
761 |
|
762 | <dt class="tag-source">Source:</dt>
|
763 | <dd class="tag-source"><ul class="dummy"><li>
|
764 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line41">line 41</a>
|
765 | </li></ul></dd>
|
766 |
|
767 |
|
768 |
|
769 |
|
770 |
|
771 |
|
772 |
|
773 | </dl>
|
774 |
|
775 |
|
776 |
|
777 |
|
778 |
|
779 |
|
780 |
|
781 |
|
782 |
|
783 |
|
784 |
|
785 |
|
786 |
|
787 |
|
788 |
|
789 |
|
790 |
|
791 |
|
792 |
|
793 |
|
794 |
|
795 | <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
|
796 |
|
797 |
|
798 |
|
799 |
|
800 |
|
801 | <div class="description">
|
802 | Save the local modification to the user object
|
803 | </div>
|
804 |
|
805 |
|
806 |
|
807 |
|
808 |
|
809 |
|
810 |
|
811 |
|
812 |
|
813 |
|
814 |
|
815 |
|
816 |
|
817 | <dl class="details">
|
818 |
|
819 |
|
820 |
|
821 |
|
822 |
|
823 |
|
824 |
|
825 |
|
826 |
|
827 |
|
828 |
|
829 |
|
830 |
|
831 |
|
832 |
|
833 |
|
834 |
|
835 |
|
836 |
|
837 |
|
838 |
|
839 |
|
840 |
|
841 |
|
842 |
|
843 |
|
844 | <dt class="tag-source">Source:</dt>
|
845 | <dd class="tag-source"><ul class="dummy"><li>
|
846 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line34">line 34</a>
|
847 | </li></ul></dd>
|
848 |
|
849 |
|
850 |
|
851 |
|
852 |
|
853 |
|
854 |
|
855 | </dl>
|
856 |
|
857 |
|
858 |
|
859 |
|
860 |
|
861 |
|
862 |
|
863 |
|
864 |
|
865 |
|
866 |
|
867 |
|
868 |
|
869 |
|
870 |
|
871 |
|
872 |
|
873 |
|
874 |
|
875 |
|
876 |
|
877 | <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
|
878 |
|
879 |
|
880 |
|
881 |
|
882 |
|
883 | <div class="description">
|
884 | Save the local modification to the user object
|
885 | </div>
|
886 |
|
887 |
|
888 |
|
889 |
|
890 |
|
891 |
|
892 |
|
893 |
|
894 |
|
895 |
|
896 |
|
897 |
|
898 |
|
899 | <dl class="details">
|
900 |
|
901 |
|
902 |
|
903 |
|
904 |
|
905 |
|
906 |
|
907 |
|
908 |
|
909 |
|
910 |
|
911 |
|
912 |
|
913 |
|
914 |
|
915 |
|
916 |
|
917 |
|
918 |
|
919 |
|
920 |
|
921 |
|
922 |
|
923 |
|
924 |
|
925 |
|
926 | <dt class="tag-source">Source:</dt>
|
927 | <dd class="tag-source"><ul class="dummy"><li>
|
928 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line34">line 34</a>
|
929 | </li></ul></dd>
|
930 |
|
931 |
|
932 |
|
933 |
|
934 |
|
935 |
|
936 |
|
937 | </dl>
|
938 |
|
939 |
|
940 |
|
941 |
|
942 |
|
943 |
|
944 |
|
945 |
|
946 |
|
947 |
|
948 |
|
949 |
|
950 |
|
951 |
|
952 |
|
953 |
|
954 |
|
955 |
|
956 |
|
957 |
|
958 |
|
959 |
|
960 | </article>
|
961 |
|
962 | </section>
|
963 |
|
964 |
|
965 |
|
966 |
|
967 |
|
968 |
|
969 |
|
970 | <section>
|
971 |
|
972 | <header>
|
973 |
|
974 | <h2>User</h2>
|
975 |
|
976 |
|
977 | </header>
|
978 |
|
979 | <article>
|
980 | <div class="container-overview">
|
981 |
|
982 |
|
983 |
|
984 |
|
985 |
|
986 | <h4 class="name" id="User"><span class="type-signature"></span>new User<span class="signature">(res, container)</span><span class="type-signature"></span></h4>
|
987 |
|
988 |
|
989 |
|
990 |
|
991 |
|
992 | <div class="description">
|
993 | Rapresent an user
|
994 | </div>
|
995 |
|
996 |
|
997 |
|
998 |
|
999 |
|
1000 |
|
1001 |
|
1002 |
|
1003 |
|
1004 | <h5>Parameters:</h5>
|
1005 |
|
1006 |
|
1007 | <table class="params">
|
1008 | <thead>
|
1009 | <tr>
|
1010 |
|
1011 | <th>Name</th>
|
1012 |
|
1013 |
|
1014 | <th>Type</th>
|
1015 |
|
1016 |
|
1017 |
|
1018 |
|
1019 |
|
1020 | <th class="last">Description</th>
|
1021 | </tr>
|
1022 | </thead>
|
1023 |
|
1024 | <tbody>
|
1025 |
|
1026 |
|
1027 | <tr>
|
1028 |
|
1029 | <td class="name"><code>res</code></td>
|
1030 |
|
1031 |
|
1032 | <td class="type">
|
1033 |
|
1034 |
|
1035 | <span class="param-type">Object</span>
|
1036 |
|
1037 |
|
1038 |
|
1039 | </td>
|
1040 |
|
1041 |
|
1042 |
|
1043 |
|
1044 |
|
1045 | <td class="description last">user details</td>
|
1046 | </tr>
|
1047 |
|
1048 |
|
1049 |
|
1050 | <tr>
|
1051 |
|
1052 | <td class="name"><code>container</code></td>
|
1053 |
|
1054 |
|
1055 | <td class="type">
|
1056 |
|
1057 |
|
1058 | <span class="param-type"><a href="global.html#Container">Container</a></span>
|
1059 |
|
1060 |
|
1061 |
|
1062 | </td>
|
1063 |
|
1064 |
|
1065 |
|
1066 |
|
1067 |
|
1068 | <td class="description last">the main container</td>
|
1069 | </tr>
|
1070 |
|
1071 |
|
1072 | </tbody>
|
1073 | </table>
|
1074 |
|
1075 |
|
1076 |
|
1077 |
|
1078 |
|
1079 |
|
1080 | <dl class="details">
|
1081 |
|
1082 |
|
1083 |
|
1084 |
|
1085 |
|
1086 |
|
1087 |
|
1088 |
|
1089 |
|
1090 |
|
1091 |
|
1092 |
|
1093 |
|
1094 |
|
1095 |
|
1096 |
|
1097 |
|
1098 |
|
1099 |
|
1100 |
|
1101 |
|
1102 |
|
1103 |
|
1104 |
|
1105 |
|
1106 |
|
1107 | <dt class="tag-source">Source:</dt>
|
1108 | <dd class="tag-source"><ul class="dummy"><li>
|
1109 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line11">line 11</a>
|
1110 | </li></ul></dd>
|
1111 |
|
1112 |
|
1113 |
|
1114 |
|
1115 |
|
1116 |
|
1117 |
|
1118 | </dl>
|
1119 |
|
1120 |
|
1121 |
|
1122 |
|
1123 |
|
1124 |
|
1125 |
|
1126 |
|
1127 |
|
1128 |
|
1129 |
|
1130 |
|
1131 |
|
1132 |
|
1133 |
|
1134 |
|
1135 |
|
1136 | </div>
|
1137 |
|
1138 |
|
1139 |
|
1140 |
|
1141 |
|
1142 |
|
1143 |
|
1144 |
|
1145 |
|
1146 |
|
1147 |
|
1148 |
|
1149 |
|
1150 |
|
1151 | <h3 class="subsection-title">Methods</h3>
|
1152 |
|
1153 |
|
1154 |
|
1155 |
|
1156 |
|
1157 |
|
1158 | <h4 class="name" id="login"><span class="type-signature"></span>login<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
1159 |
|
1160 |
|
1161 |
|
1162 |
|
1163 |
|
1164 | <div class="description">
|
1165 | Login the current user and retrieve a session apiKey
|
1166 | </div>
|
1167 |
|
1168 |
|
1169 |
|
1170 |
|
1171 |
|
1172 |
|
1173 |
|
1174 |
|
1175 |
|
1176 |
|
1177 |
|
1178 |
|
1179 |
|
1180 | <dl class="details">
|
1181 |
|
1182 |
|
1183 |
|
1184 |
|
1185 |
|
1186 |
|
1187 |
|
1188 |
|
1189 |
|
1190 |
|
1191 |
|
1192 |
|
1193 |
|
1194 |
|
1195 |
|
1196 |
|
1197 |
|
1198 |
|
1199 |
|
1200 |
|
1201 |
|
1202 |
|
1203 |
|
1204 |
|
1205 |
|
1206 |
|
1207 | <dt class="tag-source">Source:</dt>
|
1208 | <dd class="tag-source"><ul class="dummy"><li>
|
1209 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line53">line 53</a>
|
1210 | </li></ul></dd>
|
1211 |
|
1212 |
|
1213 |
|
1214 |
|
1215 |
|
1216 |
|
1217 |
|
1218 | </dl>
|
1219 |
|
1220 |
|
1221 |
|
1222 |
|
1223 |
|
1224 |
|
1225 |
|
1226 |
|
1227 |
|
1228 |
|
1229 |
|
1230 |
|
1231 |
|
1232 | <h5>Returns:</h5>
|
1233 |
|
1234 |
|
1235 | <div class="param-desc">
|
1236 | token A Promise containing the session apiKey
|
1237 | </div>
|
1238 |
|
1239 |
|
1240 |
|
1241 | <dl>
|
1242 | <dt>
|
1243 | Type
|
1244 | </dt>
|
1245 | <dd>
|
1246 |
|
1247 | <span class="param-type">Promise</span>
|
1248 |
|
1249 |
|
1250 | </dd>
|
1251 | </dl>
|
1252 |
|
1253 |
|
1254 |
|
1255 |
|
1256 |
|
1257 |
|
1258 |
|
1259 |
|
1260 |
|
1261 |
|
1262 | <h4 class="name" id="login"><span class="type-signature"></span>login<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
1263 |
|
1264 |
|
1265 |
|
1266 |
|
1267 |
|
1268 | <div class="description">
|
1269 | Login the current user and retrieve a session apiKey
|
1270 | </div>
|
1271 |
|
1272 |
|
1273 |
|
1274 |
|
1275 |
|
1276 |
|
1277 |
|
1278 |
|
1279 |
|
1280 |
|
1281 |
|
1282 |
|
1283 |
|
1284 | <dl class="details">
|
1285 |
|
1286 |
|
1287 |
|
1288 |
|
1289 |
|
1290 |
|
1291 |
|
1292 |
|
1293 |
|
1294 |
|
1295 |
|
1296 |
|
1297 |
|
1298 |
|
1299 |
|
1300 |
|
1301 |
|
1302 |
|
1303 |
|
1304 |
|
1305 |
|
1306 |
|
1307 |
|
1308 |
|
1309 |
|
1310 |
|
1311 | <dt class="tag-source">Source:</dt>
|
1312 | <dd class="tag-source"><ul class="dummy"><li>
|
1313 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line53">line 53</a>
|
1314 | </li></ul></dd>
|
1315 |
|
1316 |
|
1317 |
|
1318 |
|
1319 |
|
1320 |
|
1321 |
|
1322 | </dl>
|
1323 |
|
1324 |
|
1325 |
|
1326 |
|
1327 |
|
1328 |
|
1329 |
|
1330 |
|
1331 |
|
1332 |
|
1333 |
|
1334 |
|
1335 |
|
1336 | <h5>Returns:</h5>
|
1337 |
|
1338 |
|
1339 | <div class="param-desc">
|
1340 | token A Promise containing the session apiKey
|
1341 | </div>
|
1342 |
|
1343 |
|
1344 |
|
1345 | <dl>
|
1346 | <dt>
|
1347 | Type
|
1348 | </dt>
|
1349 | <dd>
|
1350 |
|
1351 | <span class="param-type">Promise</span>
|
1352 |
|
1353 |
|
1354 | </dd>
|
1355 | </dl>
|
1356 |
|
1357 |
|
1358 |
|
1359 |
|
1360 |
|
1361 |
|
1362 |
|
1363 |
|
1364 |
|
1365 |
|
1366 | <h4 class="name" id="logout"><span class="type-signature"></span>logout<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
1367 |
|
1368 |
|
1369 |
|
1370 |
|
1371 |
|
1372 | <div class="description">
|
1373 | Logout the current user
|
1374 | </div>
|
1375 |
|
1376 |
|
1377 |
|
1378 |
|
1379 |
|
1380 |
|
1381 |
|
1382 |
|
1383 |
|
1384 |
|
1385 |
|
1386 |
|
1387 |
|
1388 | <dl class="details">
|
1389 |
|
1390 |
|
1391 |
|
1392 |
|
1393 |
|
1394 |
|
1395 |
|
1396 |
|
1397 |
|
1398 |
|
1399 |
|
1400 |
|
1401 |
|
1402 |
|
1403 |
|
1404 |
|
1405 |
|
1406 |
|
1407 |
|
1408 |
|
1409 |
|
1410 |
|
1411 |
|
1412 |
|
1413 |
|
1414 |
|
1415 | <dt class="tag-source">Source:</dt>
|
1416 | <dd class="tag-source"><ul class="dummy"><li>
|
1417 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line66">line 66</a>
|
1418 | </li></ul></dd>
|
1419 |
|
1420 |
|
1421 |
|
1422 |
|
1423 |
|
1424 |
|
1425 |
|
1426 | </dl>
|
1427 |
|
1428 |
|
1429 |
|
1430 |
|
1431 |
|
1432 |
|
1433 |
|
1434 |
|
1435 |
|
1436 |
|
1437 |
|
1438 |
|
1439 |
|
1440 | <h5>Returns:</h5>
|
1441 |
|
1442 |
|
1443 | <div class="param-desc">
|
1444 | response
|
1445 | </div>
|
1446 |
|
1447 |
|
1448 |
|
1449 | <dl>
|
1450 | <dt>
|
1451 | Type
|
1452 | </dt>
|
1453 | <dd>
|
1454 |
|
1455 | <span class="param-type">Promise</span>
|
1456 |
|
1457 |
|
1458 | </dd>
|
1459 | </dl>
|
1460 |
|
1461 |
|
1462 |
|
1463 |
|
1464 |
|
1465 |
|
1466 |
|
1467 |
|
1468 |
|
1469 |
|
1470 | <h4 class="name" id="logout"><span class="type-signature"></span>logout<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
1471 |
|
1472 |
|
1473 |
|
1474 |
|
1475 |
|
1476 | <div class="description">
|
1477 | Logout the current user
|
1478 | </div>
|
1479 |
|
1480 |
|
1481 |
|
1482 |
|
1483 |
|
1484 |
|
1485 |
|
1486 |
|
1487 |
|
1488 |
|
1489 |
|
1490 |
|
1491 |
|
1492 | <dl class="details">
|
1493 |
|
1494 |
|
1495 |
|
1496 |
|
1497 |
|
1498 |
|
1499 |
|
1500 |
|
1501 |
|
1502 |
|
1503 |
|
1504 |
|
1505 |
|
1506 |
|
1507 |
|
1508 |
|
1509 |
|
1510 |
|
1511 |
|
1512 |
|
1513 |
|
1514 |
|
1515 |
|
1516 |
|
1517 |
|
1518 |
|
1519 | <dt class="tag-source">Source:</dt>
|
1520 | <dd class="tag-source"><ul class="dummy"><li>
|
1521 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line66">line 66</a>
|
1522 | </li></ul></dd>
|
1523 |
|
1524 |
|
1525 |
|
1526 |
|
1527 |
|
1528 |
|
1529 |
|
1530 | </dl>
|
1531 |
|
1532 |
|
1533 |
|
1534 |
|
1535 |
|
1536 |
|
1537 |
|
1538 |
|
1539 |
|
1540 |
|
1541 |
|
1542 |
|
1543 |
|
1544 | <h5>Returns:</h5>
|
1545 |
|
1546 |
|
1547 | <div class="param-desc">
|
1548 | response
|
1549 | </div>
|
1550 |
|
1551 |
|
1552 |
|
1553 | <dl>
|
1554 | <dt>
|
1555 | Type
|
1556 | </dt>
|
1557 | <dd>
|
1558 |
|
1559 | <span class="param-type">Promise</span>
|
1560 |
|
1561 |
|
1562 | </dd>
|
1563 | </dl>
|
1564 |
|
1565 |
|
1566 |
|
1567 |
|
1568 |
|
1569 |
|
1570 |
|
1571 |
|
1572 |
|
1573 |
|
1574 | <h4 class="name" id="read"><span class="type-signature"></span>read<span class="signature">()</span><span class="type-signature"></span></h4>
|
1575 |
|
1576 |
|
1577 |
|
1578 |
|
1579 |
|
1580 | <div class="description">
|
1581 | Fetch the user object
|
1582 | </div>
|
1583 |
|
1584 |
|
1585 |
|
1586 |
|
1587 |
|
1588 |
|
1589 |
|
1590 |
|
1591 |
|
1592 |
|
1593 |
|
1594 |
|
1595 |
|
1596 | <dl class="details">
|
1597 |
|
1598 |
|
1599 |
|
1600 |
|
1601 |
|
1602 |
|
1603 |
|
1604 |
|
1605 |
|
1606 |
|
1607 |
|
1608 |
|
1609 |
|
1610 |
|
1611 |
|
1612 |
|
1613 |
|
1614 |
|
1615 |
|
1616 |
|
1617 |
|
1618 |
|
1619 |
|
1620 |
|
1621 |
|
1622 |
|
1623 | <dt class="tag-source">Source:</dt>
|
1624 | <dd class="tag-source"><ul class="dummy"><li>
|
1625 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line41">line 41</a>
|
1626 | </li></ul></dd>
|
1627 |
|
1628 |
|
1629 |
|
1630 |
|
1631 |
|
1632 |
|
1633 |
|
1634 | </dl>
|
1635 |
|
1636 |
|
1637 |
|
1638 |
|
1639 |
|
1640 |
|
1641 |
|
1642 |
|
1643 |
|
1644 |
|
1645 |
|
1646 |
|
1647 |
|
1648 |
|
1649 |
|
1650 |
|
1651 |
|
1652 |
|
1653 |
|
1654 |
|
1655 |
|
1656 | <h4 class="name" id="read"><span class="type-signature"></span>read<span class="signature">()</span><span class="type-signature"></span></h4>
|
1657 |
|
1658 |
|
1659 |
|
1660 |
|
1661 |
|
1662 | <div class="description">
|
1663 | Fetch the user object
|
1664 | </div>
|
1665 |
|
1666 |
|
1667 |
|
1668 |
|
1669 |
|
1670 |
|
1671 |
|
1672 |
|
1673 |
|
1674 |
|
1675 |
|
1676 |
|
1677 |
|
1678 | <dl class="details">
|
1679 |
|
1680 |
|
1681 |
|
1682 |
|
1683 |
|
1684 |
|
1685 |
|
1686 |
|
1687 |
|
1688 |
|
1689 |
|
1690 |
|
1691 |
|
1692 |
|
1693 |
|
1694 |
|
1695 |
|
1696 |
|
1697 |
|
1698 |
|
1699 |
|
1700 |
|
1701 |
|
1702 |
|
1703 |
|
1704 |
|
1705 | <dt class="tag-source">Source:</dt>
|
1706 | <dd class="tag-source"><ul class="dummy"><li>
|
1707 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line41">line 41</a>
|
1708 | </li></ul></dd>
|
1709 |
|
1710 |
|
1711 |
|
1712 |
|
1713 |
|
1714 |
|
1715 |
|
1716 | </dl>
|
1717 |
|
1718 |
|
1719 |
|
1720 |
|
1721 |
|
1722 |
|
1723 |
|
1724 |
|
1725 |
|
1726 |
|
1727 |
|
1728 |
|
1729 |
|
1730 |
|
1731 |
|
1732 |
|
1733 |
|
1734 |
|
1735 |
|
1736 |
|
1737 |
|
1738 | <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
|
1739 |
|
1740 |
|
1741 |
|
1742 |
|
1743 |
|
1744 | <div class="description">
|
1745 | Save the local modification to the user object
|
1746 | </div>
|
1747 |
|
1748 |
|
1749 |
|
1750 |
|
1751 |
|
1752 |
|
1753 |
|
1754 |
|
1755 |
|
1756 |
|
1757 |
|
1758 |
|
1759 |
|
1760 | <dl class="details">
|
1761 |
|
1762 |
|
1763 |
|
1764 |
|
1765 |
|
1766 |
|
1767 |
|
1768 |
|
1769 |
|
1770 |
|
1771 |
|
1772 |
|
1773 |
|
1774 |
|
1775 |
|
1776 |
|
1777 |
|
1778 |
|
1779 |
|
1780 |
|
1781 |
|
1782 |
|
1783 |
|
1784 |
|
1785 |
|
1786 |
|
1787 | <dt class="tag-source">Source:</dt>
|
1788 | <dd class="tag-source"><ul class="dummy"><li>
|
1789 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line34">line 34</a>
|
1790 | </li></ul></dd>
|
1791 |
|
1792 |
|
1793 |
|
1794 |
|
1795 |
|
1796 |
|
1797 |
|
1798 | </dl>
|
1799 |
|
1800 |
|
1801 |
|
1802 |
|
1803 |
|
1804 |
|
1805 |
|
1806 |
|
1807 |
|
1808 |
|
1809 |
|
1810 |
|
1811 |
|
1812 |
|
1813 |
|
1814 |
|
1815 |
|
1816 |
|
1817 |
|
1818 |
|
1819 |
|
1820 | <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
|
1821 |
|
1822 |
|
1823 |
|
1824 |
|
1825 |
|
1826 | <div class="description">
|
1827 | Save the local modification to the user object
|
1828 | </div>
|
1829 |
|
1830 |
|
1831 |
|
1832 |
|
1833 |
|
1834 |
|
1835 |
|
1836 |
|
1837 |
|
1838 |
|
1839 |
|
1840 |
|
1841 |
|
1842 | <dl class="details">
|
1843 |
|
1844 |
|
1845 |
|
1846 |
|
1847 |
|
1848 |
|
1849 |
|
1850 |
|
1851 |
|
1852 |
|
1853 |
|
1854 |
|
1855 |
|
1856 |
|
1857 |
|
1858 |
|
1859 |
|
1860 |
|
1861 |
|
1862 |
|
1863 |
|
1864 |
|
1865 |
|
1866 |
|
1867 |
|
1868 |
|
1869 | <dt class="tag-source">Source:</dt>
|
1870 | <dd class="tag-source"><ul class="dummy"><li>
|
1871 | <a href="lib_model_User.js.html">lib/model/User.js</a>, <a href="lib_model_User.js.html#line34">line 34</a>
|
1872 | </li></ul></dd>
|
1873 |
|
1874 |
|
1875 |
|
1876 |
|
1877 |
|
1878 |
|
1879 |
|
1880 | </dl>
|
1881 |
|
1882 |
|
1883 |
|
1884 |
|
1885 |
|
1886 |
|
1887 |
|
1888 |
|
1889 |
|
1890 |
|
1891 |
|
1892 |
|
1893 |
|
1894 |
|
1895 |
|
1896 |
|
1897 |
|
1898 |
|
1899 |
|
1900 |
|
1901 |
|
1902 |
|
1903 | </article>
|
1904 |
|
1905 | </section>
|
1906 |
|
1907 |
|
1908 |
|
1909 |
|
1910 | </div>
|
1911 |
|
1912 | <nav>
|
1913 | <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Action.html">Action</a></li><li><a href="Channel.html">Channel</a></li><li><a href="Client.html">Client</a></li><li><a href="Raptor.html">Raptor</a></li><li><a href="RecordSet.html">RecordSet</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="ServiceObject.html">ServiceObject</a></li><li><a href="Stream.html">Stream</a></li><li><a href="User.html">User</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Container">Container</a></li></ul>
|
1914 | </nav>
|
1915 |
|
1916 | <br class="clear">
|
1917 |
|
1918 | <footer>
|
1919 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Wed Nov 02 2016 11:15:06 GMT+0100 (CET)
|
1920 | </footer>
|
1921 |
|
1922 | <script> prettyPrint(); </script>
|
1923 | <script src="scripts/linenumber.js"> </script>
|
1924 | </body>
|
1925 | </html> |
\ | No newline at end of file |