@qikdev/sdk 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/README.md +1 -1
  2. package/dist/access.html +16371 -0
  3. package/dist/api.html +1503 -0
  4. package/dist/auth.html +8455 -0
  5. package/dist/cache.html +1135 -0
  6. package/dist/content.html +10067 -0
  7. package/dist/files.html +3415 -0
  8. package/dist/filter.html +4973 -0
  9. package/dist/geo.html +3851 -0
  10. package/dist/global.html +328 -0
  11. package/dist/index.html +96 -0
  12. package/dist/main.js +2 -3
  13. package/dist/module-QikStorage-CookieStorageAdapter.html +1177 -0
  14. package/dist/module-QikStorage-LocalStorageAdapter.html +329 -0
  15. package/dist/module-QikStorage-StorageAdapter.html +3457 -0
  16. package/dist/module-QikStorage.html +1445 -0
  17. package/dist/qik.access.js.html +904 -0
  18. package/dist/qik.api.js.html +409 -0
  19. package/dist/{docs/qik.auth.js.html → qik.auth.js.html} +142 -104
  20. package/dist/qik.cache.js.html +125 -0
  21. package/dist/qik.content.js.html +967 -0
  22. package/dist/qik.core.js.html +322 -0
  23. package/dist/qik.files.js.html +249 -0
  24. package/dist/{docs/qik.filter.js.html → qik.filter.js.html} +2 -2
  25. package/dist/qik.geo.js.html +963 -0
  26. package/dist/qik.socket.js.html +451 -0
  27. package/dist/qik.storage.js.html +375 -0
  28. package/dist/qik.system.js.html +117 -0
  29. package/dist/qik.utils.js.html +1542 -0
  30. package/dist/socket.html +2975 -0
  31. package/dist/{docs/styles → styles}/jsdoc.css +2 -2
  32. package/dist/system.html +523 -0
  33. package/package.json +2 -2
  34. package/src/api/qik.socket.js +18 -12
  35. package/src/version.js +1 -1
  36. package/dist/docs/access.html +0 -3826
  37. package/dist/docs/api.html +0 -1356
  38. package/dist/docs/auth.html +0 -2180
  39. package/dist/docs/cache.html +0 -351
  40. package/dist/docs/content.html +0 -2560
  41. package/dist/docs/files.html +0 -779
  42. package/dist/docs/filter.html +0 -1355
  43. package/dist/docs/index.html +0 -96
  44. package/dist/docs/qik.access.js.html +0 -790
  45. package/dist/docs/qik.api.js.html +0 -511
  46. package/dist/docs/qik.cache.js.html +0 -131
  47. package/dist/docs/qik.content.js.html +0 -918
  48. package/dist/docs/qik.core.js.html +0 -301
  49. package/dist/docs/qik.files.js.html +0 -219
  50. package/dist/docs/qik.socket.js.html +0 -416
  51. package/dist/docs/qik.system.js.html +0 -117
  52. package/dist/docs/qik.utils.js.html +0 -1467
  53. package/dist/docs/socket.html +0 -810
  54. package/dist/docs/system.html +0 -197
  55. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.eot +0 -0
  56. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.ttf +0 -0
  57. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff +0 -0
  58. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff2 +0 -0
  59. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.eot +0 -0
  60. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.ttf +0 -0
  61. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff +0 -0
  62. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff2 +0 -0
  63. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  64. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  65. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  66. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  67. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  68. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  69. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  70. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  71. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  72. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  73. /package/dist/{docs/scripts → scripts}/collapse.js +0 -0
  74. /package/dist/{docs/scripts → scripts}/linenumber.js +0 -0
  75. /package/dist/{docs/scripts → scripts}/nav.js +0 -0
  76. /package/dist/{docs/scripts → scripts}/polyfill.js +0 -0
  77. /package/dist/{docs/scripts → scripts}/prettify/Apache-License-2.0.txt +0 -0
  78. /package/dist/{docs/scripts → scripts}/prettify/lang-css.js +0 -0
  79. /package/dist/{docs/scripts → scripts}/prettify/prettify.js +0 -0
  80. /package/dist/{docs/scripts → scripts}/search.js +0 -0
  81. /package/dist/{docs/styles → styles}/prettify.css +0 -0
