@qikdev/sdk 1.0.4 → 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/dist/api.html 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#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</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#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</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#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</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#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</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#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</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#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</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#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</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#.has">has</a></li><li data-type='method'><a href="access.html#.hasFeature">hasFeature</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#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</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#.isAssignee">isAssignee</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li></ul></li><li></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#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</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#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</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#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</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#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</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#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</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#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li></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#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li></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#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</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#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</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#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</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#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</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#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</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#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li></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#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.duration">duration</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#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</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><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li></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#.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#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</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#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</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><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li></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#.distance">distance</a></li><li data-type='method'><a href="geo.html#.getDefaultCountry">getDefaultCountry</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#.getDefaultTimezone">getDefaultTimezone</a></li><li data-type='method'><a href="geo.html#.getPosition">getPosition</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#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li></ul></li><li></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#getCookieOptions">getCookieOptions</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#isCookieMode">isCookieMode</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#isCookieMode">isCookieMode</a></li></ul></li><li></li><li><a href="module-QikStorage-LocalStorageAdapter.html">LocalStorageAdapter</a></li><li></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#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#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#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#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#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#isAvailable">isAvailable</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#setUser">setUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#setUser">setUser</a></li></ul></li><li></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#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</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#.connect">connect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</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#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li><li></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><li data-type='method'><a href="module-QikStorage.html#.createStorageAdapter">createStorageAdapter</a></li></ul></li><li></li></ul><h3>Global</h3><ul><li><a href="global.html#EventDispatcher">EventDispatcher</a></li></ul>
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">
@@ -104,76 +104,6 @@
104
104
 
105
105
 
