@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,893 @@
|
|
|
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> TaskAvailable</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>TaskAvailable</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>TaskAvailable<span class="signature">()</span><span class="type-signature"></span></h2>
|
|
89
|
+
|
|
90
|
+
<div class="class-description">Class for available tasks, 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="TaskAvailable">
|
|
110
|
+
<a class="href-link" href="#TaskAvailable">#</a>
|
|
111
|
+
|
|
112
|
+
<span class="code-name">
|
|
113
|
+
|
|
114
|
+
new TaskAvailable<span class="signature">()</span><span class="type-signature"></span>
|
|
115
|
+
|
|
116
|
+
</span>
|
|
117
|
+
</h4>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<dl class="details">
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<p class="tag-source">
|
|
168
|
+
<a href="user_task_available.js.html" class="button">View Source</a>
|
|
169
|
+
<span>
|
|
170
|
+
<a href="user_task_available.js.html">user/task_available.js</a>, <a href="user_task_available.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="claim">
|
|
228
|
+
<a class="href-link" href="#claim">#</a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class='tag'>async</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="code-name">
|
|
235
|
+
|
|
236
|
+
claim<span class="signature">(params, session)</span><span class="type-signature"> → {promise|boolean}</span>
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
</h4>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<div class="description">
|
|
245
|
+
Method for a user to claim an available task
|
|
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">Params to get task</td>
|
|
300
|
+
</tr>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<tr class="deep-level-1">
|
|
306
|
+
|
|
307
|
+
<td class="name"><code>taskId</code></td>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<td class="type">
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<code class="param-type">object</code>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
</td>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<td class="description last">the task id to claim</td>
|
|
324
|
+
</tr>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<tr class="deep-level-1">
|
|
329
|
+
|
|
330
|
+
<td class="name"><code>orgname</code></td>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<td class="type">
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<code class="param-type">object</code>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</td>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<td class="description last">Organization slug (short name of the orgnization)</td>
|
|
347
|
+
</tr>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
<tr class="deep-level-0">
|
|
356
|
+
|
|
357
|
+
<td class="name"><code>session</code></td>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
<td class="type">
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
<code class="param-type">string</code>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
</td>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
<td class="description last">Session, token JWT</td>
|
|
374
|
+
</tr>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</tbody>
|
|
379
|
+
</table>
|
|
380
|
+
</div>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
<dl class="details">
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
<dt class="tag-author">Author:</dt>
|
|
406
|
+
<dd class="tag-author">
|
|
407
|
+
<ul>
|
|
408
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
409
|
+
</ul>
|
|
410
|
+
</dd>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<p class="tag-source">
|
|
426
|
+
<a href="user_task_available.js.html" class="button">View Source</a>
|
|
427
|
+
<span>
|
|
428
|
+
<a href="user_task_available.js.html">user/task_available.js</a>, <a href="user_task_available.js.html#line115">line 115</a>
|
|
429
|
+
</span>
|
|
430
|
+
</p>
|
|
431
|
+
|
|
432
|
+
</dl>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
<div class='columns method-parameter'>
|
|
452
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
453
|
+
<div class="column is-10">
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<div class="columns">
|
|
458
|
+
|
|
459
|
+
<div class='param-desc column is-7'>returned data from the method call</div>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<div class='column is-5 has-text-left'>
|
|
463
|
+
<label>Type: </label>
|
|
464
|
+
|
|
465
|
+
<code class="param-type">promise</code>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
<div class="columns">
|
|
476
|
+
|
|
477
|
+
<div class='param-desc column is-7'>success true|false if the method was successful</div>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<div class='column is-5 has-text-left'>
|
|
481
|
+
<label>Type: </label>
|
|
482
|
+
|
|
483
|
+
<code class="param-type">boolean</code>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
</div>
|
|
487
|
+
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
</div>
|
|
492
|
+
</div>
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
<h5>Example</h5>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
501
|
+
const api = new API();
|
|
502
|
+
const params = {
|
|
503
|
+
taskId: '55e4a3bd6be6b45210833f67',
|
|
504
|
+
orgname: 'acme',
|
|
505
|
+
};
|
|
506
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
507
|
+
const success = await api.user.task.available.claim(params, session);</code></pre>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
</div>
|
|
512
|
+
|
|
513
|
+
<div class="member">
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
<h4 class="name" id="find">
|
|
518
|
+
<a class="href-link" href="#find">#</a>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<span class='tag'>async</span>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
<span class="code-name">
|
|
525
|
+
|
|
526
|
+
find<span class="signature">(params, session)</span><span class="type-signature"> → {promise|number|array.<object>|number|number}</span>
|
|
527
|
+
|
|
528
|
+
</span>
|
|
529
|
+
</h4>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<div class="description">
|
|
535
|
+
Method to find available tasks for a user
|
|
536
|
+
</div>
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<h5>Parameters:</h5>
|
|
548
|
+
|
|
549
|
+
<div class="table-container">
|
|
550
|
+
<table class="params table">
|
|
551
|
+
<thead>
|
|
552
|
+
<tr>
|
|
553
|
+
|
|
554
|
+
<th>Name</th>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
<th>Type</th>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<th class="last">Description</th>
|
|
564
|
+
</tr>
|
|
565
|
+
</thead>
|
|
566
|
+
|
|
567
|
+
<tbody>
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
<tr class="deep-level-0">
|
|
572
|
+
|
|
573
|
+
<td class="name"><code>params</code></td>
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
<td class="type">
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<code class="param-type">object</code>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
</td>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
<td class="description last">Params to get task</td>
|
|
590
|
+
</tr>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<tr class="deep-level-1">
|
|
596
|
+
|
|
597
|
+
<td class="name"><code>query</code></td>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
<td class="type">
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
<code class="param-type">object</code>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
</td>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
<td class="description last">Search available tasks query</td>
|
|
614
|
+
</tr>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
<tr class="deep-level-1">
|
|
619
|
+
|
|
620
|
+
<td class="name"><code>orgId</code></td>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
<td class="type">
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
<code class="param-type">object</code>
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
</td>
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
<td class="description last">Organization id (_id database)</td>
|
|
637
|
+
</tr>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
<tr class="deep-level-0">
|
|
646
|
+
|
|
647
|
+
<td class="name"><code>session</code></td>
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
<td class="type">
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
<code class="param-type">string</code>
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
</td>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
<td class="description last">Session, token JWT</td>
|
|
664
|
+
</tr>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
</tbody>
|
|
669
|
+
</table>
|
|
670
|
+
</div>
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
<dl class="details">
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
<dt class="tag-author">Author:</dt>
|
|
696
|
+
<dd class="tag-author">
|
|
697
|
+
<ul>
|
|
698
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
699
|
+
</ul>
|
|
700
|
+
</dd>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
<p class="tag-source">
|
|
716
|
+
<a href="user_task_available.js.html" class="button">View Source</a>
|
|
717
|
+
<span>
|
|
718
|
+
<a href="user_task_available.js.html">user/task_available.js</a>, <a href="user_task_available.js.html#line74">line 74</a>
|
|
719
|
+
</span>
|
|
720
|
+
</p>
|
|
721
|
+
|
|
722
|
+
</dl>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
<div class='columns method-parameter'>
|
|
742
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
743
|
+
<div class="column is-10">
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
<div class="columns">
|
|
748
|
+
|
|
749
|
+
<div class='param-desc column is-7'>returned data from the search</div>
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
<div class='column is-5 has-text-left'>
|
|
753
|
+
<label>Type: </label>
|
|
754
|
+
|
|
755
|
+
<code class="param-type">promise</code>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
</div>
|
|
759
|
+
|
|
760
|
+
</div>
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
<div class="columns">
|
|
766
|
+
|
|
767
|
+
<div class='param-desc column is-7'>count the count of items searched</div>
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
<div class='column is-5 has-text-left'>
|
|
771
|
+
<label>Type: </label>
|
|
772
|
+
|
|
773
|
+
<code class="param-type">number</code>
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
</div>
|
|
777
|
+
|
|
778
|
+
</div>
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
<div class="columns">
|
|
784
|
+
|
|
785
|
+
<div class='param-desc column is-7'>items the items returned from search</div>
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
<div class='column is-5 has-text-left'>
|
|
789
|
+
<label>Type: </label>
|
|
790
|
+
|
|
791
|
+
<code class="param-type">array.<object></code>
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
</div>
|
|
795
|
+
|
|
796
|
+
</div>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
<div class="columns">
|
|
802
|
+
|
|
803
|
+
<div class='param-desc column is-7'>page the page of the search (on pagination), zero indexed</div>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
<div class='column is-5 has-text-left'>
|
|
807
|
+
<label>Type: </label>
|
|
808
|
+
|
|
809
|
+
<code class="param-type">number</code>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
</div>
|
|
813
|
+
|
|
814
|
+
</div>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<div class="columns">
|
|
820
|
+
|
|
821
|
+
<div class='param-desc column is-7'>perPage how many items per page</div>
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
<div class='column is-5 has-text-left'>
|
|
825
|
+
<label>Type: </label>
|
|
826
|
+
|
|
827
|
+
<code class="param-type">number</code>
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
</div>
|
|
831
|
+
|
|
832
|
+
</div>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
</div>
|
|
836
|
+
</div>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
<h5>Example</h5>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
845
|
+
const api = new API();
|
|
846
|
+
const params = {
|
|
847
|
+
query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
|
|
848
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
849
|
+
};
|
|
850
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
851
|
+
const retSearch = await api.user.task.available.find(params, session);</code></pre>
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
</div>
|
|
856
|
+
|
|
857
|
+
</div>
|
|
858
|
+
</div>
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
</article>
|
|
865
|
+
|
|
866
|
+
</section>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
</div>
|
|
872
|
+
|
|
873
|
+
<footer class="footer">
|
|
874
|
+
<div class="content has-text-centered">
|
|
875
|
+
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
|
|
876
|
+
<p class="sidebar-created-by">
|
|
877
|
+
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
|
|
878
|
+
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
|
|
879
|
+
</p>
|
|
880
|
+
</div>
|
|
881
|
+
</footer>
|
|
882
|
+
|
|
883
|
+
</div>
|
|
884
|
+
<div id="side-nav" class="side-nav">
|
|
885
|
+
</div>
|
|
886
|
+
</div>
|
|
887
|
+
<script src="scripts/app.min.js"></script>
|
|
888
|
+
<script>PR.prettyPrint();</script>
|
|
889
|
+
<script src="scripts/linenumber.js"> </script>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
</body>
|
|
893
|
+
</html>
|