@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
@@ -0,0 +1,1490 @@
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> AdminMessage</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>AdminMessage</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>AdminMessage<span class="signature">()</span><span class="type-signature"></span></h2>
89
+
90
+ <div class="class-description">Admin Class for user, permission admin</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="AdminMessage">
110
+ <a class="href-link" href="#AdminMessage">#</a>
111
+
112
+ <span class="code-name">
113
+
114
+ new AdminMessage<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="admin_message.js.html" class="button">View Source</a>
169
+ <span>
170
+ <a href="admin_message.js.html">admin/message.js</a>, <a href="admin_message.js.html#line9">line 9</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="_paginationOfTheSMS">
228
+ <a class="href-link" href="#_paginationOfTheSMS">#</a>
229
+
230
+ <span class="code-name">
231
+
232
+ _paginationOfTheSMS<span class="signature">(params<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span>
233
+
234
+ </span>
235
+ </h4>
236
+
237
+
238
+
239
+
240
+ <div class="description">
241
+ Pagination SMS texts
242
+ </div>
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+ <h5>Parameters:</h5>
254
+
255
+ <div class="table-container">
256
+ <table class="params table">
257
+ <thead>
258
+ <tr>
259
+
260
+ <th>Name</th>
261
+
262
+
263
+ <th>Type</th>
264
+
265
+
266
+
267
+
268
+ <th>Default</th>
269
+
270
+
271
+ <th class="last">Description</th>
272
+ </tr>
273
+ </thead>
274
+
275
+ <tbody>
276
+
277
+
278
+
279
+ <tr class="deep-level-0">
280
+
281
+ <td class="name"><code>params</code></td>
282
+
283
+
284
+ <td class="type">
285
+
286
+
287
+ <code class="param-type">object</code>
288
+
289
+
290
+
291
+ </td>
292
+
293
+
294
+
295
+
296
+ <td class="default">
297
+
298
+ </td>
299
+
300
+
301
+ <td class="description last">Params to pagintion SMS</td>
302
+ </tr>
303
+
304
+
305
+
306
+
307
+ <tr class="deep-level-1">
308
+
309
+ <td class="name"><code>message</code></td>
310
+
311
+
312
+ <td class="type">
313
+
314
+
315
+ <code class="param-type">string</code>
316
+
317
+
318
+
319
+ </td>
320
+
321
+
322
+
323
+
324
+ <td class="default">
325
+
326
+ </td>
327
+
328
+
329
+ <td class="description last">Message to pagination</td>
330
+ </tr>
331
+
332
+
333
+
334
+ <tr class="deep-level-1">
335
+
336
+ <td class="name"><code>limitSize</code></td>
337
+
338
+
339
+ <td class="type">
340
+
341
+
342
+ <code class="param-type">number</code>
343
+
344
+
345
+
346
+ </td>
347
+
348
+
349
+
350
+
351
+ <td class="default">
352
+
353
+ 130
354
+
355
+ </td>
356
+
357
+
358
+ <td class="description last">Limit of the start pagination</td>
359
+ </tr>
360
+
361
+
362
+
363
+ <tr class="deep-level-1">
364
+
365
+ <td class="name"><code>continueText</code></td>
366
+
367
+
368
+ <td class="type">
369
+
370
+
371
+ <code class="param-type">number</code>
372
+
373
+
374
+
375
+ </td>
376
+
377
+
378
+
379
+
380
+ <td class="default">
381
+
382
+ continua...
383
+
384
+ </td>
385
+
386
+
387
+ <td class="description last">Text to continue other SMS</td>
388
+ </tr>
389
+
390
+
391
+
392
+
393
+
394
+ </tbody>
395
+ </table>
396
+ </div>
397
+
398
+
399
+
400
+
401
+
402
+ <dl class="details">
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+ <p class="tag-source">
435
+ <a href="admin_message.js.html" class="button">View Source</a>
436
+ <span>
437
+ <a href="admin_message.js.html">admin/message.js</a>, <a href="admin_message.js.html#line57">line 57</a>
438
+ </span>
439
+ </p>
440
+
441
+ </dl>
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+ </div>
464
+
465
+ <div class="member">
466
+
467
+
468
+
469
+ <h4 class="name" id="_validItemToSendEmail">
470
+ <a class="href-link" href="#_validItemToSendEmail">#</a>
471
+
472
+ <span class="code-name">
473
+
474
+ _validItemToSendEmail<span class="signature">(params<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span>
475
+
476
+ </span>
477
+ </h4>
478
+
479
+
480
+
481
+
482
+ <div class="description">
483
+ Validation struct to send email
484
+ </div>
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+ <h5>Parameters:</h5>
496
+
497
+ <div class="table-container">
498
+ <table class="params table">
499
+ <thead>
500
+ <tr>
501
+
502
+ <th>Name</th>
503
+
504
+
505
+ <th>Type</th>
506
+
507
+
508
+ <th>Attributes</th>
509
+
510
+
511
+
512
+
513
+ <th class="last">Description</th>
514
+ </tr>
515
+ </thead>
516
+
517
+ <tbody>
518
+
519
+
520
+
521
+ <tr class="deep-level-0">
522
+
523
+ <td class="name"><code>params</code></td>
524
+
525
+
526
+ <td class="type">
527
+
528
+
529
+ <code class="param-type">object</code>
530
+
531
+
532
+
533
+ </td>
534
+
535
+
536
+ <td class="attributes">
537
+
538
+
539
+
540
+
541
+
542
+ </td>
543
+
544
+
545
+
546
+
547
+ <td class="description last">Params to send email</td>
548
+ </tr>
549
+
550
+
551
+
552
+
553
+ <tr class="deep-level-1">
554
+
555
+ <td class="name"><code>subject</code></td>
556
+
557
+
558
+ <td class="type">
559
+
560
+
561
+ <code class="param-type">string</code>
562
+
563
+
564
+
565
+ </td>
566
+
567
+
568
+ <td class="attributes">
569
+
570
+
571
+
572
+
573
+
574
+ </td>
575
+
576
+
577
+
578
+
579
+ <td class="description last">Subject of the email</td>
580
+ </tr>
581
+
582
+
583
+
584
+ <tr class="deep-level-1">
585
+
586
+ <td class="name"><code>message</code></td>
587
+
588
+
589
+ <td class="type">
590
+
591
+
592
+ <code class="param-type">string</code>
593
+
594
+
595
+
596
+ </td>
597
+
598
+
599
+ <td class="attributes">
600
+
601
+
602
+
603
+
604
+
605
+ </td>
606
+
607
+
608
+
609
+
610
+ <td class="description last">Body of the email</td>
611
+ </tr>
612
+
613
+
614
+
615
+ <tr class="deep-level-1">
616
+
617
+ <td class="name"><code>to</code></td>
618
+
619
+
620
+ <td class="type">
621
+
622
+
623
+ <code class="param-type">string</code>
624
+
625
+
626
+
627
+ </td>
628
+
629
+
630
+ <td class="attributes">
631
+
632
+
633
+
634
+
635
+
636
+ </td>
637
+
638
+
639
+
640
+
641
+ <td class="description last">Destination email</td>
642
+ </tr>
643
+
644
+
645
+
646
+ <tr class="deep-level-1">
647
+
648
+ <td class="name"><code>from</code></td>
649
+
650
+
651
+ <td class="type">
652
+
653
+
654
+ <code class="param-type">string</code>
655
+
656
+
657
+
658
+ </td>
659
+
660
+
661
+ <td class="attributes">
662
+
663
+
664
+
665
+ &lt;nullable><br>
666
+
667
+
668
+
669
+ </td>
670
+
671
+
672
+
673
+
674
+ <td class="description last">Source email</td>
675
+ </tr>
676
+
677
+
678
+
679
+
680
+
681
+ </tbody>
682
+ </table>
683
+ </div>
684
+
685
+
686
+
687
+
688
+
689
+ <dl class="details">
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+ <p class="tag-source">
722
+ <a href="admin_message.js.html" class="button">View Source</a>
723
+ <span>
724
+ <a href="admin_message.js.html">admin/message.js</a>, <a href="admin_message.js.html#line93">line 93</a>
725
+ </span>
726
+ </p>
727
+
728
+ </dl>
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+ </div>
751
+
752
+ <div class="member">
753
+
754
+
755
+
756
+ <h4 class="name" id="sendEmail">
757
+ <a class="href-link" href="#sendEmail">#</a>
758
+
759
+
760
+ <span class='tag'>async</span>
761
+
762
+
763
+ <span class="code-name">
764
+
765
+ sendEmail<span class="signature">(params<span class="signature-attributes">non-null</span>, session)</span><span class="type-signature"> &rarr; {Promise.&lt;{success: boolean, sent: Array.&lt;object>}>}</span>
766
+
767
+ </span>
768
+ </h4>
769
+
770
+
771
+
772
+
773
+ <div class="description">
774
+ Send email, array with email list or send one email
775
+ </div>
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+
786
+ <h5>Parameters:</h5>
787
+
788
+ <div class="table-container">
789
+ <table class="params table">
790
+ <thead>
791
+ <tr>
792
+
793
+ <th>Name</th>
794
+
795
+
796
+ <th>Type</th>
797
+
798
+
799
+ <th>Attributes</th>
800
+
801
+
802
+
803
+
804
+ <th class="last">Description</th>
805
+ </tr>
806
+ </thead>
807
+
808
+ <tbody>
809
+
810
+
811
+
812
+ <tr class="deep-level-0">
813
+
814
+ <td class="name"><code>params</code></td>
815
+
816
+
817
+ <td class="type">
818
+
819
+
820
+ <code class="param-type">object</code>
821
+
822
+
823
+
824
+ </td>
825
+
826
+
827
+ <td class="attributes">
828
+
829
+
830
+
831
+
832
+
833
+ </td>
834
+
835
+
836
+
837
+
838
+ <td class="description last">Params to send email</td>
839
+ </tr>
840
+
841
+
842
+
843
+
844
+ <tr class="deep-level-1">
845
+
846
+ <td class="name"><code>subject</code></td>
847
+
848
+
849
+ <td class="type">
850
+
851
+
852
+ <code class="param-type">string</code>
853
+
854
+
855
+
856
+ </td>
857
+
858
+
859
+ <td class="attributes">
860
+
861
+
862
+
863
+
864
+
865
+ </td>
866
+
867
+
868
+
869
+
870
+ <td class="description last">Subject of the email</td>
871
+ </tr>
872
+
873
+
874
+
875
+ <tr class="deep-level-1">
876
+
877
+ <td class="name"><code>message</code></td>
878
+
879
+
880
+ <td class="type">
881
+
882
+
883
+ <code class="param-type">string</code>
884
+
885
+
886
+
887
+ </td>
888
+
889
+
890
+ <td class="attributes">
891
+
892
+
893
+
894
+
895
+
896
+ </td>
897
+
898
+
899
+
900
+
901
+ <td class="description last">Body of the email</td>
902
+ </tr>
903
+
904
+
905
+
906
+ <tr class="deep-level-1">
907
+
908
+ <td class="name"><code>to</code></td>
909
+
910
+
911
+ <td class="type">
912
+
913
+
914
+ <code class="param-type">string</code>
915
+
916
+
917
+
918
+ </td>
919
+
920
+
921
+ <td class="attributes">
922
+
923
+
924
+
925
+
926
+
927
+ </td>
928
+
929
+
930
+
931
+
932
+ <td class="description last">Destination email</td>
933
+ </tr>
934
+
935
+
936
+
937
+ <tr class="deep-level-1">
938
+
939
+ <td class="name"><code>from</code></td>
940
+
941
+
942
+ <td class="type">
943
+
944
+
945
+ <code class="param-type">string</code>
946
+
947
+
948
+
949
+ </td>
950
+
951
+
952
+ <td class="attributes">
953
+
954
+
955
+
956
+ &lt;nullable><br>
957
+
958
+
959
+
960
+ </td>
961
+
962
+
963
+
964
+
965
+ <td class="description last">Source email</td>
966
+ </tr>
967
+
968
+
969
+
970
+
971
+
972
+
973
+
974
+ <tr class="deep-level-0">
975
+
976
+ <td class="name"><code>session</code></td>
977
+
978
+
979
+ <td class="type">
980
+
981
+
982
+ <code class="param-type">string</code>
983
+
984
+
985
+
986
+ </td>
987
+
988
+
989
+ <td class="attributes">
990
+
991
+
992
+
993
+
994
+
995
+ </td>
996
+
997
+
998
+
999
+
1000
+ <td class="description last">Session, token JWT</td>
1001
+ </tr>
1002
+
1003
+
1004
+
1005
+ </tbody>
1006
+ </table>
1007
+ </div>
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+ <dl class="details">
1014
+
1015
+
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+
1025
+
1026
+
1027
+
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+
1043
+
1044
+
1045
+ <p class="tag-source">
1046
+ <a href="admin_message.js.html" class="button">View Source</a>
1047
+ <span>
1048
+ <a href="admin_message.js.html">admin/message.js</a>, <a href="admin_message.js.html#line164">line 164</a>
1049
+ </span>
1050
+ </p>
1051
+
1052
+ </dl>
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+ <div class='columns method-parameter'>
1072
+ <div class="column is-2"><label>Returns:</label></div>
1073
+ <div class="column is-10">
1074
+
1075
+
1076
+
1077
+ <div class="columns">
1078
+
1079
+ <div class='param-desc column is-7'>- Success and email sent</div>
1080
+
1081
+
1082
+ <div class='column is-5 has-text-left'>
1083
+ <label>Type: </label>
1084
+
1085
+ <code class="param-type">Promise.&lt;{success: boolean, sent: Array.&lt;object>}></code>
1086
+
1087
+
1088
+ </div>
1089
+
1090
+ </div>
1091
+
1092
+
1093
+ </div>
1094
+ </div>
1095
+
1096
+
1097
+
1098
+
1099
+ <h5>Example</h5>
1100
+
1101
+
1102
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1103
+ const api = new API();
1104
+ const params = {
1105
+ subject: 'Test email',
1106
+ message: '&lt;h1>Hi!&lt;/h1>',
1107
+ to: 'destination@gmail.com'
1108
+ };
1109
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1110
+ await api.admin.message.sendEmail(params, session);</code></pre>
1111
+
1112
+
1113
+
1114
+ </div>
1115
+
1116
+ <div class="member">
1117
+
1118
+
1119
+
1120
+ <h4 class="name" id="sendSMS">
1121
+ <a class="href-link" href="#sendSMS">#</a>
1122
+
1123
+
1124
+ <span class='tag'>async</span>
1125
+
1126
+
1127
+ <span class="code-name">
1128
+
1129
+ sendSMS<span class="signature">(params<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;{}>}</span>
1130
+
1131
+ </span>
1132
+ </h4>
1133
+
1134
+
1135
+
1136
+
1137
+ <div class="description">
1138
+ Send an SMS message
1139
+ </div>
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+ <h5>Parameters:</h5>
1151
+
1152
+ <div class="table-container">
1153
+ <table class="params table">
1154
+ <thead>
1155
+ <tr>
1156
+
1157
+ <th>Name</th>
1158
+
1159
+
1160
+ <th>Type</th>
1161
+
1162
+
1163
+ <th>Attributes</th>
1164
+
1165
+
1166
+
1167
+ <th>Default</th>
1168
+
1169
+
1170
+ <th class="last">Description</th>
1171
+ </tr>
1172
+ </thead>
1173
+
1174
+ <tbody>
1175
+
1176
+
1177
+
1178
+ <tr class="deep-level-0">
1179
+
1180
+ <td class="name"><code>params</code></td>
1181
+
1182
+
1183
+ <td class="type">
1184
+
1185
+
1186
+ <code class="param-type">object</code>
1187
+
1188
+
1189
+
1190
+ </td>
1191
+
1192
+
1193
+ <td class="attributes">
1194
+
1195
+
1196
+
1197
+
1198
+
1199
+ </td>
1200
+
1201
+
1202
+
1203
+ <td class="default">
1204
+
1205
+ </td>
1206
+
1207
+
1208
+ <td class="description last">Params to send SMS</td>
1209
+ </tr>
1210
+
1211
+
1212
+
1213
+
1214
+ <tr class="deep-level-1">
1215
+
1216
+ <td class="name"><code>apiKey</code></td>
1217
+
1218
+
1219
+ <td class="type">
1220
+
1221
+
1222
+ <code class="param-type">string</code>
1223
+
1224
+
1225
+
1226
+ </td>
1227
+
1228
+
1229
+ <td class="attributes">
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+ </td>
1236
+
1237
+
1238
+
1239
+ <td class="default">
1240
+
1241
+ </td>
1242
+
1243
+
1244
+ <td class="description last">Organization API key</td>
1245
+ </tr>
1246
+
1247
+
1248
+
1249
+ <tr class="deep-level-1">
1250
+
1251
+ <td class="name"><code>message</code></td>
1252
+
1253
+
1254
+ <td class="type">
1255
+
1256
+
1257
+ <code class="param-type">string</code>
1258
+
1259
+
1260
+
1261
+ </td>
1262
+
1263
+
1264
+ <td class="attributes">
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+ </td>
1271
+
1272
+
1273
+
1274
+ <td class="default">
1275
+
1276
+ </td>
1277
+
1278
+
1279
+ <td class="description last">The text message to send</td>
1280
+ </tr>
1281
+
1282
+
1283
+
1284
+ <tr class="deep-level-1">
1285
+
1286
+ <td class="name"><code>recipient</code></td>
1287
+
1288
+
1289
+ <td class="type">
1290
+
1291
+
1292
+ <code class="param-type">string</code>
1293
+
1294
+
1295
+
1296
+ </td>
1297
+
1298
+
1299
+ <td class="attributes">
1300
+
1301
+
1302
+
1303
+
1304
+
1305
+ </td>
1306
+
1307
+
1308
+
1309
+ <td class="default">
1310
+
1311
+ </td>
1312
+
1313
+
1314
+ <td class="description last">The telephone number without with only numbers</td>
1315
+ </tr>
1316
+
1317
+
1318
+
1319
+ <tr class="deep-level-1">
1320
+
1321
+ <td class="name"><code>limitSize</code></td>
1322
+
1323
+
1324
+ <td class="type">
1325
+
1326
+
1327
+ <code class="param-type">number</code>
1328
+
1329
+
1330
+
1331
+ </td>
1332
+
1333
+
1334
+ <td class="attributes">
1335
+
1336
+
1337
+
1338
+ &lt;nullable><br>
1339
+
1340
+
1341
+
1342
+ </td>
1343
+
1344
+
1345
+
1346
+ <td class="default">
1347
+
1348
+ 130
1349
+
1350
+ </td>
1351
+
1352
+
1353
+ <td class="description last">Size limit to send SMS</td>
1354
+ </tr>
1355
+
1356
+
1357
+
1358
+
1359
+
1360
+ </tbody>
1361
+ </table>
1362
+ </div>
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+ <dl class="details">
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+
1383
+
1384
+
1385
+
1386
+
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+
1398
+
1399
+
1400
+ <p class="tag-source">
1401
+ <a href="admin_message.js.html" class="button">View Source</a>
1402
+ <span>
1403
+ <a href="admin_message.js.html">admin/message.js</a>, <a href="admin_message.js.html#line116">line 116</a>
1404
+ </span>
1405
+ </p>
1406
+
1407
+ </dl>
1408
+
1409
+
1410
+
1411
+
1412
+
1413
+
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+
1426
+ <div class='columns method-parameter'>
1427
+ <div class="column is-2"><label>Returns:</label></div>
1428
+ <div class="column is-10">
1429
+
1430
+
1431
+
1432
+ <div class="columns">
1433
+
1434
+
1435
+ <div class='column is-5 has-text-left'>
1436
+ <label>Type: </label>
1437
+
1438
+ <code class="param-type">Promise.&lt;{}></code>
1439
+
1440
+
1441
+ </div>
1442
+
1443
+ </div>
1444
+
1445
+
1446
+ </div>
1447
+ </div>
1448
+
1449
+
1450
+
1451
+
1452
+ </div>
1453
+
1454
+ </div>
1455
+ </div>
1456
+
1457
+
1458
+
1459
+
1460
+
1461
+ </article>
1462
+
1463
+ </section>
1464
+
1465
+
1466
+
1467
+
1468
+ </div>
1469
+
1470
+ <footer class="footer">
1471
+ <div class="content has-text-centered">
1472
+ <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
1473
+ <p class="sidebar-created-by">
1474
+ <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
1475
+ <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
1476
+ </p>
1477
+ </div>
1478
+ </footer>
1479
+
1480
+ </div>
1481
+ <div id="side-nav" class="side-nav">
1482
+ </div>
1483
+ </div>
1484
+ <script src="scripts/app.min.js"></script>
1485
+ <script>PR.prettyPrint();</script>
1486
+ <script src="scripts/linenumber.js"> </script>
1487
+
1488
+
1489
+ </body>
1490
+ </html>