@docbrasil/api-systemmanager 1.0.107 → 1.0.109

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 (73) hide show
  1. package/.github/workflows/static.yml +43 -0
  2. package/api/external.js +41 -0
  3. package/dist/bundle.cjs +41 -0
  4. package/dist/bundle.mjs +1 -1
  5. package/doc/api.md +382 -0
  6. package/docs/Admin.html +336 -0
  7. package/docs/AdminDocuments.html +2235 -0
  8. package/docs/AdminForm.html +934 -0
  9. package/docs/AdminLists.html +895 -0
  10. package/docs/AdminMessage.html +1490 -0
  11. package/docs/AdminNotification.html +1636 -0
  12. package/docs/AdminPlugin.html +696 -0
  13. package/docs/AdminPolicy.html +451 -0
  14. package/docs/AdminProcesses.html +692 -0
  15. package/docs/AdminTask.html +740 -0
  16. package/docs/AdminUser.html +1203 -0
  17. package/docs/Datasource.html +660 -0
  18. package/docs/Dispatch.html +624 -0
  19. package/docs/Documents.html +4875 -0
  20. package/docs/External.html +1497 -0
  21. package/docs/GeoLocation.html +503 -0
  22. package/docs/Login.html +1839 -0
  23. package/docs/Notification.html +625 -0
  24. package/docs/Organization.html +2767 -0
  25. package/docs/Process.html +1598 -0
  26. package/docs/Register.html +1604 -0
  27. package/docs/Session.html +482 -0
  28. package/docs/Task.html +1394 -0
  29. package/docs/TaskAvailable.html +893 -0
  30. package/docs/User.html +2002 -0
  31. package/docs/Users.html +569 -0
  32. package/docs/admin_doctypes.js.html +193 -0
  33. package/docs/admin_document.js.html +449 -0
  34. package/docs/admin_form.js.html +268 -0
  35. package/docs/admin_index.js.html +163 -0
  36. package/docs/admin_list.js.html +250 -0
  37. package/docs/admin_message.js.html +311 -0
  38. package/docs/admin_notification.js.html +350 -0
  39. package/docs/admin_organization.js.html +241 -0
  40. package/docs/admin_plugin.js.html +233 -0
  41. package/docs/admin_policy.js.html +195 -0
  42. package/docs/admin_processes.js.html +487 -0
  43. package/docs/admin_task.js.html +242 -0
  44. package/docs/admin_user.js.html +302 -0
  45. package/docs/dispatch.js.html +218 -0
  46. package/docs/external.js.html +333 -0
  47. package/docs/general_geoLocation.js.html +205 -0
  48. package/docs/general_index.js.html +140 -0
  49. package/docs/index.html +129 -0
  50. package/docs/login.js.html +384 -0
  51. package/docs/scripts/app.min.js +1 -0
  52. package/docs/scripts/linenumber.js +26 -0
  53. package/docs/scripts/search.js +39 -0
  54. package/docs/session.js.html +202 -0
  55. package/docs/styles/app.min.css +1 -0
  56. package/docs/styles/iframe.css +13 -0
  57. package/docs/styles/prettify-jsdoc.css +111 -0
  58. package/docs/styles/prettify-tomorrow.css +132 -0
  59. package/docs/styles/reset.css +44 -0
  60. package/docs/user_datasource.js.html +261 -0
  61. package/docs/user_document.js.html +847 -0
  62. package/docs/user_index.js.html +156 -0
  63. package/docs/user_notification.js.html +218 -0
  64. package/docs/user_organization.js.html +347 -0
  65. package/docs/user_process.js.html +352 -0
  66. package/docs/user_register.js.html +322 -0
  67. package/docs/user_task.js.html +319 -0
  68. package/docs/user_task_available.js.html +252 -0
  69. package/docs/user_user.js.html +404 -0
  70. package/docs/utils_promises.js.html +235 -0
  71. package/package.json +7 -4
  72. package/readme.md +7 -8
  73. package/doc.md +0 -653