@@ -1,1355 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>filter - Documentation</title>
7
-
8
-
9
- <script src="scripts/prettify/prettify.js"></script>
10
- <script src="scripts/prettify/lang-css.js"></script>
11
- <!--[if lt IE 9]>
12
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
- <![endif]-->
14
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
- <script src="scripts/nav.js" defer></script>
17
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
- </head>
19
- <body>
20
-
21
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
22
- <label for="nav-trigger" class="navicon-button x">
23
- <div class="navicon"></div>
24
- </label>
25
-
26
- <label for="nav-trigger" class="overlay"></label>
27
-
28
- <nav >
29
-
30
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.delete">delete</a></li><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li><li data-type='method'><a href="api.html#.get">get</a></li><li data-type='method'><a href="api.html#.patch">patch</a></li><li data-type='method'><a href="api.html#.post">post</a></li><li data-type='method'><a href="api.html#.put">put</a></li></ul></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li><a href="files.html">files</a><ul class='methods'><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li><a href="filter.html">filter</a><ul class='methods'><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li><a href="socket.html">socket</a><ul class='methods'><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li></ul>
31
- </nav>
32
-
33
- <div id="main">
34
-
35
- <h1 class="page-title">filter</h1>
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
- <section>
44
-
45
- <header>
46
-
47
- <h2>
48
- filter
49
- </h2>
50
-
51
- <div class="class-description usertext">Provides functions helpful for interacting with the filtering system</div>
52
-
53
-
54
- </header>
55
-
56
- <article>
57
-
58
- <div class="container-overview">
59
-
60
-
61
-
62
-
63
- <h2>Constructor</h2>
64
-
65
-
66
- <h4 class="name" id="filter"><span class="type-signature"></span>new filter<span class="signature">()</span><span class="type-signature"></span></h4>
67
-
68
-
69
-
70
-
71
-
72
-
73
- <dl class="details">
74
-
75
-
76
- <dt class="tag-source">Source:</dt>
77
- <dd class="tag-source"><ul class="dummy"><li>
78
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line1">line 1</a>
79
- </li></ul></dd>
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
- </dl>
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
- </div>
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
- <h3 class="subsection-title">Methods</h3>
164
-
165
-
166
-
167
-
168
-
169
-
170
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
171
-
172
-
173
-
174
-
175
-
176
-
177
- <dl class="details">
178
-
179
-
180
- <dt class="tag-source">Source:</dt>
181
- <dd class="tag-source"><ul class="dummy"><li>
182
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line301">line 301</a>
183
- </li></ul></dd>
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
- </dl>
216
-
217
-
218
-
219
-
220
-
221
- <div class="description usertext">
222
- Returns an array of all keys that are being actively filtered on
223
- </div>
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
- <h5>Example</h5>
234
-
235
- <pre class="prettyprint"><code>const filterConfiguration = {
236
- "operator": "and",
237
- "filters": [
238
- {
239
- "operator": "and",
240
- "filters": [
241
- {
242
- "key": "formData.person.firstName",
243
- "comparator": "startswith",
244
- "value": "c"
245
- },
246
- {
247
- "key": "invalid no comparator",
248
- "value": "e"
249
- }
250
- {
251
- "key": "formData.person.lastName",
252
- "comparator": "endswith",
253
- "value": "e"
254
- }
255
- ]
256
- }
257
- ]
258
- }
259
-
260
- const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
261
- // Returns ['formData.person.firstName', 'formData.person.lastName']</code></pre>
262
-
263
-
264
-
265
-
266
- <h5>Parameters:</h5>
267
-
268
-
269
- <table class="params">
270
- <thead>
271
- <tr>
272
-
273
- <th>Name</th>
274
-
275
-
276
- <th>Type</th>
277
-
278
-
279
-
280
-
281
-
282
- <th class="last">Description</th>
283
- </tr>
284
- </thead>
285
-
286
- <tbody>
287
-
288
-
289
- <tr>
290
-
291
- <td class="name"><code>filterConfiguration</code></td>
292
-
293
-
294
- <td class="type">
295
-
296
-
297
- <span class="param-type">Object</span>
298
-
299
-
300
-
301
- </td>
302
-
303
-
304
-
305
-
306
-
307
- <td class="description last">A filter configuration object</td>
308
- </tr>
309
-
310
-
311
- </tbody>
312
- </table>
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
338
-
339
-
340
-
341
-
342
-
343
-
344
- <dl class="details">
345
-
346
-
347
- <dt class="tag-source">Source:</dt>
348
- <dd class="tag-source"><ul class="dummy"><li>
349
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line361">line 361</a>
350
- </li></ul></dd>
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
- </dl>
383
-
384
-
385
-
386
-
387
-
388
- <div class="description usertext">
389
- Returns an array of all comparators that are being actively filtered
390
- </div>
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
- <h5>Example</h5>
401
-
402
- <pre class="prettyprint"><code>const filterConfiguration = {
403
- "operator": "and",
404
- "filters": [
405
- {
406
- "operator": "and",
407
- "filters": [
408
- {
409
- "key": "formData.person.firstName",
410
- "comparator": "startswith",
411
- "value": "c"
412
- },
413
- {
414
- "key": "invalid no comparator",
415
- "value": "e"
416
- }
417
- {
418
- "key": "formData.person.lastName",
419
- "comparator": "endswith",
420
- "value": "e"
421
- }
422
- ]
423
- }
424
- ]
425
- }
426
-
427
- const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
428
- // Returns ['startswith', 'endswith']</code></pre>
429
-
430
-
431
-
432
-
433
- <h5>Parameters:</h5>
434
-
435
-
436
- <table class="params">
437
- <thead>
438
- <tr>
439
-
440
- <th>Name</th>
441
-
442
-
443
- <th>Type</th>
444
-
445
-
446
-
447
-
448
-
449
- <th class="last">Description</th>
450
- </tr>
451
- </thead>
452
-
453
- <tbody>
454
-
455
-
456
- <tr>
457
-
458
- <td class="name"><code>filterConfiguration</code></td>
459
-
460
-
461
- <td class="type">
462
-
463
-
464
- <span class="param-type">Object</span>
465
-
466
-
467
-
468
- </td>
469
-
470
-
471
-
472
-
473
-
474
- <td class="description last">A filter configuration object</td>
475
- </tr>
476
-
477
-
478
- </tbody>
479
- </table>
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
-
504
- <h4 class="name" id=".activeFilterOperators"><span class="type-signature">(static) </span>activeFilterOperators<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
505
-
506
-
507
-
508
-
509
-
510
-
511
- <dl class="details">
512
-
513
-
514
- <dt class="tag-source">Source:</dt>
515
- <dd class="tag-source"><ul class="dummy"><li>
516
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line411">line 411</a>
517
- </li></ul></dd>
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
- </dl>
550
-
551
-
552
-
553
-
554
-
555
- <div class="description usertext">
556
- Returns an array of all comparators that are being actively filtered
557
- </div>
558
-
559
-
560
-
561
-
562
-
563
-
564
-
565
-
566
-
567
- <h5>Example</h5>
568
-
569
- <pre class="prettyprint"><code>const filterConfiguration = {
570
- "operator": "and",
571
- "filters": [
572
- {
573
- "operator": "nor",
574
- "filters": [
575
- {
576
- "key": "formData.person.firstName",
577
- "comparator": "startswith",
578
- "value": "c"
579
- },
580
- {
581
- "key": "invalid no comparator",
582
- "value": "e"
583
- }
584
- {
585
- "key": "formData.person.lastName",
586
- "comparator": "endswith",
587
- "value": "e"
588
- }
589
- ]
590
- }
591
- ]
592
- }
593
-
594
- const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfiguration);
595
- // Returns ['and', 'nor']</code></pre>
596
-
597
-
598
-
599
-
600
- <h5>Parameters:</h5>
601
-
602
-
603
- <table class="params">
604
- <thead>
605
- <tr>
606
-
607
- <th>Name</th>
608
-
609
-
610
- <th>Type</th>
611
-
612
-
613
-
614
-
615
-
616
- <th class="last">Description</th>
617
- </tr>
618
- </thead>
619
-
620
- <tbody>
621
-
622
-
623
- <tr>
624
-
625
- <td class="name"><code>filterConfiguration</code></td>
626
-
627
-
628
- <td class="type">
629
-
630
-
631
- <span class="param-type">Object</span>
632
-
633
-
634
-
635
- </td>
636
-
637
-
638
-
639
-
640
-
641
- <td class="description last">A filter configuration object</td>
642
- </tr>
643
-
644
-
645
- </tbody>
646
- </table>
647
-
648
-
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
-
659
-
660
-
661
-
662
-
663
-
664
-
665
-
666
-
667
-
668
-
669
-
670
-
671
- <h4 class="name" id=".activeFilters"><span class="type-signature">(static) </span>activeFilters<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
672
-
673
-
674
-
675
-
676
-
677
-
678
- <dl class="details">
679
-
680
-
681
- <dt class="tag-source">Source:</dt>
682
- <dd class="tag-source"><ul class="dummy"><li>
683
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line234">line 234</a>
684
- </li></ul></dd>
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
-
709
-
710
-
711
-
712
-
713
-
714
-
715
-
716
- </dl>
717
-
718
-
719
-
720
-
721
-
722
- <div class="description usertext">
723
- Returns an array of all active filters
724
- </div>
725
-
726
-
727
-
728
-
729
-
730
-
731
-
732
-
733
-
734
- <h5>Example</h5>
735
-
736
- <pre class="prettyprint"><code>const filterConfiguration = {
737
- "operator": "and",
738
- "filters": [
739
- {
740
- "operator": "and",
741
- "filters": [
742
- {
743
- "key": "formData.person.firstName",
744
- "comparator": "startswith",
745
- "value": "c"
746
- },
747
- {
748
- "key": "invalid no comparator",
749
- "value": "e"
750
- }
751
- {
752
- "key": "formData.person.lastName",
753
- "comparator": "endswith",
754
- "value": "e"
755
- }
756
- ]
757
- }
758
- ]
759
- }
760
-
761
- const activeFilters = sdk.filter.activeFilters(filterConfiguration);
762
-
763
- const returns = [
764
- {
765
- "key": "formData.person.firstName",
766
- "comparator": "startswith",
767
- "value": "c"
768
- },
769
- {
770
- "key": "formData.person.lastName",
771
- "comparator": "endswith",
772
- "value": "e"
773
- }]</code></pre>
774
-
775
-
776
-
777
-
778
- <h5>Parameters:</h5>
779
-
780
-
781
- <table class="params">
782
- <thead>
783
- <tr>
784
-
785
- <th>Name</th>
786
-
787
-
788
- <th>Type</th>
789
-
790
-
791
-
792
-
793
-
794
- <th class="last">Description</th>
795
- </tr>
796
- </thead>
797
-
798
- <tbody>
799
-
800
-
801
- <tr>
802
-
803
- <td class="name"><code>filterConfiguration</code></td>
804
-
805
-
806
- <td class="type">
807
-
808
-
809
- <span class="param-type">Object</span>
810
-
811
-
812
-
813
- </td>
814
-
815
-
816
-
817
-
818
-
819
- <td class="description last">A filter configuration object</td>
820
- </tr>
821
-
822
-
823
- </tbody>
824
- </table>
825
-
826
-
827
-
828
-
829
-
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
-
839
-
840
-
841
-
842
-
843
-
844
-
845
-
846
-
847
-
848
-
849
- <h4 class="name" id=".activeFilterValues"><span class="type-signature">(static) </span>activeFilterValues<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
850
-
851
-
852
-
853
-
854
-
855
-
856
- <dl class="details">
857
-
858
-
859
- <dt class="tag-source">Source:</dt>
860
- <dd class="tag-source"><ul class="dummy"><li>
861
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line461">line 461</a>
862
- </li></ul></dd>
863
-
864
-
865
-
866
-
867
-
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
-
888
-
889
-
890
-
891
-
892
-
893
-
894
- </dl>
895
-
896
-
897
-
898
-
899
-
900
- <div class="description usertext">
901
- Returns an array of all values that are being actively used by a filter
902
- </div>
903
-
904
-
905
-
906
-
907
-
908
-
909
-
910
-
911
-
912
- <h5>Example</h5>
913
-
914
- <pre class="prettyprint"><code>const filterConfiguration = {
915
- "operator": "and",
916
- "filters": [
917
- {
918
- "operator": "nor",
919
- "filters": [
920
- {
921
- "key": "formData.person.firstName",
922
- "comparator": "startswith",
923
- "value": "c"
924
- },
925
- {
926
- "key": "invalid no comparator",
927
- "value": "e"
928
- }
929
- {
930
- "key": "formData.person.lastName",
931
- "comparator": "endswith",
932
- "value": "a"
933
- }
934
- ]
935
- }
936
- ]
937
- }
938
-
939
- const activeFilterValues = sdk.filter.activeFilterValues(filterConfiguration);
940
- // Returns ['c', 'a']</code></pre>
941
-
942
-
943
-
944
-
945
- <h5>Parameters:</h5>
946
-
947
-
948
- <table class="params">
949
- <thead>
950
- <tr>
951
-
952
- <th>Name</th>
953
-
954
-
955
- <th>Type</th>
956
-
957
-
958
-
959
-
960
-
961
- <th class="last">Description</th>
962
- </tr>
963
- </thead>
964
-
965
- <tbody>
966
-
967
-
968
- <tr>
969
-
970
- <td class="name"><code>filterConfiguration</code></td>
971
-
972
-
973
- <td class="type">
974
-
975
-
976
- <span class="param-type">Object</span>
977
-
978
-
979
-
980
- </td>
981
-
982
-
983
-
984
-
985
-
986
- <td class="description last">A filter configuration object</td>
987
- </tr>
988
-
989
-
990
- </tbody>
991
- </table>
992
-
993
-
994
-
995
-
996
-
997
-
998
-
999
-
1000
-
1001
-
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
-
1010
-
1011
-
1012
-
1013
-
1014
-
1015
-
1016
- <h4 class="name" id=".filterChangeString"><span class="type-signature">(static) </span>filterChangeString<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
1017
-
1018
-
1019
-
1020
-
1021
-
1022
-
1023
- <dl class="details">
1024
-
1025
-
1026
- <dt class="tag-source">Source:</dt>
1027
- <dd class="tag-source"><ul class="dummy"><li>
1028
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line528">line 528</a>
1029
- </li></ul></dd>
1030
-
1031
-
1032
-
1033
-
1034
-
1035
-
1036
-
1037
-
1038
-
1039
-
1040
-
1041
-
1042
-
1043
-
1044
-
1045
-
1046
-
1047
-
1048
-
1049
-
1050
-
1051
-
1052
-
1053
-
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
- </dl>
1062
-
1063
-
1064
-
1065
-
1066
-
1067
- <div class="description usertext">
1068
- Returns an string representation of a filter configuration.
1069
- Often used to check if a user has changed the filter in any way, the string only takes into consideration active valid filters
1070
- </div>
1071
-
1072
-
1073
-
1074
-
1075
-
1076
-
1077
-
1078
-
1079
-
1080
- <h5>Example</h5>
1081
-
1082
- <pre class="prettyprint"><code>const filterConfiguration = {
1083
- "operator": "and",
1084
- "filters": [
1085
- {
1086
- "operator": "nor",
1087
- "filters": [
1088
- {
1089
- "key": "formData.person.firstName",
1090
- "comparator": "startswith",
1091
- "value": "c"
1092
- },
1093
- {
1094
- "key": "invalid no comparator",
1095
- "value": "e"
1096
- }
1097
- {
1098
- "key": "formData.person.lastName",
1099
- "comparator": "endswith",
1100
- "value": "a"
1101
- }
1102
- ]
1103
- }
1104
- ]
1105
- }
1106
-
1107
- // Watch this string for changes
1108
- const changeString = sdk.filter.filterChangeString(filterConfiguration); </code></pre>
1109
-
1110
-
1111
-
1112
-
1113
- <h5>Parameters:</h5>
1114
-
1115
-
1116
- <table class="params">
1117
- <thead>
1118
- <tr>
1119
-
1120
- <th>Name</th>
1121
-
1122
-
1123
- <th>Type</th>
1124
-
1125
-
1126
-
1127
-
1128
-
1129
- <th class="last">Description</th>
1130
- </tr>
1131
- </thead>
1132
-
1133
- <tbody>
1134
-
1135
-
1136
- <tr>
1137
-
1138
- <td class="name"><code>filterConfiguration</code></td>
1139
-
1140
-
1141
- <td class="type">
1142
-
1143
-
1144
- <span class="param-type">Object</span>
1145
-
1146
-
1147
-
1148
- </td>
1149
-
1150
-
1151
-
1152
-
1153
-
1154
- <td class="description last">A filter configuration object</td>
1155
- </tr>
1156
-
1157
-
1158
- </tbody>
1159
- </table>
1160
-
1161
-
1162
-
1163
-
1164
-
1165
-
1166
-
1167
-
1168
-
1169
-
1170
-
1171
-
1172
-
1173
-
1174
-
1175
-
1176
-
1177
-
1178
-
1179
-
1180
-
1181
-
1182
-
1183
-
1184
- <h4 class="name" id=".isValidFilter"><span class="type-signature">(static) </span>isValidFilter<span class="signature">(filter)</span><span class="type-signature"></span></h4>
1185
-
1186
-
1187
-
1188
-
1189
-
1190
-
1191
- <dl class="details">
1192
-
1193
-
1194
- <dt class="tag-source">Source:</dt>
1195
- <dd class="tag-source"><ul class="dummy"><li>
1196
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line67">line 67</a>
1197
- </li></ul></dd>
1198
-
1199
-
1200
-
1201
-
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
-
1210
-
1211
-
1212
-
1213
-
1214
-
1215
-
1216
-
1217
-
1218
-
1219
-
1220
-
1221
-
1222
-
1223
-
1224
-
1225
-
1226
-
1227
-
1228
-
1229
- </dl>
1230
-
1231
-
1232
-
1233
-
1234
-
1235
- <div class="description usertext">
1236
- Check if an object is a valid filter
1237
- </div>
1238
-
1239
-
1240
-
1241
-
1242
-
1243
-
1244
-
1245
-
1246
-
1247
- <h5>Example</h5>
1248
-
1249
- <pre class="prettyprint"><code>// Missing a 'key'
1250
- const invalidFilter = sdk.filter.isValidFilter({comparator:'in', values:['Red', 'Green', 'Blue']})
1251
- // returns false
1252
-
1253
- const validFilter = sdk.filter.isValidFilter({key:'favoriteColor', comparator:'in', values:['Red', 'Green', 'Blue']})
1254
- // returns true</code></pre>
1255
-
1256
-
1257
-
1258
-
1259
- <h5>Parameters:</h5>
1260
-
1261
-
1262
- <table class="params">
1263
- <thead>
1264
- <tr>
1265
-
1266
- <th>Name</th>
1267
-
1268
-
1269
- <th>Type</th>
1270
-
1271
-
1272
-
1273
-
1274
-
1275
- <th class="last">Description</th>
1276
- </tr>
1277
- </thead>
1278
-
1279
- <tbody>
1280
-
1281
-
1282
- <tr>
1283
-
1284
- <td class="name"><code>filter</code></td>
1285
-
1286
-
1287
- <td class="type">
1288
-
1289
-
1290
- <span class="param-type">Object</span>
1291
-
1292
-
1293
-
1294
- </td>
1295
-
1296
-
1297
-
1298
-
1299
-
1300
- <td class="description last">The filter block to check</td>
1301
- </tr>
1302
-
1303
-
1304
- </tbody>
1305
- </table>
1306
-
1307
-
1308
-
1309
-
1310
-
1311
-
1312
-
1313
-
1314
-
1315
-
1316
-
1317
-
1318
-
1319
-
1320
-
1321
-
1322
-
1323
-
1324
-
1325
-
1326
-
1327
-
1328
-
1329
-
1330
-
1331
- </article>
1332
-
1333
- </section>
1334
-
1335
-
1336
-
1337
-
1338
-
1339
-
1340
- </div>
1341
-
1342
- <br class="clear">
1343
-
1344
- <footer>
1345
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Thu Sep 28 2023 07:24:39 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1346
- </footer>
1347
-
1348
- <script>prettyPrint();</script>
1349
- <script src="scripts/polyfill.js"></script>
1350
- <script src="scripts/linenumber.js"></script>
1351
-
1352
-
1353
-
1354
- </body>
1355
- </html>