@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,1604 @@
|
|
|
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> Register</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>Register</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>Register<span class="signature">()</span><span class="type-signature"></span></h2>
|
|
89
|
+
|
|
90
|
+
<div class="class-description">Class for user registration in a 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="Register">
|
|
110
|
+
<a class="href-link" href="#Register">#</a>
|
|
111
|
+
|
|
112
|
+
<span class="code-name">
|
|
113
|
+
|
|
114
|
+
new Register<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_register.js.html" class="button">View Source</a>
|
|
169
|
+
<span>
|
|
170
|
+
<a href="user_register.js.html">user/register.js</a>, <a href="user_register.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="execute">
|
|
228
|
+
<a class="href-link" href="#execute">#</a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class='tag'>async</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="code-name">
|
|
235
|
+
|
|
236
|
+
execute<span class="signature">(params)</span><span class="type-signature"> → {promise.<object>|boolean|boolean|object|string}</span>
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
</h4>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<div class="description">
|
|
245
|
+
Method to register a user
|
|
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 get task</td>
|
|
306
|
+
</tr>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
<tr class="deep-level-1">
|
|
312
|
+
|
|
313
|
+
<td class="name"><code>registerId</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">The registerId that comes with the registration page context</td>
|
|
334
|
+
</tr>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<tr class="deep-level-1">
|
|
339
|
+
|
|
340
|
+
<td class="name"><code>type</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
|
+
sign
|
|
358
|
+
|
|
359
|
+
</td>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<td class="description last">The type of the registration. By defailt,</td>
|
|
363
|
+
</tr>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
<tr class="deep-level-1">
|
|
368
|
+
|
|
369
|
+
<td class="name"><code>login</code></td>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<td class="type">
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<code class="param-type">boolean</code>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
</td>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<td class="default">
|
|
385
|
+
|
|
386
|
+
false
|
|
387
|
+
|
|
388
|
+
</td>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
<td class="description last">If we want to login the user directly after registering the user successfully. If you have a redirect, the best option is to login automatically.</td>
|
|
392
|
+
</tr>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
<tr class="deep-level-1">
|
|
397
|
+
|
|
398
|
+
<td class="name"><code>emailInfo</code></td>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<td class="type">
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
<code class="param-type">object</code>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
</td>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
<td class="default">
|
|
414
|
+
|
|
415
|
+
</td>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
<td class="description last">The information for the email validation</td>
|
|
419
|
+
</tr>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<tr class="deep-level-1">
|
|
424
|
+
|
|
425
|
+
<td class="name"><code>emailInfo.email</code></td>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<td class="type">
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
<code class="param-type">string</code>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
</td>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<td class="default">
|
|
441
|
+
|
|
442
|
+
</td>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
<td class="description last">The email validation information</td>
|
|
446
|
+
</tr>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<tr class="deep-level-1">
|
|
451
|
+
|
|
452
|
+
<td class="name"><code>emailInfo.code</code></td>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
<td class="type">
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
<code class="param-type">string</code>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
</td>
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<td class="default">
|
|
468
|
+
|
|
469
|
+
</td>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
<td class="description last">The 4 digit code to validate the email</td>
|
|
473
|
+
</tr>
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
<tr class="deep-level-1">
|
|
478
|
+
|
|
479
|
+
<td class="name"><code>registerData</code></td>
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
<td class="type">
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
<code class="param-type">object</code>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
</td>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
<td class="default">
|
|
495
|
+
|
|
496
|
+
</td>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
<td class="description last">The registration data</td>
|
|
500
|
+
</tr>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
<tr class="deep-level-1">
|
|
505
|
+
|
|
506
|
+
<td class="name"><code>registerData.name</code></td>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
<td class="type">
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
<code class="param-type">string</code>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
</td>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<td class="default">
|
|
522
|
+
|
|
523
|
+
</td>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
<td class="description last">The name if the user</td>
|
|
527
|
+
</tr>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
<tr class="deep-level-1">
|
|
532
|
+
|
|
533
|
+
<td class="name"><code>registerData.registerEmail</code></td>
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
<td class="type">
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
<code class="param-type">string</code>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
</td>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
<td class="default">
|
|
549
|
+
|
|
550
|
+
</td>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<td class="description last">The email of the user</td>
|
|
554
|
+
</tr>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
<tr class="deep-level-1">
|
|
559
|
+
|
|
560
|
+
<td class="name"><code>registerData.phone</code></td>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<td class="type">
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<code class="param-type">string</code>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
</td>
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
<td class="default">
|
|
576
|
+
|
|
577
|
+
</td>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
<td class="description last">The phone of the user</td>
|
|
581
|
+
</tr>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
<tr class="deep-level-1">
|
|
586
|
+
|
|
587
|
+
<td class="name"><code>registerData.idcard</code></td>
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
<td class="type">
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
<code class="param-type">string</code>
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
</td>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
<td class="default">
|
|
603
|
+
|
|
604
|
+
</td>
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
<td class="description last">The ID card of the user</td>
|
|
608
|
+
</tr>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
<tr class="deep-level-1">
|
|
613
|
+
|
|
614
|
+
<td class="name"><code>registerData.registerPassword</code></td>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<td class="type">
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
<code class="param-type">string</code>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
</td>
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
<td class="default">
|
|
630
|
+
|
|
631
|
+
</td>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
<td class="description last">The user password in open text</td>
|
|
635
|
+
</tr>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
<tr class="deep-level-1">
|
|
640
|
+
|
|
641
|
+
<td class="name"><code>registerData.emailValidationCode</code></td>
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
<td class="type">
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
<code class="param-type">string</code>
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
</td>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
<td class="default">
|
|
657
|
+
|
|
658
|
+
</td>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
<td class="description last">The code used to validate the email</td>
|
|
662
|
+
</tr>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
<tr class="deep-level-1">
|
|
667
|
+
|
|
668
|
+
<td class="name"><code>registerData.phoneValidationCode</code></td>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
<td class="type">
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
<code class="param-type">string</code>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
</td>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
<td class="default">
|
|
684
|
+
|
|
685
|
+
</td>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
<td class="description last">The code used to validate the phone</td>
|
|
689
|
+
</tr>
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
<tr class="deep-level-1">
|
|
694
|
+
|
|
695
|
+
<td class="name"><code>registerData.language</code></td>
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
<td class="type">
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
<code class="param-type">string</code>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
</td>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
<td class="default">
|
|
711
|
+
|
|
712
|
+
</td>
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
<td class="description last">The defaulf navigator language (i.e.: navigator.language)</td>
|
|
716
|
+
</tr>
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
<tr class="deep-level-1">
|
|
721
|
+
|
|
722
|
+
<td class="name"><code>registerData.timezone</code></td>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
<td class="type">
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
<code class="param-type">string</code>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
</td>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
<td class="default">
|
|
738
|
+
|
|
739
|
+
</td>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
<td class="description last">The defaulf navigator timezone (i.e.: Intl.DateTimeFormat().resolvedOptions().timeZone)</td>
|
|
743
|
+
</tr>
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
</tbody>
|
|
750
|
+
</table>
|
|
751
|
+
</div>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
<dl class="details">
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
<dt class="tag-author">Author:</dt>
|
|
777
|
+
<dd class="tag-author">
|
|
778
|
+
<ul>
|
|
779
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
780
|
+
</ul>
|
|
781
|
+
</dd>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
<p class="tag-source">
|
|
797
|
+
<a href="user_register.js.html" class="button">View Source</a>
|
|
798
|
+
<span>
|
|
799
|
+
<a href="user_register.js.html">user/register.js</a>, <a href="user_register.js.html#line174">line 174</a>
|
|
800
|
+
</span>
|
|
801
|
+
</p>
|
|
802
|
+
|
|
803
|
+
</dl>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
<div class='columns method-parameter'>
|
|
823
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
824
|
+
<div class="column is-10">
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
<div class="columns">
|
|
829
|
+
|
|
830
|
+
<div class='param-desc column is-7'>data</div>
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
<div class='column is-5 has-text-left'>
|
|
834
|
+
<label>Type: </label>
|
|
835
|
+
|
|
836
|
+
<code class="param-type">promise.<object></code>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
</div>
|
|
840
|
+
|
|
841
|
+
</div>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
<div class="columns">
|
|
847
|
+
|
|
848
|
+
<div class='param-desc column is-7'>data.success If the operation was successfully done (true|false)</div>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
<div class='column is-5 has-text-left'>
|
|
852
|
+
<label>Type: </label>
|
|
853
|
+
|
|
854
|
+
<code class="param-type">boolean</code>
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
</div>
|
|
858
|
+
|
|
859
|
+
</div>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
<div class="columns">
|
|
865
|
+
|
|
866
|
+
<div class='param-desc column is-7'>data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned</div>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
<div class='column is-5 has-text-left'>
|
|
870
|
+
<label>Type: </label>
|
|
871
|
+
|
|
872
|
+
<code class="param-type">boolean</code>
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
</div>
|
|
876
|
+
|
|
877
|
+
</div>
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
<div class="columns">
|
|
883
|
+
|
|
884
|
+
<div class='param-desc column is-7'>auth The full authentication data with session, if login is true.</div>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
<div class='column is-5 has-text-left'>
|
|
888
|
+
<label>Type: </label>
|
|
889
|
+
|
|
890
|
+
<code class="param-type">object</code>
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
</div>
|
|
894
|
+
|
|
895
|
+
</div>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
<div class="columns">
|
|
901
|
+
|
|
902
|
+
<div class='param-desc column is-7'>auth.redirectUrl The url to redirect.</div>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
<div class='column is-5 has-text-left'>
|
|
906
|
+
<label>Type: </label>
|
|
907
|
+
|
|
908
|
+
<code class="param-type">string</code>
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
</div>
|
|
912
|
+
|
|
913
|
+
</div>
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
</div>
|
|
917
|
+
</div>
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
<h5>Example</h5>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
926
|
+
const api = new API();
|
|
927
|
+
const params ={
|
|
928
|
+
"registerId": 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...',
|
|
929
|
+
"type": 'sign',
|
|
930
|
+
"login": false,
|
|
931
|
+
"emailInfo": {
|
|
932
|
+
"code": "5974",
|
|
933
|
+
"email": "cbtoto_1@mailinator.com"
|
|
934
|
+
},
|
|
935
|
+
"registerData": {
|
|
936
|
+
"name": "Augusto Totlo",
|
|
937
|
+
"registerEmail": "cbtoto_1@mailinator.com",
|
|
938
|
+
"phone": "",
|
|
939
|
+
"idcard": "",
|
|
940
|
+
"dob": "1978-01-12T03:00:00.000Z",
|
|
941
|
+
"registerPassword": "123456",
|
|
942
|
+
"emailValidationCode": "5974",
|
|
943
|
+
"phoneValidationCode": "",
|
|
944
|
+
"language": "en-US",
|
|
945
|
+
"timezone": "Europe/Dublin"
|
|
946
|
+
}
|
|
947
|
+
};
|
|
948
|
+
const retData = await api.user.register.execute(params);</code></pre>
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
</div>
|
|
953
|
+
|
|
954
|
+
<div class="member">
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
<h4 class="name" id="getOrgname">
|
|
959
|
+
<a class="href-link" href="#getOrgname">#</a>
|
|
960
|
+
|
|
961
|
+
<span class="code-name">
|
|
962
|
+
|
|
963
|
+
getOrgname<span class="signature">()</span><span class="type-signature"> → {string}</span>
|
|
964
|
+
|
|
965
|
+
</span>
|
|
966
|
+
</h4>
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
<h5>Parameters:</h5>
|
|
981
|
+
|
|
982
|
+
<div class="table-container">
|
|
983
|
+
<table class="params table">
|
|
984
|
+
<thead>
|
|
985
|
+
<tr>
|
|
986
|
+
|
|
987
|
+
<th>Name</th>
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
<th>Type</th>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
<th class="last">Description</th>
|
|
997
|
+
</tr>
|
|
998
|
+
</thead>
|
|
999
|
+
|
|
1000
|
+
<tbody>
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
<tr class="deep-level-0">
|
|
1005
|
+
|
|
1006
|
+
<td class="name"><code>params.registerId</code></td>
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
<td class="type">
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
<code class="param-type">object</code>
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
</td>
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
<td class="description last">The registerId that comes with the registration page context</td>
|
|
1023
|
+
</tr>
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
</tbody>
|
|
1028
|
+
</table>
|
|
1029
|
+
</div>
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
<dl class="details">
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
<dt class="tag-author">Author:</dt>
|
|
1055
|
+
<dd class="tag-author">
|
|
1056
|
+
<ul>
|
|
1057
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
1058
|
+
</ul>
|
|
1059
|
+
</dd>
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
<p class="tag-source">
|
|
1075
|
+
<a href="user_register.js.html" class="button">View Source</a>
|
|
1076
|
+
<span>
|
|
1077
|
+
<a href="user_register.js.html">user/register.js</a>, <a href="user_register.js.html#line65">line 65</a>
|
|
1078
|
+
</span>
|
|
1079
|
+
</p>
|
|
1080
|
+
|
|
1081
|
+
</dl>
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
<div class='columns method-parameter'>
|
|
1101
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1102
|
+
<div class="column is-10">
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
<div class="columns">
|
|
1107
|
+
|
|
1108
|
+
<div class='param-desc column is-7'>orgname The orgname of the organization in the registerId</div>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
<div class='column is-5 has-text-left'>
|
|
1112
|
+
<label>Type: </label>
|
|
1113
|
+
|
|
1114
|
+
<code class="param-type">string</code>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
</div>
|
|
1118
|
+
|
|
1119
|
+
</div>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
</div>
|
|
1123
|
+
</div>
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
<h5>Example</h5>
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1132
|
+
const api = new API();
|
|
1133
|
+
const params = {
|
|
1134
|
+
registerId: 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...'
|
|
1135
|
+
};
|
|
1136
|
+
const orgname = await api.user.register.getOrgname(params);</code></pre>
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
</div>
|
|
1141
|
+
|
|
1142
|
+
<div class="member">
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
<h4 class="name" id="validateEmail">
|
|
1147
|
+
<a class="href-link" href="#validateEmail">#</a>
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
<span class='tag'>async</span>
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
<span class="code-name">
|
|
1154
|
+
|
|
1155
|
+
validateEmail<span class="signature">(params)</span><span class="type-signature"> → {promise.<object>|boolean|boolean|string|object|string|string|string|object|string|string}</span>
|
|
1156
|
+
|
|
1157
|
+
</span>
|
|
1158
|
+
</h4>
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
<div class="description">
|
|
1164
|
+
Method to find task by id
|
|
1165
|
+
</div>
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
<h5>Parameters:</h5>
|
|
1177
|
+
|
|
1178
|
+
<div class="table-container">
|
|
1179
|
+
<table class="params table">
|
|
1180
|
+
<thead>
|
|
1181
|
+
<tr>
|
|
1182
|
+
|
|
1183
|
+
<th>Name</th>
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
<th>Type</th>
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
<th class="last">Description</th>
|
|
1193
|
+
</tr>
|
|
1194
|
+
</thead>
|
|
1195
|
+
|
|
1196
|
+
<tbody>
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
<tr class="deep-level-0">
|
|
1201
|
+
|
|
1202
|
+
<td class="name"><code>params</code></td>
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
<td class="type">
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
<code class="param-type">object</code>
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
</td>
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
<td class="description last">Params to get task</td>
|
|
1219
|
+
</tr>
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
<tr class="deep-level-1">
|
|
1225
|
+
|
|
1226
|
+
<td class="name"><code>registerId</code></td>
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
<td class="type">
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
<code class="param-type">string</code>
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
</td>
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
<td class="description last">The registerId that comes with the registration page context</td>
|
|
1243
|
+
</tr>
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
<tr class="deep-level-1">
|
|
1248
|
+
|
|
1249
|
+
<td class="name"><code>email</code></td>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
<td class="type">
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
<code class="param-type">object</code>
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
</td>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
<td class="description last">The email to validate</td>
|
|
1266
|
+
</tr>
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
</tbody>
|
|
1273
|
+
</table>
|
|
1274
|
+
</div>
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
<dl class="details">
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
<dt class="tag-author">Author:</dt>
|
|
1300
|
+
<dd class="tag-author">
|
|
1301
|
+
<ul>
|
|
1302
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
1303
|
+
</ul>
|
|
1304
|
+
</dd>
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
<p class="tag-source">
|
|
1320
|
+
<a href="user_register.js.html" class="button">View Source</a>
|
|
1321
|
+
<span>
|
|
1322
|
+
<a href="user_register.js.html">user/register.js</a>, <a href="user_register.js.html#line98">line 98</a>
|
|
1323
|
+
</span>
|
|
1324
|
+
</p>
|
|
1325
|
+
|
|
1326
|
+
</dl>
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
<div class='columns method-parameter'>
|
|
1346
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1347
|
+
<div class="column is-10">
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
<div class="columns">
|
|
1352
|
+
|
|
1353
|
+
<div class='param-desc column is-7'>data</div>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
<div class='column is-5 has-text-left'>
|
|
1357
|
+
<label>Type: </label>
|
|
1358
|
+
|
|
1359
|
+
<code class="param-type">promise.<object></code>
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
</div>
|
|
1363
|
+
|
|
1364
|
+
</div>
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
<div class="columns">
|
|
1370
|
+
|
|
1371
|
+
<div class='param-desc column is-7'>data.success If the operation was successfully done (true|false)</div>
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
<div class='column is-5 has-text-left'>
|
|
1375
|
+
<label>Type: </label>
|
|
1376
|
+
|
|
1377
|
+
<code class="param-type">boolean</code>
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
</div>
|
|
1381
|
+
|
|
1382
|
+
</div>
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
<div class="columns">
|
|
1388
|
+
|
|
1389
|
+
<div class='param-desc column is-7'>data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned</div>
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
<div class='column is-5 has-text-left'>
|
|
1393
|
+
<label>Type: </label>
|
|
1394
|
+
|
|
1395
|
+
<code class="param-type">boolean</code>
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
</div>
|
|
1399
|
+
|
|
1400
|
+
</div>
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
<div class="columns">
|
|
1406
|
+
|
|
1407
|
+
<div class='param-desc column is-7'>data.registrationEmailInfoRaw The fully cryptographed registration information</div>
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
<div class='column is-5 has-text-left'>
|
|
1411
|
+
<label>Type: </label>
|
|
1412
|
+
|
|
1413
|
+
<code class="param-type">string</code>
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
</div>
|
|
1417
|
+
|
|
1418
|
+
</div>
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
<div class="columns">
|
|
1424
|
+
|
|
1425
|
+
<div class='param-desc column is-7'>data.registrationEmailInfo The registration information</div>
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
<div class='column is-5 has-text-left'>
|
|
1429
|
+
<label>Type: </label>
|
|
1430
|
+
|
|
1431
|
+
<code class="param-type">object</code>
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
</div>
|
|
1435
|
+
|
|
1436
|
+
</div>
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
<div class="columns">
|
|
1442
|
+
|
|
1443
|
+
<div class='param-desc column is-7'>data.registrationEmailInfo.orgname The orgname</div>
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
<div class='column is-5 has-text-left'>
|
|
1447
|
+
<label>Type: </label>
|
|
1448
|
+
|
|
1449
|
+
<code class="param-type">string</code>
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
</div>
|
|
1453
|
+
|
|
1454
|
+
</div>
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
<div class="columns">
|
|
1460
|
+
|
|
1461
|
+
<div class='param-desc column is-7'>data.registrationEmailInfo.orgId The orgId of the organization</div>
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
<div class='column is-5 has-text-left'>
|
|
1465
|
+
<label>Type: </label>
|
|
1466
|
+
|
|
1467
|
+
<code class="param-type">string</code>
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
</div>
|
|
1471
|
+
|
|
1472
|
+
</div>
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
<div class="columns">
|
|
1478
|
+
|
|
1479
|
+
<div class='param-desc column is-7'>data.registrationEmailInfo.guid The unique id for the registration</div>
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
<div class='column is-5 has-text-left'>
|
|
1483
|
+
<label>Type: </label>
|
|
1484
|
+
|
|
1485
|
+
<code class="param-type">string</code>
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
</div>
|
|
1489
|
+
|
|
1490
|
+
</div>
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
<div class="columns">
|
|
1496
|
+
|
|
1497
|
+
<div class='param-desc column is-7'>data.registrationEmailInfo.emailValidation The email validation information</div>
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
<div class='column is-5 has-text-left'>
|
|
1501
|
+
<label>Type: </label>
|
|
1502
|
+
|
|
1503
|
+
<code class="param-type">object</code>
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
</div>
|
|
1507
|
+
|
|
1508
|
+
</div>
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
<div class="columns">
|
|
1514
|
+
|
|
1515
|
+
<div class='param-desc column is-7'>data.registrationEmailInfo.emailValidation.email The email that the code was sent to</div>
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
<div class='column is-5 has-text-left'>
|
|
1519
|
+
<label>Type: </label>
|
|
1520
|
+
|
|
1521
|
+
<code class="param-type">string</code>
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
</div>
|
|
1525
|
+
|
|
1526
|
+
</div>
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
<div class="columns">
|
|
1532
|
+
|
|
1533
|
+
<div class='param-desc column is-7'>data.registrationEmailInfo.emailValidation.code The 4 digit code to validate the email</div>
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
<div class='column is-5 has-text-left'>
|
|
1537
|
+
<label>Type: </label>
|
|
1538
|
+
|
|
1539
|
+
<code class="param-type">string</code>
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
</div>
|
|
1543
|
+
|
|
1544
|
+
</div>
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
</div>
|
|
1548
|
+
</div>
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
<h5>Example</h5>
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1557
|
+
const api = new API();
|
|
1558
|
+
const params = {
|
|
1559
|
+
registerId: 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...',
|
|
1560
|
+
email: 'myemail@company.com'
|
|
1561
|
+
};
|
|
1562
|
+
const retData = await api.user.register.validateEmail(params);</code></pre>
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
</div>
|
|
1567
|
+
|
|
1568
|
+
</div>
|
|
1569
|
+
</div>
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
</article>
|
|
1576
|
+
|
|
1577
|
+
</section>
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
</div>
|
|
1583
|
+
|
|
1584
|
+
<footer class="footer">
|
|
1585
|
+
<div class="content has-text-centered">
|
|
1586
|
+
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
|
|
1587
|
+
<p class="sidebar-created-by">
|
|
1588
|
+
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
|
|
1589
|
+
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
|
|
1590
|
+
</p>
|
|
1591
|
+
</div>
|
|
1592
|
+
</footer>
|
|
1593
|
+
|
|
1594
|
+
</div>
|
|
1595
|
+
<div id="side-nav" class="side-nav">
|
|
1596
|
+
</div>
|
|
1597
|
+
</div>
|
|
1598
|
+
<script src="scripts/app.min.js"></script>
|
|
1599
|
+
<script>PR.prettyPrint();</script>
|
|
1600
|
+
<script src="scripts/linenumber.js"> </script>
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
</body>
|
|
1604
|
+
</html>
|