package/docs/Task.html ADDED
@@ -0,0 +1,1394 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width, initial-scale=1">
8
+ <title> Task</title>
9
+
10
+ <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
11
+ <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
12
+ <script src="./build/entry.js"></script>
13
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
18
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
19
+ <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
20
+ <link type="text/css" rel="stylesheet" href="styles/app.min.css">
21
+ <link type="text/css" rel="stylesheet" href="styles/iframe.css">
22
+ <link type="text/css" rel="stylesheet" href="">
23
+ <script async defer src="https://buttons.github.io/buttons.js"></script>
24
+
25
+
26
+ </head>
27
+
28
+
29
+
30
+ <body class="layout small-header">
31
+ <div id="stickyNavbarOverlay"></div>
32
+
33
+
34
+ <div class="top-nav">
35
+ <div class="inner">
36
+ <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
37
+ <span aria-hidden="true"></span>
38
+ <span aria-hidden="true"></span>
39
+ <span aria-hidden="true"></span>
40
+ </a>
41
+ <div class="logo">
42
+
43
+
44
+ </div>
45
+ <div class="menu">
46
+
47
+ <div class="navigation">
48
+ <a
49
+ href="index.html"
50
+ class="link"
51
+ >
52
+ Documentation
53
+ </a>
54
+
55
+
56
+
57
+ </div>
58
+ </div>
59
+ </div>
60
+ </div>
61
+ <div id="main">
62
+ <div
63
+ class="sidebar "
64
+ id="sidebarNav"
65
+ >
66
+
67
+ <nav>
68
+
69
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Login.html">Login</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
70
+
71
+ </nav>
72
+ </div>
73
+ <div class="core" id="main-content-wrapper">
74
+ <div class="content">
75
+ <header class="page-title">
76
+ <p>Class</p>
77
+ <h1>Task</h1>
78
+ </header>
79
+
80
+
81
+
82
+
83
+
84
+ <section>
85
+
86
+ <header>
87
+
88
+ <h2><span class="attribs"><span class="type-signature"></span></span>Task<span class="signature">()</span><span class="type-signature"></span></h2>
89
+
90
+ <div class="class-description">Class for task, permission user</div>
91
+
92
+
93
+ </header>
94
+
95
+ <article>
96
+ <div class="container-overview">
97
+
98
+
99
+ <div class='vertical-section'>
100
+ <div class="members">
101
+ <div class="member">
102
+ <div class=name>
103
+ <span class="tag">Constructor</span>
104
+ </div>
105
+
106
+
107
+
108
+
109
+ <h4 class="name" id="Task">
110
+ <a class="href-link" href="#Task">#</a>
111
+
112
+ <span class="code-name">
113
+
114
+ new Task<span class="signature">()</span><span class="type-signature"></span>
115
+
116
+ </span>
117
+ </h4>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <dl class="details">
136
+
137
+
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
+
165
+
166
+
167
+ <p class="tag-source">
168
+ <a href="user_task.js.html" class="button">View Source</a>
169
+ <span>
170
+ <a href="user_task.js.html">user/task.js</a>, <a href="user_task.js.html#line10">line 10</a>
171
+ </span>
172
+ </p>
173
+
174
+ </dl>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+ </div>
198
+ </div>
199
+ </div>
200
+
201
+
202
+ </div>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <div class='vertical-section'>
220
+ <h1>Methods</h1>
221
+ <div class="members">
222
+
223
+ <div class="member">
224
+
225
+
226
+
227
+ <h4 class="name" id="executeActionFinalize">
228
+ <a class="href-link" href="#executeActionFinalize">#</a>
229
+
230
+
231
+ <span class='tag'>async</span>
232
+
233
+
234
+ <span class="code-name">
235
+
236
+ executeActionFinalize<span class="signature">(params<span class="signature-attributes">non-null</span>, session)</span><span class="type-signature"> &rarr; {Promise}</span>
237
+
238
+ </span>
239
+ </h4>
240
+
241
+
242
+
243
+
244
+ <div class="description">
245
+ Find task by id and update
246
+ </div>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+ <h5>Parameters:</h5>
258
+
259
+ <div class="table-container">
260
+ <table class="params table">
261
+ <thead>
262
+ <tr>
263
+
264
+ <th>Name</th>
265
+
266
+
267
+ <th>Type</th>
268
+
269
+
270
+
271
+
272
+ <th>Default</th>
273
+
274
+
275
+ <th class="last">Description</th>
276
+ </tr>
277
+ </thead>
278
+
279
+ <tbody>
280
+
281
+
282
+
283
+ <tr class="deep-level-0">
284
+
285
+ <td class="name"><code>params</code></td>
286
+
287
+
288
+ <td class="type">
289
+
290
+
291
+ <code class="param-type">object</code>
292
+
293
+
294
+
295
+ </td>
296
+
297
+
298
+
299
+
300
+ <td class="default">
301
+
302
+ </td>
303
+
304
+
305
+ <td class="description last">Params - to update task</td>
306
+ </tr>
307
+
308
+
309
+
310
+
311
+ <tr class="deep-level-1">
312
+
313
+ <td class="name"><code>taskId</code></td>
314
+
315
+
316
+ <td class="type">
317
+
318
+
319
+ <code class="param-type">string</code>
320
+
321
+
322
+
323
+ </td>
324
+
325
+
326
+
327
+
328
+ <td class="default">
329
+
330
+ </td>
331
+
332
+
333
+ <td class="description last">Task id (_id database)</td>
334
+ </tr>
335
+
336
+
337
+
338
+ <tr class="deep-level-1">
339
+
340
+ <td class="name"><code>actionGuid</code></td>
341
+
342
+
343
+ <td class="type">
344
+
345
+
346
+ <code class="param-type">string</code>
347
+
348
+
349
+
350
+ </td>
351
+
352
+
353
+
354
+
355
+ <td class="default">
356
+
357
+ </td>
358
+
359
+
360
+ <td class="description last">GUID of the action</td>
361
+ </tr>
362
+
363
+
364
+
365
+ <tr class="deep-level-1">
366
+
367
+ <td class="name"><code>orgId</code></td>
368
+
369
+
370
+ <td class="type">
371
+
372
+
373
+ <code class="param-type">string</code>
374
+
375
+
376
+
377
+ </td>
378
+
379
+
380
+
381
+
382
+ <td class="default">
383
+
384
+ </td>
385
+
386
+
387
+ <td class="description last">Organization id (_id database)</td>
388
+ </tr>
389
+
390
+
391
+
392
+ <tr class="deep-level-1">
393
+
394
+ <td class="name"><code>payload</code></td>
395
+
396
+
397
+ <td class="type">
398
+
399
+
400
+ <code class="param-type">any</code>
401
+
402
+
403
+
404
+ </td>
405
+
406
+
407
+
408
+
409
+ <td class="default">
410
+
411
+ {}
412
+
413
+ </td>
414
+
415
+
416
+ <td class="description last">Payload to send in action</td>
417
+ </tr>
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+ <tr class="deep-level-0">
426
+
427
+ <td class="name"><code>session</code></td>
428
+
429
+
430
+ <td class="type">
431
+
432
+
433
+ <code class="param-type">string</code>
434
+
435
+
436
+
437
+ </td>
438
+
439
+
440
+
441
+
442
+ <td class="default">
443
+
444
+ </td>
445
+
446
+
447
+ <td class="description last">Session, token JWT</td>
448
+ </tr>
449
+
450
+
451
+
452
+ </tbody>
453
+ </table>
454
+ </div>
455
+
456
+
457
+
458
+
459
+
460
+ <dl class="details">
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+ <dt class="tag-author">Author:</dt>
480
+ <dd class="tag-author">
481
+ <ul>
482
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
483
+ </ul>
484
+ </dd>
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+ <p class="tag-source">
500
+ <a href="user_task.js.html" class="button">View Source</a>
501
+ <span>
502
+ <a href="user_task.js.html">user/task.js</a>, <a href="user_task.js.html#line181">line 181</a>
503
+ </span>
504
+ </p>
505
+
506
+ </dl>
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+ <div class='columns method-parameter'>
526
+ <div class="column is-2"><label>Returns:</label></div>
527
+ <div class="column is-10">
528
+
529
+
530
+
531
+ <div class="columns">
532
+
533
+
534
+ <div class='column is-5 has-text-left'>
535
+ <label>Type: </label>
536
+
537
+ <code class="param-type">Promise</code>
538
+
539
+
540
+ </div>
541
+
542
+ </div>
543
+
544
+
545
+ </div>
546
+ </div>
547
+
548
+
549
+
550
+
551
+ <h5>Example</h5>
552
+
553
+
554
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
555
+ const api = new API();
556
+ const params = {
557
+ taskId: '5df7f19618430c89a41a19d2',
558
+ actionGuid: 'b3823a2ae52c7a05bfb9590fe427038d'
559
+ orgId: '5df7f19618430c89a41a1bc3',
560
+ payload: {}',
561
+ };
562
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
563
+ await api.user.task.executeActionFinalize(params, session);</code></pre>
564
+
565
+
566
+
567
+ </div>
568
+
569
+ <div class="member">
570
+
571
+
572
+
573
+ <h4 class="name" id="findById">
574
+ <a class="href-link" href="#findById">#</a>
575
+
576
+
577
+ <span class='tag'>async</span>
578
+
579
+
580
+ <span class="code-name">
581
+
582
+ findById<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise}</span>
583
+
584
+ </span>
585
+ </h4>
586
+
587
+
588
+
589
+
590
+ <div class="description">
591
+ Method to find task by id
592
+ </div>
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+ <h5>Parameters:</h5>
604
+
605
+ <div class="table-container">
606
+ <table class="params table">
607
+ <thead>
608
+ <tr>
609
+
610
+ <th>Name</th>
611
+
612
+
613
+ <th>Type</th>
614
+
615
+
616
+
617
+
618
+
619
+ <th class="last">Description</th>
620
+ </tr>
621
+ </thead>
622
+
623
+ <tbody>
624
+
625
+
626
+
627
+ <tr class="deep-level-0">
628
+
629
+ <td class="name"><code>params</code></td>
630
+
631
+
632
+ <td class="type">
633
+
634
+
635
+ <code class="param-type">object</code>
636
+
637
+
638
+
639
+ </td>
640
+
641
+
642
+
643
+
644
+
645
+ <td class="description last">Params to get task</td>
646
+ </tr>
647
+
648
+
649
+
650
+
651
+ <tr class="deep-level-1">
652
+
653
+ <td class="name"><code>processId</code></td>
654
+
655
+
656
+ <td class="type">
657
+
658
+
659
+ <code class="param-type">object</code>
660
+
661
+
662
+
663
+ </td>
664
+
665
+
666
+
667
+
668
+
669
+ <td class="description last">Proccess id (_id database)</td>
670
+ </tr>
671
+
672
+
673
+
674
+ <tr class="deep-level-1">
675
+
676
+ <td class="name"><code>taskId</code></td>
677
+
678
+
679
+ <td class="type">
680
+
681
+
682
+ <code class="param-type">object</code>
683
+
684
+
685
+
686
+ </td>
687
+
688
+
689
+
690
+
691
+
692
+ <td class="description last">Task id (_id database)</td>
693
+ </tr>
694
+
695
+
696
+
697
+ <tr class="deep-level-1">
698
+
699
+ <td class="name"><code>orgId</code></td>
700
+
701
+
702
+ <td class="type">
703
+
704
+
705
+ <code class="param-type">object</code>
706
+
707
+
708
+
709
+ </td>
710
+
711
+
712
+
713
+
714
+
715
+ <td class="description last">Organization id (_id database)</td>
716
+ </tr>
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+ <tr class="deep-level-0">
725
+
726
+ <td class="name"><code>session</code></td>
727
+
728
+
729
+ <td class="type">
730
+
731
+
732
+ <code class="param-type">string</code>
733
+
734
+
735
+
736
+ </td>
737
+
738
+
739
+
740
+
741
+
742
+ <td class="description last">Session, token JWT</td>
743
+ </tr>
744
+
745
+
746
+
747
+ </tbody>
748
+ </table>
749
+ </div>
750
+
751
+
752
+
753
+
754
+
755
+ <dl class="details">
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+ <dt class="tag-author">Author:</dt>
775
+ <dd class="tag-author">
776
+ <ul>
777
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
778
+ </ul>
779
+ </dd>
780
+
781
+
782
+
783
+
784
+
785
+
786
+
787
+
788
+
789
+
790
+
791
+
792
+
793
+
794
+ <p class="tag-source">
795
+ <a href="user_task.js.html" class="button">View Source</a>
796
+ <span>
797
+ <a href="user_task.js.html">user/task.js</a>, <a href="user_task.js.html#line74">line 74</a>
798
+ </span>
799
+ </p>
800
+
801
+ </dl>
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+
818
+
819
+
820
+ <div class='columns method-parameter'>
821
+ <div class="column is-2"><label>Returns:</label></div>
822
+ <div class="column is-10">
823
+
824
+
825
+
826
+ <div class="columns">
827
+
828
+
829
+ <div class='column is-5 has-text-left'>
830
+ <label>Type: </label>
831
+
832
+ <code class="param-type">promise</code>
833
+
834
+
835
+ </div>
836
+
837
+ </div>
838
+
839
+
840
+ </div>
841
+ </div>
842
+
843
+
844
+
845
+
846
+ <h5>Example</h5>
847
+
848
+
849
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
850
+ const api = new API();
851
+ const params = {
852
+ processId: '5dadd01dc4af3941d42f8c5c',
853
+ taskId: '5df7f19618430c89a41a19d2',
854
+ orgId: '55e4a3bd6be6b45210833fae',
855
+ };
856
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
857
+ await api.user.task.findById(params, session);</code></pre>
858
+
859
+
860
+
861
+ </div>
862
+
863
+ <div class="member">
864
+
865
+
866
+
867
+ <h4 class="name" id="findByIdAndUpdate">
868
+ <a class="href-link" href="#findByIdAndUpdate">#</a>
869
+
870
+
871
+ <span class='tag'>async</span>
872
+
873
+
874
+ <span class="code-name">
875
+
876
+ findByIdAndUpdate<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise}</span>
877
+
878
+ </span>
879
+ </h4>
880
+
881
+
882
+
883
+
884
+ <div class="description">
885
+ Find task by id and update
886
+ </div>
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+ <h5>Parameters:</h5>
898
+
899
+ <div class="table-container">
900
+ <table class="params table">
901
+ <thead>
902
+ <tr>
903
+
904
+ <th>Name</th>
905
+
906
+
907
+ <th>Type</th>
908
+
909
+
910
+ <th>Attributes</th>
911
+
912
+
913
+
914
+
915
+ <th class="last">Description</th>
916
+ </tr>
917
+ </thead>
918
+
919
+ <tbody>
920
+
921
+
922
+
923
+ <tr class="deep-level-0">
924
+
925
+ <td class="name"><code>params</code></td>
926
+
927
+
928
+ <td class="type">
929
+
930
+
931
+ <code class="param-type">object</code>
932
+
933
+
934
+
935
+ </td>
936
+
937
+
938
+ <td class="attributes">
939
+
940
+
941
+
942
+
943
+
944
+ </td>
945
+
946
+
947
+
948
+
949
+ <td class="description last">Params to update task</td>
950
+ </tr>
951
+
952
+
953
+
954
+
955
+ <tr class="deep-level-1">
956
+
957
+ <td class="name"><code>userId</code></td>
958
+
959
+
960
+ <td class="type">
961
+
962
+
963
+ <code class="param-type">object</code>
964
+
965
+
966
+
967
+ </td>
968
+
969
+
970
+ <td class="attributes">
971
+
972
+
973
+
974
+
975
+
976
+ </td>
977
+
978
+
979
+
980
+
981
+ <td class="description last">User id (_id database)</td>
982
+ </tr>
983
+
984
+
985
+
986
+ <tr class="deep-level-1">
987
+
988
+ <td class="name"><code>processId</code></td>
989
+
990
+
991
+ <td class="type">
992
+
993
+
994
+ <code class="param-type">string</code>
995
+
996
+
997
+
998
+ </td>
999
+
1000
+
1001
+ <td class="attributes">
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+ </td>
1008
+
1009
+
1010
+
1011
+
1012
+ <td class="description last">Proccess id (_id database)</td>
1013
+ </tr>
1014
+
1015
+
1016
+
1017
+ <tr class="deep-level-1">
1018
+
1019
+ <td class="name"><code>taskId</code></td>
1020
+
1021
+
1022
+ <td class="type">
1023
+
1024
+
1025
+ <code class="param-type">string</code>
1026
+
1027
+
1028
+
1029
+ </td>
1030
+
1031
+
1032
+ <td class="attributes">
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+ </td>
1039
+
1040
+
1041
+
1042
+
1043
+ <td class="description last">Task id (_id database)</td>
1044
+ </tr>
1045
+
1046
+
1047
+
1048
+ <tr class="deep-level-1">
1049
+
1050
+ <td class="name"><code>flowName</code></td>
1051
+
1052
+
1053
+ <td class="type">
1054
+
1055
+
1056
+ <code class="param-type">string</code>
1057
+
1058
+
1059
+
1060
+ </td>
1061
+
1062
+
1063
+ <td class="attributes">
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+ </td>
1070
+
1071
+
1072
+
1073
+
1074
+ <td class="description last">Flow name</td>
1075
+ </tr>
1076
+
1077
+
1078
+
1079
+ <tr class="deep-level-1">
1080
+
1081
+ <td class="name"><code>action</code></td>
1082
+
1083
+
1084
+ <td class="type">
1085
+
1086
+
1087
+ <code class="param-type">string</code>
1088
+
1089
+
1090
+
1091
+ </td>
1092
+
1093
+
1094
+ <td class="attributes">
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+ </td>
1101
+
1102
+
1103
+
1104
+
1105
+ <td class="description last">Button action</td>
1106
+ </tr>
1107
+
1108
+
1109
+
1110
+ <tr class="deep-level-1">
1111
+
1112
+ <td class="name"><code>formData</code></td>
1113
+
1114
+
1115
+ <td class="type">
1116
+
1117
+
1118
+ <code class="param-type">object</code>
1119
+
1120
+
1121
+
1122
+ </td>
1123
+
1124
+
1125
+ <td class="attributes">
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+ </td>
1132
+
1133
+
1134
+
1135
+
1136
+ <td class="description last">Data to update task</td>
1137
+ </tr>
1138
+
1139
+
1140
+
1141
+ <tr class="deep-level-1">
1142
+
1143
+ <td class="name"><code>actionGuid</code></td>
1144
+
1145
+
1146
+ <td class="type">
1147
+
1148
+
1149
+ <code class="param-type">string</code>
1150
+
1151
+
1152
+
1153
+ </td>
1154
+
1155
+
1156
+ <td class="attributes">
1157
+
1158
+ &lt;optional><br>
1159
+
1160
+
1161
+
1162
+
1163
+
1164
+ </td>
1165
+
1166
+
1167
+
1168
+
1169
+ <td class="description last">GUID of the action</td>
1170
+ </tr>
1171
+
1172
+
1173
+
1174
+ <tr class="deep-level-1">
1175
+
1176
+ <td class="name"><code>orgId</code></td>
1177
+
1178
+
1179
+ <td class="type">
1180
+
1181
+
1182
+ <code class="param-type">string</code>
1183
+
1184
+
1185
+
1186
+ </td>
1187
+
1188
+
1189
+ <td class="attributes">
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+ </td>
1196
+
1197
+
1198
+
1199
+
1200
+ <td class="description last">Organization id (_id database)</td>
1201
+ </tr>
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+ <tr class="deep-level-0">
1210
+
1211
+ <td class="name"><code>session</code></td>
1212
+
1213
+
1214
+ <td class="type">
1215
+
1216
+
1217
+ <code class="param-type">string</code>
1218
+
1219
+
1220
+
1221
+ </td>
1222
+
1223
+
1224
+ <td class="attributes">
1225
+
1226
+
1227
+
1228
+
1229
+
1230
+ </td>
1231
+
1232
+
1233
+
1234
+
1235
+ <td class="description last">Session, token JWT</td>
1236
+ </tr>
1237
+
1238
+
1239
+
1240
+ </tbody>
1241
+ </table>
1242
+ </div>
1243
+
1244
+
1245
+
1246
+
1247
+
1248
+ <dl class="details">
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+ <dt class="tag-author">Author:</dt>
1268
+ <dd class="tag-author">
1269
+ <ul>
1270
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
1271
+ </ul>
1272
+ </dd>
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+ <p class="tag-source">
1288
+ <a href="user_task.js.html" class="button">View Source</a>
1289
+ <span>
1290
+ <a href="user_task.js.html">user/task.js</a>, <a href="user_task.js.html#line124">line 124</a>
1291
+ </span>
1292
+ </p>
1293
+
1294
+ </dl>
1295
+
1296
+
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+
1304
+
1305
+
1306
+
1307
+
1308
+
1309
+
1310
+
1311
+
1312
+
1313
+ <div class='columns method-parameter'>
1314
+ <div class="column is-2"><label>Returns:</label></div>
1315
+ <div class="column is-10">
1316
+
1317
+
1318
+
1319
+ <div class="columns">
1320
+
1321
+
1322
+ <div class='column is-5 has-text-left'>
1323
+ <label>Type: </label>
1324
+
1325
+ <code class="param-type">Promise</code>
1326
+
1327
+
1328
+ </div>
1329
+
1330
+ </div>
1331
+
1332
+
1333
+ </div>
1334
+ </div>
1335
+
1336
+
1337
+
1338
+
1339
+ <h5>Example</h5>
1340
+
1341
+
1342
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1343
+ const api = new API();
1344
+ const params = {
1345
+ userId: '5739d4c6ccb0ebc61f2a9557',
1346
+ processId: '5dadd01dc4af3941d42f8c5c',
1347
+ taskId: '5df7f19618430c89a41a19d2',
1348
+ action: 1,
1349
+ formData: {name: 'CloudBrasil'},
1350
+ };
1351
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1352
+ await api.user.task.findByIdAndUpdate(params, session);</code></pre>
1353
+
1354
+
1355
+
1356
+ </div>
1357
+
1358
+ </div>
1359
+ </div>
1360
+
1361
+
1362
+
1363
+
1364
+
1365
+ </article>
1366
+
1367
+ </section>
1368
+
1369
+
1370
+
1371
+
1372
+ </div>
1373
+
1374
+ <footer class="footer">
1375
+ <div class="content has-text-centered">
1376
+ <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
1377
+ <p class="sidebar-created-by">
1378
+ <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
1379
+ <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
1380
+ </p>
1381
+ </div>
1382
+ </footer>
1383
+
1384
+ </div>
1385
+ <div id="side-nav" class="side-nav">
1386
+ </div>
1387
+ </div>
1388
+ <script src="scripts/app.min.js"></script>
1389
+ <script>PR.prettyPrint();</script>
1390
+ <script src="scripts/linenumber.js"> </script>
1391
+
1392
+
1393
+ </body>
1394
+ </html>