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