@qikdev/sdk 1.0.2 → 1.0.5
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/README.md +1 -1
- package/dist/{docs/access.html → access.html} +353 -20
- package/dist/api.html +444 -0
- package/dist/{docs/auth.html → auth.html} +14 -14
- package/dist/cache.html +351 -0
- package/dist/{docs/content.html → content.html} +46 -21
- package/dist/{docs/files.html → files.html} +147 -6
- package/dist/{docs/filter.html → filter.html} +9 -9
- package/dist/geo.html +1029 -0
- package/dist/global.html +240 -0
- package/dist/index.html +96 -0
- package/dist/main.js +2 -3
- package/dist/module-QikStorage-CookieStorageAdapter.html +407 -0
- package/dist/module-QikStorage-LocalStorageAdapter.html +193 -0
- package/dist/module-QikStorage-StorageAdapter.html +977 -0
- package/dist/module-QikStorage.html +433 -0
- package/dist/qik.access.js.html +904 -0
- package/dist/qik.api.js.html +409 -0
- package/dist/{docs/qik.auth.js.html → qik.auth.js.html} +142 -104
- package/dist/qik.cache.js.html +125 -0
- package/dist/qik.content.js.html +967 -0
- package/dist/qik.core.js.html +322 -0
- package/dist/qik.files.js.html +249 -0
- package/dist/{docs/qik.filter.js.html → qik.filter.js.html} +3 -3
- package/dist/qik.geo.js.html +963 -0
- package/dist/{docs/qik.socket.js.html → qik.socket.js.html} +53 -12
- package/dist/qik.storage.js.html +375 -0
- package/dist/qik.system.js.html +117 -0
- package/dist/qik.utils.js.html +1548 -0
- package/dist/{docs/socket.html → socket.html} +7 -7
- package/dist/{docs/styles → styles}/jsdoc.css +2 -2
- package/dist/system.html +197 -0
- package/dist/utils.html +4422 -0
- package/package.json +2 -2
- package/src/api/qik.filter.js +1 -1
- package/src/api/qik.geo.js +1 -1
- package/src/api/qik.socket.js +18 -12
- package/src/api/qik.utils.js +6 -0
- package/src/version.js +1 -1
- package/dist/docs/api.html +0 -1356
- package/dist/docs/cache.html +0 -351
- package/dist/docs/index.html +0 -96
- package/dist/docs/qik.access.js.html +0 -790
- package/dist/docs/qik.api.js.html +0 -511
- package/dist/docs/qik.cache.js.html +0 -131
- package/dist/docs/qik.content.js.html +0 -918
- package/dist/docs/qik.core.js.html +0 -301
- package/dist/docs/qik.files.js.html +0 -219
- package/dist/docs/qik.system.js.html +0 -117
- package/dist/docs/qik.utils.js.html +0 -1467
- package/dist/docs/system.html +0 -197
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.eot +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.ttf +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff2 +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.eot +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.ttf +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff2 +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- /package/dist/{docs/scripts → scripts}/collapse.js +0 -0
- /package/dist/{docs/scripts → scripts}/linenumber.js +0 -0
- /package/dist/{docs/scripts → scripts}/nav.js +0 -0
- /package/dist/{docs/scripts → scripts}/polyfill.js +0 -0
- /package/dist/{docs/scripts → scripts}/prettify/Apache-License-2.0.txt +0 -0
- /package/dist/{docs/scripts → scripts}/prettify/lang-css.js +0 -0
- /package/dist/{docs/scripts → scripts}/prettify/prettify.js +0 -0
- /package/dist/{docs/scripts → scripts}/search.js +0 -0
- /package/dist/{docs/styles → styles}/prettify.css +0 -0
package/README.md
CHANGED
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
<nav >
|
|
29
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#.
|
|
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#.hasFeature">hasFeature</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#.isAssignee">isAssignee</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#.generateEndpointURL">generateEndpointURL</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#.duration">duration</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#.activeFilterComparators">activeFilterComparators</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="geo.html">geo</a><ul class='methods'><li data-type='method'><a href="geo.html#.distance">distance</a></li><li data-type='method'><a href="geo.html#.getDefaultCountry">getDefaultCountry</a></li><li data-type='method'><a href="geo.html#.getDefaultTimezone">getDefaultTimezone</a></li><li data-type='method'><a href="geo.html#.getPosition">getPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.watchPosition">watchPosition</a></li></ul></li><li><a href="module-QikStorage-CookieStorageAdapter.html">CookieStorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#getCookieOptions">getCookieOptions</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#isCookieMode">isCookieMode</a></li></ul></li><li><a href="module-QikStorage-LocalStorageAdapter.html">LocalStorageAdapter</a></li><li><a href="module-QikStorage-StorageAdapter.html">StorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#clearUser">clearUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getAccessToken">getAccessToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getRefreshToken">getRefreshToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getTokenExpiry">getTokenExpiry</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getUser">getUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#isAvailable">isAvailable</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#setUser">setUser</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><li><a href="utils.html">utils</a><ul class='methods'><li data-type='method'><a href="utils.html#.cleanValue">cleanValue</a></li><li data-type='method'><a href="utils.html#.comma">comma</a></li><li data-type='method'><a href="utils.html#.errorMessage">errorMessage</a></li><li data-type='method'><a href="utils.html#.exists">exists</a></li><li data-type='method'><a href="utils.html#.extractFromArray">extractFromArray</a></li><li data-type='method'><a href="utils.html#.formatCurrency">formatCurrency</a></li><li data-type='method'><a href="utils.html#.getTypeFromID">getTypeFromID</a></li><li data-type='method'><a href="utils.html#.guid">guid</a></li><li data-type='method'><a href="utils.html#.hash">hash</a></li><li data-type='method'><a href="utils.html#.id">id</a></li><li data-type='method'><a href="utils.html#.ids">ids</a></li><li data-type='method'><a href="utils.html#.isValidEmailAddress">isValidEmailAddress</a></li><li data-type='method'><a href="utils.html#.loadExternalScript">loadExternalScript</a></li><li data-type='method'><a href="utils.html#.loadExternalStyle">loadExternalStyle</a></li><li data-type='method'><a href="utils.html#.machineName">machineName</a></li><li data-type='method'><a href="utils.html#.mapParameters">mapParameters</a></li><li data-type='method'><a href="utils.html#.matchInArray">matchInArray</a></li><li data-type='method'><a href="utils.html#.parseBoolean">parseBoolean</a></li><li data-type='method'><a href="utils.html#.parseDate">parseDate</a></li><li data-type='method'><a href="utils.html#.parseEmail">parseEmail</a></li><li data-type='method'><a href="utils.html#.parseInt">parseInt</a></li><li data-type='method'><a href="utils.html#.parseNumber">parseNumber</a></li><li data-type='method'><a href="utils.html#.parseURL">parseURL</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-QikStorage.html">QikStorage</a><ul class='methods'><li data-type='method'><a href="module-QikStorage.html#.createStorageAdapter">createStorageAdapter</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#EventDispatcher">EventDispatcher</a></li></ul>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -88,7 +88,7 @@
|
|
|
88
88
|
|
|
89
89
|
<dt class="tag-source">Source:</dt>
|
|
90
90
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
91
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
91
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line191">line 191</a>
|
|
92
92
|
</li></ul></dd>
|
|
93
93
|
|
|
94
94
|
|
|
@@ -326,7 +326,7 @@ const canDeleteInScopes = sdk.access.actionableScopes(user, 'delete', 'profile')
|
|
|
326
326
|
|
|
327
327
|
<dt class="tag-source">Source:</dt>
|
|
328
328
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
329
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
329
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line329">line 329</a>
|
|
330
330
|
</li></ul></dd>
|
|
331
331
|
|
|
332
332
|
|
|
@@ -471,7 +471,7 @@ const permissions = sdk.access.allPermissions(user);
|
|
|
471
471
|
|
|
472
472
|
<dt class="tag-source">Source:</dt>
|
|
473
473
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
474
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
474
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line356">line 356</a>
|
|
475
475
|
</li></ul></dd>
|
|
476
476
|
|
|
477
477
|
|
|
@@ -642,7 +642,7 @@ the response will be an array</td>
|
|
|
642
642
|
|
|
643
643
|
<dt class="tag-source">Source:</dt>
|
|
644
644
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
645
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
645
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line135">line 135</a>
|
|
646
646
|
</li></ul></dd>
|
|
647
647
|
|
|
648
648
|
|
|
@@ -786,7 +786,7 @@ the response will be an array</td>
|
|
|
786
786
|
|
|
787
787
|
<dt class="tag-source">Source:</dt>
|
|
788
788
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
789
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
789
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line575">line 575</a>
|
|
790
790
|
</li></ul></dd>
|
|
791
791
|
|
|
792
792
|
|
|
@@ -1046,7 +1046,7 @@ const userCanCreateShortFilms = sdk.access.canCreate(user, 'shortFilm', 'video')
|
|
|
1046
1046
|
|
|
1047
1047
|
<dt class="tag-source">Source:</dt>
|
|
1048
1048
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1049
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
1049
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line747">line 747</a>
|
|
1050
1050
|
</li></ul></dd>
|
|
1051
1051
|
|
|
1052
1052
|
|
|
@@ -1292,7 +1292,7 @@ const filtered = largeArrayOfItems.filter(function(item) {
|
|
|
1292
1292
|
|
|
1293
1293
|
<dt class="tag-source">Source:</dt>
|
|
1294
1294
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1295
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
1295
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line710">line 710</a>
|
|
1296
1296
|
</li></ul></dd>
|
|
1297
1297
|
|
|
1298
1298
|
|
|
@@ -1538,7 +1538,7 @@ const filtered = largeArrayOfItems.filter(function(item) {
|
|
|
1538
1538
|
|
|
1539
1539
|
<dt class="tag-source">Source:</dt>
|
|
1540
1540
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1541
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
1541
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line817">line 817</a>
|
|
1542
1542
|
</li></ul></dd>
|
|
1543
1543
|
|
|
1544
1544
|
|
|
@@ -1784,7 +1784,7 @@ const filtered = largeArrayOfItems.filter(function(item) {
|
|
|
1784
1784
|
|
|
1785
1785
|
<dt class="tag-source">Source:</dt>
|
|
1786
1786
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1787
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
1787
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line384">line 384</a>
|
|
1788
1788
|
</li></ul></dd>
|
|
1789
1789
|
|
|
1790
1790
|
|
|
@@ -2022,7 +2022,7 @@ const canAccessCustomerUploadSection = sdk.access.canKnowOf(user, 'customerUplo
|
|
|
2022
2022
|
|
|
2023
2023
|
<dt class="tag-source">Source:</dt>
|
|
2024
2024
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2025
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
2025
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line615">line 615</a>
|
|
2026
2026
|
</li></ul></dd>
|
|
2027
2027
|
|
|
2028
2028
|
|
|
@@ -2268,7 +2268,7 @@ const filtered = largeArrayOfItems.filter(function(item) {
|
|
|
2268
2268
|
|
|
2269
2269
|
<dt class="tag-source">Source:</dt>
|
|
2270
2270
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2271
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
2271
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line782">line 782</a>
|
|
2272
2272
|
</li></ul></dd>
|
|
2273
2273
|
|
|
2274
2274
|
|
|
@@ -2514,7 +2514,7 @@ const filtered = largeArrayOfItems.filter(function(item) {
|
|
|
2514
2514
|
|
|
2515
2515
|
<dt class="tag-source">Source:</dt>
|
|
2516
2516
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2517
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
2517
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line663">line 663</a>
|
|
2518
2518
|
</li></ul></dd>
|
|
2519
2519
|
|
|
2520
2520
|
|
|
@@ -2760,7 +2760,7 @@ const filtered = largeArrayOfItems.filter(function(item) {
|
|
|
2760
2760
|
|
|
2761
2761
|
<dt class="tag-source">Source:</dt>
|
|
2762
2762
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2763
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
2763
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line418">line 418</a>
|
|
2764
2764
|
</li></ul></dd>
|
|
2765
2765
|
|
|
2766
2766
|
|
|
@@ -3054,7 +3054,7 @@ const filtered = largeArrayOfItems.filter(function(item) {
|
|
|
3054
3054
|
|
|
3055
3055
|
<dt class="tag-source">Source:</dt>
|
|
3056
3056
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3057
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
3057
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line69">line 69</a>
|
|
3058
3058
|
</li></ul></dd>
|
|
3059
3059
|
|
|
3060
3060
|
|
|
@@ -3195,7 +3195,7 @@ const filtered = largeArrayOfItems.filter(function(item) {
|
|
|
3195
3195
|
|
|
3196
3196
|
<dt class="tag-source">Source:</dt>
|
|
3197
3197
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3198
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
3198
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line551">line 551</a>
|
|
3199
3199
|
</li></ul></dd>
|
|
3200
3200
|
|
|
3201
3201
|
|
|
@@ -3344,6 +3344,171 @@ const isAllowedToCreateItems = sdk.access.has(user, 'video.create');</code></pre
|
|
|
3344
3344
|
|
|
3345
3345
|
|
|
3346
3346
|
|
|
3347
|
+
|
|
3348
|
+
|
|
3349
|
+
|
|
3350
|
+
|
|
3351
|
+
<h4 class="name" id=".hasFeature"><span class="type-signature">(static) </span>hasFeature<span class="signature">(user, feature)</span><span class="type-signature"></span></h4>
|
|
3352
|
+
|
|
3353
|
+
|
|
3354
|
+
|
|
3355
|
+
|
|
3356
|
+
|
|
3357
|
+
|
|
3358
|
+
<dl class="details">
|
|
3359
|
+
|
|
3360
|
+
|
|
3361
|
+
<dt class="tag-source">Source:</dt>
|
|
3362
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3363
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line39">line 39</a>
|
|
3364
|
+
</li></ul></dd>
|
|
3365
|
+
|
|
3366
|
+
|
|
3367
|
+
|
|
3368
|
+
|
|
3369
|
+
|
|
3370
|
+
|
|
3371
|
+
|
|
3372
|
+
|
|
3373
|
+
|
|
3374
|
+
|
|
3375
|
+
|
|
3376
|
+
|
|
3377
|
+
|
|
3378
|
+
|
|
3379
|
+
|
|
3380
|
+
|
|
3381
|
+
|
|
3382
|
+
|
|
3383
|
+
|
|
3384
|
+
|
|
3385
|
+
|
|
3386
|
+
|
|
3387
|
+
|
|
3388
|
+
|
|
3389
|
+
|
|
3390
|
+
|
|
3391
|
+
|
|
3392
|
+
|
|
3393
|
+
|
|
3394
|
+
|
|
3395
|
+
|
|
3396
|
+
</dl>
|
|
3397
|
+
|
|
3398
|
+
|
|
3399
|
+
|
|
3400
|
+
|
|
3401
|
+
|
|
3402
|
+
<div class="description usertext">
|
|
3403
|
+
Checks if a user has a specific feature enabled for their organisation
|
|
3404
|
+
</div>
|
|
3405
|
+
|
|
3406
|
+
|
|
3407
|
+
|
|
3408
|
+
|
|
3409
|
+
|
|
3410
|
+
|
|
3411
|
+
|
|
3412
|
+
|
|
3413
|
+
|
|
3414
|
+
<h5>Example</h5>
|
|
3415
|
+
|
|
3416
|
+
<pre class="prettyprint"><code>const user = sdk.auth.getCurrentUser();
|
|
3417
|
+
const formsFeatureIsEnabled = sdk.access.hasFeature(user, 'forms');</code></pre>
|
|
3418
|
+
|
|
3419
|
+
|
|
3420
|
+
|
|
3421
|
+
|
|
3422
|
+
<h5>Parameters:</h5>
|
|
3423
|
+
|
|
3424
|
+
|
|
3425
|
+
<table class="params">
|
|
3426
|
+
<thead>
|
|
3427
|
+
<tr>
|
|
3428
|
+
|
|
3429
|
+
<th>Name</th>
|
|
3430
|
+
|
|
3431
|
+
|
|
3432
|
+
<th>Type</th>
|
|
3433
|
+
|
|
3434
|
+
|
|
3435
|
+
|
|
3436
|
+
|
|
3437
|
+
|
|
3438
|
+
<th class="last">Description</th>
|
|
3439
|
+
</tr>
|
|
3440
|
+
</thead>
|
|
3441
|
+
|
|
3442
|
+
<tbody>
|
|
3443
|
+
|
|
3444
|
+
|
|
3445
|
+
<tr>
|
|
3446
|
+
|
|
3447
|
+
<td class="name"><code>user</code></td>
|
|
3448
|
+
|
|
3449
|
+
|
|
3450
|
+
<td class="type">
|
|
3451
|
+
|
|
3452
|
+
|
|
3453
|
+
<span class="param-type">Object</span>
|
|
3454
|
+
|
|
3455
|
+
|
|
3456
|
+
|
|
3457
|
+
</td>
|
|
3458
|
+
|
|
3459
|
+
|
|
3460
|
+
|
|
3461
|
+
|
|
3462
|
+
|
|
3463
|
+
<td class="description last">The user to check</td>
|
|
3464
|
+
</tr>
|
|
3465
|
+
|
|
3466
|
+
|
|
3467
|
+
|
|
3468
|
+
<tr>
|
|
3469
|
+
|
|
3470
|
+
<td class="name"><code>feature</code></td>
|
|
3471
|
+
|
|
3472
|
+
|
|
3473
|
+
<td class="type">
|
|
3474
|
+
|
|
3475
|
+
|
|
3476
|
+
<span class="param-type">String</span>
|
|
3477
|
+
|
|
3478
|
+
|
|
3479
|
+
|
|
3480
|
+
</td>
|
|
3481
|
+
|
|
3482
|
+
|
|
3483
|
+
|
|
3484
|
+
|
|
3485
|
+
|
|
3486
|
+
<td class="description last">The feature to check is enabled/disabled</td>
|
|
3487
|
+
</tr>
|
|
3488
|
+
|
|
3489
|
+
|
|
3490
|
+
</tbody>
|
|
3491
|
+
</table>
|
|
3492
|
+
|
|
3493
|
+
|
|
3494
|
+
|
|
3495
|
+
|
|
3496
|
+
|
|
3497
|
+
|
|
3498
|
+
|
|
3499
|
+
|
|
3500
|
+
|
|
3501
|
+
|
|
3502
|
+
|
|
3503
|
+
|
|
3504
|
+
|
|
3505
|
+
|
|
3506
|
+
|
|
3507
|
+
|
|
3508
|
+
|
|
3509
|
+
|
|
3510
|
+
|
|
3511
|
+
|
|
3347
3512
|
|
|
3348
3513
|
|
|
3349
3514
|
|
|
@@ -3360,7 +3525,7 @@ const isAllowedToCreateItems = sdk.access.has(user, 'video.create');</code></pre
|
|
|
3360
3525
|
|
|
3361
3526
|
<dt class="tag-source">Source:</dt>
|
|
3362
3527
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3363
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
3528
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line96">line 96</a>
|
|
3364
3529
|
</li></ul></dd>
|
|
3365
3530
|
|
|
3366
3531
|
|
|
@@ -3501,7 +3666,7 @@ const isAllowedToCreateItems = sdk.access.has(user, 'video.create');</code></pre
|
|
|
3501
3666
|
|
|
3502
3667
|
<dt class="tag-source">Source:</dt>
|
|
3503
3668
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3504
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
3669
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line56">line 56</a>
|
|
3505
3670
|
</li></ul></dd>
|
|
3506
3671
|
|
|
3507
3672
|
|
|
@@ -3626,6 +3791,174 @@ const isAllowedToCreateItems = sdk.access.has(user, 'video.create');</code></pre
|
|
|
3626
3791
|
|
|
3627
3792
|
|
|
3628
3793
|
|
|
3794
|
+
|
|
3795
|
+
|
|
3796
|
+
|
|
3797
|
+
|
|
3798
|
+
<h4 class="name" id=".isAssignee"><span class="type-signature">(static) </span>isAssignee<span class="signature">(user, item)</span><span class="type-signature"></span></h4>
|
|
3799
|
+
|
|
3800
|
+
|
|
3801
|
+
|
|
3802
|
+
|
|
3803
|
+
|
|
3804
|
+
|
|
3805
|
+
<dl class="details">
|
|
3806
|
+
|
|
3807
|
+
|
|
3808
|
+
<dt class="tag-source">Source:</dt>
|
|
3809
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3810
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line294">line 294</a>
|
|
3811
|
+
</li></ul></dd>
|
|
3812
|
+
|
|
3813
|
+
|
|
3814
|
+
|
|
3815
|
+
|
|
3816
|
+
|
|
3817
|
+
|
|
3818
|
+
|
|
3819
|
+
|
|
3820
|
+
|
|
3821
|
+
|
|
3822
|
+
|
|
3823
|
+
|
|
3824
|
+
|
|
3825
|
+
|
|
3826
|
+
|
|
3827
|
+
|
|
3828
|
+
|
|
3829
|
+
|
|
3830
|
+
|
|
3831
|
+
|
|
3832
|
+
|
|
3833
|
+
|
|
3834
|
+
|
|
3835
|
+
|
|
3836
|
+
|
|
3837
|
+
|
|
3838
|
+
|
|
3839
|
+
|
|
3840
|
+
|
|
3841
|
+
|
|
3842
|
+
|
|
3843
|
+
</dl>
|
|
3844
|
+
|
|
3845
|
+
|
|
3846
|
+
|
|
3847
|
+
|
|
3848
|
+
|
|
3849
|
+
<div class="description usertext">
|
|
3850
|
+
Return whether or not a user is an assignee of a specified item
|
|
3851
|
+
</div>
|
|
3852
|
+
|
|
3853
|
+
|
|
3854
|
+
|
|
3855
|
+
|
|
3856
|
+
|
|
3857
|
+
|
|
3858
|
+
|
|
3859
|
+
|
|
3860
|
+
|
|
3861
|
+
<h5>Example</h5>
|
|
3862
|
+
|
|
3863
|
+
<pre class="prettyprint"><code>const user = sdk.auth.getCurrentUser();
|
|
3864
|
+
const item = {title:'A workflow card', assignees:['61eca4746971e75c1fc670ca'], ...}
|
|
3865
|
+
|
|
3866
|
+
// Returns true if the user owns the item
|
|
3867
|
+
const isAssignee = sdk.access.isAssignee(user, item);</code></pre>
|
|
3868
|
+
|
|
3869
|
+
|
|
3870
|
+
|
|
3871
|
+
|
|
3872
|
+
<h5>Parameters:</h5>
|
|
3873
|
+
|
|
3874
|
+
|
|
3875
|
+
<table class="params">
|
|
3876
|
+
<thead>
|
|
3877
|
+
<tr>
|
|
3878
|
+
|
|
3879
|
+
<th>Name</th>
|
|
3880
|
+
|
|
3881
|
+
|
|
3882
|
+
<th>Type</th>
|
|
3883
|
+
|
|
3884
|
+
|
|
3885
|
+
|
|
3886
|
+
|
|
3887
|
+
|
|
3888
|
+
<th class="last">Description</th>
|
|
3889
|
+
</tr>
|
|
3890
|
+
</thead>
|
|
3891
|
+
|
|
3892
|
+
<tbody>
|
|
3893
|
+
|
|
3894
|
+
|
|
3895
|
+
<tr>
|
|
3896
|
+
|
|
3897
|
+
<td class="name"><code>user</code></td>
|
|
3898
|
+
|
|
3899
|
+
|
|
3900
|
+
<td class="type">
|
|
3901
|
+
|
|
3902
|
+
|
|
3903
|
+
<span class="param-type">Object</span>
|
|
3904
|
+
|
|
3905
|
+
|
|
3906
|
+
|
|
3907
|
+
</td>
|
|
3908
|
+
|
|
3909
|
+
|
|
3910
|
+
|
|
3911
|
+
|
|
3912
|
+
|
|
3913
|
+
<td class="description last">The user to check</td>
|
|
3914
|
+
</tr>
|
|
3915
|
+
|
|
3916
|
+
|
|
3917
|
+
|
|
3918
|
+
<tr>
|
|
3919
|
+
|
|
3920
|
+
<td class="name"><code>item</code></td>
|
|
3921
|
+
|
|
3922
|
+
|
|
3923
|
+
<td class="type">
|
|
3924
|
+
|
|
3925
|
+
|
|
3926
|
+
<span class="param-type">Object</span>
|
|
3927
|
+
|
|
3928
|
+
|
|
3929
|
+
|
|
3930
|
+
</td>
|
|
3931
|
+
|
|
3932
|
+
|
|
3933
|
+
|
|
3934
|
+
|
|
3935
|
+
|
|
3936
|
+
<td class="description last">The item</td>
|
|
3937
|
+
</tr>
|
|
3938
|
+
|
|
3939
|
+
|
|
3940
|
+
</tbody>
|
|
3941
|
+
</table>
|
|
3942
|
+
|
|
3943
|
+
|
|
3944
|
+
|
|
3945
|
+
|
|
3946
|
+
|
|
3947
|
+
|
|
3948
|
+
|
|
3949
|
+
|
|
3950
|
+
|
|
3951
|
+
|
|
3952
|
+
|
|
3953
|
+
|
|
3954
|
+
|
|
3955
|
+
|
|
3956
|
+
|
|
3957
|
+
|
|
3958
|
+
|
|
3959
|
+
|
|
3960
|
+
|
|
3961
|
+
|
|
3629
3962
|
|
|
3630
3963
|
|
|
3631
3964
|
|
|
@@ -3642,7 +3975,7 @@ const isAllowedToCreateItems = sdk.access.has(user, 'video.create');</code></pre
|
|
|
3642
3975
|
|
|
3643
3976
|
<dt class="tag-source">Source:</dt>
|
|
3644
3977
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3645
|
-
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#
|
|
3978
|
+
<a href="qik.access.js.html">qik.access.js</a>, <a href="qik.access.js.html#line243">line 243</a>
|
|
3646
3979
|
</li></ul></dd>
|
|
3647
3980
|
|
|
3648
3981
|
|
|
@@ -3813,7 +4146,7 @@ const isTheOwner = sdk.access.isOwner(user, item);</code></pre>
|
|
|
3813
4146
|
<br class="clear">
|
|
3814
4147
|
|
|
3815
4148
|
<footer>
|
|
3816
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
|
|
4149
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Jul 13 2026 18:47:22 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
3817
4150
|
</footer>
|
|
3818
4151
|
|
|
3819
4152
|
<script>prettyPrint();</script>
|