106
106
 
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
- </dl>
119
-
120
-
121
-
122
-
123
-
124
- <div class="description usertext">
125
- Reference to the underlying axios package (https://www.npmjs.com/package/axios)
126
- Useful for creating new instances of axios if you want to create http requests to
127
- external APIs and not send tokens etc..
128
- </div>
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
- <h5>Example</h5>
137
-
138
- <pre class="prettyprint"><code>const newRequest = await sdk.api.axios.get('https://otherapi.com/content/61eca4746971e75c1fc670cf');</code></pre>
139
-
140
-
141
-
142
-
143
-
144
- <h4 class="name" id=".axios"><span class="type-signature">(static) </span>axios<span class="type-signature"></span></h4>
145
-
146
-
147
-
148
-
149
-
150
- <dl class="details">
151
-
152
-
153
- <dt class="tag-source">Source:</dt>
154
- <dd class="tag-source"><ul class="dummy"><li>
155
- <a href="qik.api.js.html">qik.api.js</a>, <a href="qik.api.js.html#line317">line 317</a>
156
- </li></ul></dd>
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
107
 
178
108
 
179
109
 
@@ -482,995 +412,6 @@ this function is helpful for generating authenticated links for the user to open
482
412
 
483
413
 
484
414
 
485
-
486
-
487
-
488
-
489
- <h4 class="name" id=".generateEndpointURL"><span class="type-signature">(static) </span>generateEndpointURL<span class="signature">(endpoint, params, options)</span><span class="type-signature"></span></h4>
490
-
491
-
492
-
493
-
494
-
495
-
496
- <dl class="details">
497
-
498
-
499
- <dt class="tag-source">Source:</dt>
500
- <dd class="tag-source"><ul class="dummy"><li>
501
- <a href="qik.api.js.html">qik.api.js</a>, <a href="qik.api.js.html#line144">line 144</a>
502
- </li></ul></dd>
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
- </dl>
535
-
536
-
537
-
538
-
539
-
540
- <div class="description usertext">
541
- Generate an Endpoint URL, complete with authentication.
542
- this function is helpful for generating authenticated links for the user to open in another window
543
- </div>
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
- <h5>Example</h5>
554
-
555
- <pre class="prettyprint"><code>const result = sdk.api.generateEndpointURL('/image/61eca4746971e75c1fc670cf', {
556
- w:100,
557
- h:50,
558
- }, {file:true})
559
-
560
- // Would return something similar to:
561
- // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&amp;h=50&amp;access_token=XXXX...</code></pre>
562
-
563
-
564
-
565
-
566
- <h5>Parameters:</h5>
567
-
568
-
569
- <table class="params">
570
- <thead>
571
- <tr>
572
-
573
- <th>Name</th>
574
-
575
-
576
- <th>Type</th>
577
-
578
-
579
-
580
-
581
-
582
- <th class="last">Description</th>
583
- </tr>
584
- </thead>
585
-
586
- <tbody>
587
-
588
-
589
- <tr>
590
-
591
- <td class="name"><code>endpoint</code></td>
592
-
593
-
594
- <td class="type">
595
-
596
-
597
- <span class="param-type">String</span>
598
-
599
-
600
-
601
- </td>
602
-
603
-
604
-
605
-
606
-
607
- <td class="description last">The endpoint to generate a url for</td>
608
- </tr>
609
-
610
-
611
-
612
- <tr>
613
-
614
- <td class="name"><code>params</code></td>
615
-
616
-
617
- <td class="type">
618
-
619
-
620
- <span class="param-type">Object</span>
621
-
622
-
623
-
624
- </td>
625
-
626
-
627
-
628
-
629
-
630
- <td class="description last">Extra parameters for the url</td>
631
- </tr>
632
-
633
-
634
-
635
- <tr>
636
-
637
- <td class="name"><code>options</code></td>
638
-
639
-
640
- <td class="type">
641
-
642
-
643
- <span class="param-type">Object</span>
644
-
645
-
646
-
647
- </td>
648
-
649
-
650
-
651
-
652
-
653
- <td class="description last">Additional request configuration
654
- <h6>Properties</h6>
655
-
656
-
657
- <table class="params">
658
- <thead>
659
- <tr>
660
-
661
- <th>Name</th>
662
-
663
-
664
- <th>Type</th>
665
-
666
-
667
-
668
-
669
-
670
- <th class="last">Description</th>
671
- </tr>
672
- </thead>
673
-
674
- <tbody>
675
-
676
-
677
- <tr>
678
-
679
- <td class="name"><code>withoutToken</code></td>
680
-
681
-
682
- <td class="type">
683
-
684
-
685
- <span class="param-type">Object</span>
686
-
687
-
688
-
689
- </td>
690
-
691
-
692
-
693
-
694
-
695
- <td class="description last">Don't append the current user's access token to the url</td>
696
- </tr>
697
-
698
-
699
-
700
- <tr>
701
-
702
- <td class="name"><code>file</code></td>
703
-
704
-
705
- <td class="type">
706
-
707
-
708
- <span class="param-type">Object</span>
709
-
710
-
711
-
712
- </td>
713
-
714
-
715
-
716
-
717
-
718
- <td class="description last">Whether the response for this request is expected to be a binary file type</td>
719
- </tr>
720
-
721
-
722
- </tbody>
723
- </table>
724
-
725
- </td>
726
- </tr>
727
-
728
-
729
- </tbody>
730
- </table>
731
-
732
-
733
-
734
-
735
-
736
-
737
-
738
-
739
-
740
-
741
-
742
-
743
-
744
-
745
-
746
-
747
-
748
-
749
-
750
-
751
-
752
-
753
-
754
-
755
-
756
- </article>
757
-
758
- </section>
759
-
760
-
761
-
762
-
763
-
764
-
765
-
766
- <section>
767
-
768
- <header>
769
-
770
- <h2>
771
- api
772
- </h2>
773
-
774
-
775
- </header>
776
-
777
- <article>
778
-
779
-
780
-
781
-
782
-
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
-
793
- <h3 class="subsection-title">Members</h3>
794
-
795
-
796
-
797
- <h4 class="name" id=".axios"><span class="type-signature">(static) </span>axios<span class="type-signature"></span></h4>
798
-
799
-
800
-
801
-
802
-
803
- <dl class="details">
804
-
805
-
806
- <dt class="tag-source">Source:</dt>
807
- <dd class="tag-source"><ul class="dummy"><li>
808
- <a href="qik.api.js.html">qik.api.js</a>, <a href="qik.api.js.html#line317">line 317</a>
809
- </li></ul></dd>
810
-
811
-
812
-
813
-
814
-
815
-
816
-
817
-
818
-
819
-
820
-
821
-
822
-
823
-
824
-
825
-
826
-
827
-
828
-
829
-
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
-
839
-
840
-
841
- </dl>
842
-
843
-
844
-
845
-
846
-
847
- <div class="description usertext">
848
- Reference to the underlying axios package (https://www.npmjs.com/package/axios)
849
- Useful for creating new instances of axios if you want to create http requests to
850
- external APIs and not send tokens etc..
851
- </div>
852
-
853
-
854
-
855
-
856
-
857
-
858
-
859
- <h5>Example</h5>
860
-
861
- <pre class="prettyprint"><code>const newRequest = await sdk.api.axios.get('https://otherapi.com/content/61eca4746971e75c1fc670cf');</code></pre>
862
-
863
-
864
-
865
-
866
-
867
- <h4 class="name" id=".axios"><span class="type-signature">(static) </span>axios<span class="type-signature"></span></h4>
868
-
869
-
870
-
871
-
872
-
873
- <dl class="details">
874
-
875
-
876
- <dt class="tag-source">Source:</dt>
877
- <dd class="tag-source"><ul class="dummy"><li>
878
- <a href="qik.api.js.html">qik.api.js</a>, <a href="qik.api.js.html#line317">line 317</a>
879
- </li></ul></dd>
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
-
888
-
889
-
890
-
891
-
892
-
893
-
894
-
895
-
896
-
897
-
898
-
899
-
900
-
901
-
902
-
903
-
904
-
905
-
906
-
907
-
908
-
909
-
910
-
911
- </dl>
912
-
913
-
914
-
915
-
916
-
917
- <div class="description usertext">
918
- Reference to the underlying axios package (https://www.npmjs.com/package/axios)
919
- Useful for creating new instances of axios if you want to create http requests to
920
- external APIs and not send tokens etc..
921
- </div>
922
-
923
-
924
-
925
-
926
-
927
-
928
-
929
- <h5>Example</h5>
930
-
931
- <pre class="prettyprint"><code>const newRequest = await sdk.api.axios.get('https://otherapi.com/content/61eca4746971e75c1fc670cf');</code></pre>
932
-
933
-
934
-
935
-
936
-
937
-
938
-
939
- <h3 class="subsection-title">Methods</h3>
940
-
941
-
942
-
943
-
944
-
945
-
946
- <h4 class="name" id=".generateEndpointURL"><span class="type-signature">(static) </span>generateEndpointURL<span class="signature">(endpoint, params, options)</span><span class="type-signature"></span></h4>
947
-
948
-
949
-
950
-
951
-
952
-
953
- <dl class="details">
954
-
955
-
956
- <dt class="tag-source">Source:</dt>
957
- <dd class="tag-source"><ul class="dummy"><li>
958
- <a href="qik.api.js.html">qik.api.js</a>, <a href="qik.api.js.html#line144">line 144</a>
959
- </li></ul></dd>
960
-
961
-
962
-
963
-
964
-
965
-
966
-
967
-
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
-
979
-
980
-
981
-
982
-
983
-
984
-
985
-
986
-
987
-
988
-
989
-
990
-
991
- </dl>
992
-
993
-
994
-
995
-
996
-
997
- <div class="description usertext">
998
- Generate an Endpoint URL, complete with authentication.
999
- this function is helpful for generating authenticated links for the user to open in another window
1000
- </div>
1001
-
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
-
1010
- <h5>Example</h5>
1011
-
1012
- <pre class="prettyprint"><code>const result = sdk.api.generateEndpointURL('/image/61eca4746971e75c1fc670cf', {
1013
- w:100,
1014
- h:50,
1015
- }, {file:true})
1016
-
1017
- // Would return something similar to:
1018
- // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&amp;h=50&amp;access_token=XXXX...</code></pre>
1019
-
1020
-
1021
-
1022
-
1023
- <h5>Parameters:</h5>
1024
-
1025
-
1026
- <table class="params">
1027
- <thead>
1028
- <tr>
1029
-
1030
- <th>Name</th>
1031
-
1032
-
1033
- <th>Type</th>
1034
-
1035
-
1036
-
1037
-
1038
-
1039
- <th class="last">Description</th>
1040
- </tr>
1041
- </thead>
1042
-
1043
- <tbody>
1044
-
1045
-
1046
- <tr>
1047
-
1048
- <td class="name"><code>endpoint</code></td>
1049
-
1050
-
1051
- <td class="type">
1052
-
1053
-
1054
- <span class="param-type">String</span>
1055
-
1056
-
1057
-
1058
- </td>
1059
-
1060
-
1061
-
1062
-
1063
-
1064
- <td class="description last">The endpoint to generate a url for</td>
1065
- </tr>
1066
-
1067
-
1068
-
1069
- <tr>
1070
-
1071
- <td class="name"><code>params</code></td>
1072
-
1073
-
1074
- <td class="type">
1075
-
1076
-
1077
- <span class="param-type">Object</span>
1078
-
1079
-
1080
-
1081
- </td>
1082
-
1083
-
1084
-
1085
-
1086
-
1087
- <td class="description last">Extra parameters for the url</td>
1088
- </tr>
1089
-
1090
-
1091
-
1092
- <tr>
1093
-
1094
- <td class="name"><code>options</code></td>
1095
-
1096
-
1097
- <td class="type">
1098
-
1099
-
1100
- <span class="param-type">Object</span>
1101
-
1102
-
1103
-
1104
- </td>
1105
-
1106
-
1107
-
1108
-
1109
-
1110
- <td class="description last">Additional request configuration
1111
- <h6>Properties</h6>
1112
-
1113
-
1114
- <table class="params">
1115
- <thead>
1116
- <tr>
1117
-
1118
- <th>Name</th>
1119
-
1120
-
1121
- <th>Type</th>
1122
-
1123
-
1124
-
1125
-
1126
-
1127
- <th class="last">Description</th>
1128
- </tr>
1129
- </thead>
1130
-
1131
- <tbody>
1132
-
1133
-
1134
- <tr>
1135
-
1136
- <td class="name"><code>withoutToken</code></td>
1137
-
1138
-
1139
- <td class="type">
1140
-
1141
-
1142
- <span class="param-type">Object</span>
1143
-
1144
-
1145
-
1146
- </td>
1147
-
1148
-
1149
-
1150
-
1151
-
1152
- <td class="description last">Don't append the current user's access token to the url</td>
1153
- </tr>
1154
-
1155
-
1156
-
1157
- <tr>
1158
-
1159
- <td class="name"><code>file</code></td>
1160
-
1161
-
1162
- <td class="type">
1163
-
1164
-
1165
- <span class="param-type">Object</span>
1166
-
1167
-
1168
-
1169
- </td>
1170
-
1171
-
1172
-
1173
-
1174
-
1175
- <td class="description last">Whether the response for this request is expected to be a binary file type</td>
1176
- </tr>
1177
-
1178
-
1179
- </tbody>
1180
- </table>
1181
-
1182
- </td>
1183
- </tr>
1184
-
1185
-
1186
- </tbody>
1187
- </table>
1188
-
1189
-
1190
-
1191
-
1192
-
1193
-
1194
-
1195
-
1196
-
1197
-
1198
-
1199
-
1200
-
1201
-
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
-
1210
-
1211
-
1212
- <h4 class="name" id=".generateEndpointURL"><span class="type-signature">(static) </span>generateEndpointURL<span class="signature">(endpoint, params, options)</span><span class="type-signature"></span></h4>
1213
-
1214
-
1215
-
1216
-
1217
-
1218
-
1219
- <dl class="details">
1220
-
1221
-
1222
- <dt class="tag-source">Source:</dt>
1223
- <dd class="tag-source"><ul class="dummy"><li>
1224
- <a href="qik.api.js.html">qik.api.js</a>, <a href="qik.api.js.html#line144">line 144</a>
1225
- </li></ul></dd>
1226
-
1227
-
1228
-
1229
-
1230
-
1231
-
1232
-
1233
-
1234
-
1235
-
1236
-
1237
-
1238
-
1239
-
1240
-
1241
-
1242
-
1243
-
1244
-
1245
-
1246
-
1247
-
1248
-
1249
-
1250
-
1251
-
1252
-
1253
-
1254
-
1255
-
1256
-
1257
- </dl>
1258
-
1259
-
1260
-
1261
-
1262
-
1263
- <div class="description usertext">
1264
- Generate an Endpoint URL, complete with authentication.
1265
- this function is helpful for generating authenticated links for the user to open in another window
1266
- </div>
1267
-
1268
-
1269
-
1270
-
1271
-
1272
-
1273
-
1274
-
1275
-
1276
- <h5>Example</h5>
1277
-
1278
- <pre class="prettyprint"><code>const result = sdk.api.generateEndpointURL('/image/61eca4746971e75c1fc670cf', {
1279
- w:100,
1280
- h:50,
1281
- }, {file:true})
1282
-
1283
- // Would return something similar to:
1284
- // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&amp;h=50&amp;access_token=XXXX...</code></pre>
1285
-
1286
-
1287
-
1288
-
1289
- <h5>Parameters:</h5>
1290
-
1291
-
1292
- <table class="params">
1293
- <thead>
1294
- <tr>
1295
-
1296
- <th>Name</th>
1297
-
1298
-
1299
- <th>Type</th>
1300
-
1301
-
1302
-
1303
-
1304
-
1305
- <th class="last">Description</th>
1306
- </tr>
1307
- </thead>
1308
-
1309
- <tbody>
1310
-
1311
-
1312
- <tr>
1313
-
1314
- <td class="name"><code>endpoint</code></td>
1315
-
1316
-
1317
- <td class="type">
1318
-
1319
-
1320
- <span class="param-type">String</span>
1321
-
1322
-
1323
-
1324
- </td>
1325
-
1326
-
1327
-
1328
-
1329
-
1330
- <td class="description last">The endpoint to generate a url for</td>
1331
- </tr>
1332
-
1333
-
1334
-
1335
- <tr>
1336
-
1337
- <td class="name"><code>params</code></td>
1338
-
1339
-
1340
- <td class="type">
1341
-
1342
-
1343
- <span class="param-type">Object</span>
1344
-
1345
-
1346
-
1347
- </td>
1348
-
1349
-
1350
-
1351
-
1352
-
1353
- <td class="description last">Extra parameters for the url</td>
1354
- </tr>
1355
-
1356
-
1357
-
1358
- <tr>
1359
-
1360
- <td class="name"><code>options</code></td>
1361
-
1362
-
1363
- <td class="type">
1364
-
1365
-
1366
- <span class="param-type">Object</span>
1367
-
1368
-
1369
-
1370
- </td>
1371
-
1372
-
1373
-
1374
-
1375
-
1376
- <td class="description last">Additional request configuration
1377
- <h6>Properties</h6>
1378
-
1379
-
1380
- <table class="params">
1381
- <thead>
1382
- <tr>
1383
-
1384
- <th>Name</th>
1385
-
1386
-
1387
- <th>Type</th>
1388
-
1389
-
1390
-
1391
-
1392
-
1393
- <th class="last">Description</th>
1394
- </tr>
1395
- </thead>
1396
-
1397
- <tbody>
1398
-
1399
-
1400
- <tr>
1401
-
1402
- <td class="name"><code>withoutToken</code></td>
1403
-
1404
-
1405
- <td class="type">
1406
-
1407
-
1408
- <span class="param-type">Object</span>
1409
-
1410
-
1411
-
1412
- </td>
1413
-
1414
-
1415
-
1416
-
1417
-
1418
- <td class="description last">Don't append the current user's access token to the url</td>
1419
- </tr>
1420
-
1421
-
1422
-
1423
- <tr>
1424
-
1425
- <td class="name"><code>file</code></td>
1426
-
1427
-
1428
- <td class="type">
1429
-
1430
-
1431
- <span class="param-type">Object</span>
1432
-
1433
-
1434
-
1435
- </td>
1436
-
1437
-
1438
-
1439
-
1440
-
1441
- <td class="description last">Whether the response for this request is expected to be a binary file type</td>
1442
- </tr>
1443
-
1444
-
1445
- </tbody>
1446
- </table>
1447
-
1448
- </td>
1449
- </tr>
1450
-
1451
-
1452
- </tbody>
1453
- </table>
1454
-
1455
-
1456
-
1457
-
1458
-
1459
-
1460
-
1461
-
1462
-
1463
-
1464
-
1465
-
1466
-
1467
-
1468
-
1469
-
1470
-
1471
-
1472
-
1473
-
1474
415
 
1475
416
 
1476
417
 
@@ -1490,7 +431,7 @@ this function is helpful for generating authenticated links for the user to open
1490
431
  <br class="clear">
1491
432
 
1492
433
  <footer>
1493
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Jun 01 2026 23:37:17 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
434
+ 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.
1494
435
  </footer>
1495
436
 
1496
437
  <script>prettyPrint();</script>