@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/socket.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">
@@ -224,1982 +224,7 @@ socketChannel.destroy();</code></pre>
224
224
 
225
225
 
226
226
 
227
- <h4 class="name" id=".channel"><span class="type-signature">(static) </span>channel<span class="signature">(key)</span><span class="type-signature"></span></h4>
228
-
229
-
230
-
231
-
232
-
233
-
234
- <dl class="details">
235
-
236
-
237
- <dt class="tag-source">Source:</dt>
238
- <dd class="tag-source"><ul class="dummy"><li>
239
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line70">line 70</a>
240
- </li></ul></dd>
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
- </dl>
273
-
274
-
275
-
276
-
277
-
278
- <div class="description usertext">
279
- Create an event dispatcher instance and subscribe to a new socket channel.
280
- This can then be used to receive socket events for this channel
281
- </div>
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
- <h5>Example</h5>
292
-
293
- <pre class="prettyprint"><code>const socketChannel = await sdk.socket.channel('awesome:notifications')
294
- socketChannel.addEventListener('message', function(message) {
295
- console.log('Received a new message from the socket')
296
- })
297
-
298
- // Disconnect from this channel and remove all listeners
299
- socketChannel.destroy();</code></pre>
300
-
301
-
302
-
303
-
304
- <h5>Parameters:</h5>
305
-
306
-
307
- <table class="params">
308
- <thead>
309
- <tr>
310
-
311
- <th>Name</th>
312
-
313
-
314
- <th>Type</th>
315
-
316
-
317
-
318
-
319
-
320
- <th class="last">Description</th>
321
- </tr>
322
- </thead>
323
-
324
- <tbody>
325
-
326
-
327
- <tr>
328
-
329
- <td class="name"><code>key</code></td>
330
-
331
-
332
- <td class="type">
333
-
334
-
335
- <span class="param-type">String</span>
336
-
337
-
338
-
339
- </td>
340
-
341
-
342
-
343
-
344
-
345
- <td class="description last">The key or name of the channel to subscribe to</td>
346
- </tr>
347
-
348
-
349
- </tbody>
350
- </table>
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
- <h4 class="name" id=".close"><span class="type-signature">(static) </span>close<span class="signature">()</span><span class="type-signature"></span></h4>
376
-
377
-
378
-
379
-
380
-
381
-
382
- <dl class="details">
383
-
384
-
385
- <dt class="tag-source">Source:</dt>
386
- <dd class="tag-source"><ul class="dummy"><li>
387
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line271">line 271</a>
388
- </li></ul></dd>
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
- </dl>
421
-
422
-
423
-
424
-
425
-
426
- <div class="description usertext">
427
- Close the connection to the socket service
428
- </div>
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
- <h5>Example</h5>
439
-
440
- <pre class="prettyprint"><code>const closed = await sdk.socket.close()</code></pre>
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
- <h4 class="name" id=".close"><span class="type-signature">(static) </span>close<span class="signature">()</span><span class="type-signature"></span></h4>
468
-
469
-
470
-
471
-
472
-
473
-
474
- <dl class="details">
475
-
476
-
477
- <dt class="tag-source">Source:</dt>
478
- <dd class="tag-source"><ul class="dummy"><li>
479
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line271">line 271</a>
480
- </li></ul></dd>
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
- </dl>
513
-
514
-
515
-
516
-
517
-
518
- <div class="description usertext">
519
- Close the connection to the socket service
520
- </div>
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
- <h5>Example</h5>
531
-
532
- <pre class="prettyprint"><code>const closed = await sdk.socket.close()</code></pre>
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
- <h4 class="name" id=".connect"><span class="type-signature">(static) </span>connect<span class="signature">()</span><span class="type-signature"></span></h4>
560
-
561
-
562
-
563
-
564
-
565
-
566
- <dl class="details">
567
-
568
-
569
- <dt class="tag-source">Source:</dt>
570
- <dd class="tag-source"><ul class="dummy"><li>
571
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line206">line 206</a>
572
- </li></ul></dd>
573
-
574
-
575
-
576
-
577
-
578
-
579
-
580
-
581
-
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
-
591
-
592
-
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
- </dl>
605
-
606
-
607
-
608
-
609
-
610
- <div class="description usertext">
611
- Connect to the socket service
612
- </div>
613
-
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
-
622
- <h5>Example</h5>
623
-
624
- <pre class="prettyprint"><code>const connected = await sdk.socket.connect()</code></pre>
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
651
- <h4 class="name" id=".connect"><span class="type-signature">(static) </span>connect<span class="signature">()</span><span class="type-signature"></span></h4>
652
-
653
-
654
-
655
-
656
-
657
-
658
- <dl class="details">
659
-
660
-
661
- <dt class="tag-source">Source:</dt>
662
- <dd class="tag-source"><ul class="dummy"><li>
663
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line206">line 206</a>
664
- </li></ul></dd>
665
-
666
-
667
-
668
-
669
-
670
-
671
-
672
-
673
-
674
-
675
-
676
-
677
-
678
-
679
-
680
-
681
-
682
-
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
- </dl>
697
-
698
-
699
-
700
-
701
-
702
- <div class="description usertext">
703
- Connect to the socket service
704
- </div>
705
-
706
-
707
-
708
-
709
-
710
-
711
-
712
-
713
-
714
- <h5>Example</h5>
715
-
716
- <pre class="prettyprint"><code>const connected = await sdk.socket.connect()</code></pre>
717
-
718
-
719
-
720
-
721
-
722
-
723
-
724
-
725
-
726
-
727
-
728
-
729
-
730
-
731
-
732
-
733
-
734
-
735
-
736
-
737
-
738
-
739
-
740
-
741
-
742
-
743
- <h4 class="name" id=".reconnect"><span class="type-signature">(static) </span>reconnect<span class="signature">()</span><span class="type-signature"></span></h4>
744
-
745
-
746
-
747
-
748
-
749
-
750
- <dl class="details">
751
-
752
-
753
- <dt class="tag-source">Source:</dt>
754
- <dd class="tag-source"><ul class="dummy"><li>
755
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line242">line 242</a>
756
- </li></ul></dd>
757
-
758
-
759
-
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
-
784
-
785
-
786
-
787
-
788
- </dl>
789
-
790
-
791
-
792
-
793
-
794
- <div class="description usertext">
795
- Reconnect to the socket service
796
- </div>
797
-
798
-
799
-
800
-
801
-
802
-
803
-
804
-
805
-
806
- <h5>Example</h5>
807
-
808
- <pre class="prettyprint"><code>const connected = await sdk.socket.reconnect()</code></pre>
809
-
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
- <h4 class="name" id=".reconnect"><span class="type-signature">(static) </span>reconnect<span class="signature">()</span><span class="type-signature"></span></h4>
836
-
837
-
838
-
839
-
840
-
841
-
842
- <dl class="details">
843
-
844
-
845
- <dt class="tag-source">Source:</dt>
846
- <dd class="tag-source"><ul class="dummy"><li>
847
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line242">line 242</a>
848
- </li></ul></dd>
849
-
850
-
851
-
852
-
853
-
854
-
855
-
856
-
857
-
858
-
859
-
860
-
861
-
862
-
863
-
864
-
865
-
866
-
867
-
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
- </dl>
881
-
882
-
883
-
884
-
885
-
886
- <div class="description usertext">
887
- Reconnect to the socket service
888
- </div>
889
-
890
-
891
-
892
-
893
-
894
-
895
-
896
-
897
-
898
- <h5>Example</h5>
899
-
900
- <pre class="prettyprint"><code>const connected = await sdk.socket.reconnect()</code></pre>
901
-
902
-
903
-
904
-
905
-
906
-
907
-
908
-
909
-
910
-
911
-
912
-
913
-
914
-
915
-
916
-
917
-
918
-
919
-
920
-
921
-
922
-
923
-
924
-
925
-
926
-
927
- <h4 class="name" id=".subscribe"><span class="type-signature">(static) </span>subscribe<span class="signature">(key)</span><span class="type-signature"></span></h4>
928
-
929
-
930
-
931
-
932
-
933
-
934
- <dl class="details">
935
-
936
-
937
- <dt class="tag-source">Source:</dt>
938
- <dd class="tag-source"><ul class="dummy"><li>
939
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line301">line 301</a>
940
- </li></ul></dd>
941
-
942
-
943
-
944
-
945
-
946
-
947
-
948
-
949
-
950
-
951
-
952
-
953
-
954
-
955
-
956
-
957
-
958
-
959
-
960
-
961
-
962
-
963
-
964
-
965
-
966
-
967
-
968
-
969
-
970
-
971
-
972
- </dl>
973
-
974
-
975
-
976
-
977
-
978
- <div class="description usertext">
979
- Subscribe to a socket channel
980
- </div>
981
-
982
-
983
-
984
-
985
-
986
-
987
-
988
-
989
-
990
- <h5>Example</h5>
991
-
992
- <pre class="prettyprint"><code>const subscribed = await sdk.socket.subscribe('some:cool:alert')</code></pre>
993
-
994
-
995
-
996
-
997
- <h5>Parameters:</h5>
998
-
999
-
1000
- <table class="params">
1001
- <thead>
1002
- <tr>
1003
-
1004
- <th>Name</th>
1005
-
1006
-
1007
- <th>Type</th>
1008
-
1009
-
1010
-
1011
-
1012
-
1013
- <th class="last">Description</th>
1014
- </tr>
1015
- </thead>
1016
-
1017
- <tbody>
1018
-
1019
-
1020
- <tr>
1021
-
1022
- <td class="name"><code>key</code></td>
1023
-
1024
-
1025
- <td class="type">
1026
-
1027
-
1028
- <span class="param-type">String</span>
1029
-
1030
-
1031
-
1032
- </td>
1033
-
1034
-
1035
-
1036
-
1037
-
1038
- <td class="description last">The name of the channel to subscribe to</td>
1039
- </tr>
1040
-
1041
-
1042
- </tbody>
1043
- </table>
1044
-
1045
-
1046
-
1047
-
1048
-
1049
-
1050
-
1051
-
1052
-
1053
-
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
-
1062
-
1063
-
1064
-
1065
-
1066
-
1067
-
1068
- <h4 class="name" id=".subscribe"><span class="type-signature">(static) </span>subscribe<span class="signature">(key)</span><span class="type-signature"></span></h4>
1069
-
1070
-
1071
-
1072
-
1073
-
1074
-
1075
- <dl class="details">
1076
-
1077
-
1078
- <dt class="tag-source">Source:</dt>
1079
- <dd class="tag-source"><ul class="dummy"><li>
1080
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line301">line 301</a>
1081
- </li></ul></dd>
1082
-
1083
-
1084
-
1085
-
1086
-
1087
-
1088
-
1089
-
1090
-
1091
-
1092
-
1093
-
1094
-
1095
-
1096
-
1097
-
1098
-
1099
-
1100
-
1101
-
1102
-
1103
-
1104
-
1105
-
1106
-
1107
-
1108
-
1109
-
1110
-
1111
-
1112
-
1113
- </dl>
1114
-
1115
-
1116
-
1117
-
1118
-
1119
- <div class="description usertext">
1120
- Subscribe to a socket channel
1121
- </div>
1122
-
1123
-
1124
-
1125
-
1126
-
1127
-
1128
-
1129
-
1130
-
1131
- <h5>Example</h5>
1132
-
1133
- <pre class="prettyprint"><code>const subscribed = await sdk.socket.subscribe('some:cool:alert')</code></pre>
1134
-
1135
-
1136
-
1137
-
1138
- <h5>Parameters:</h5>
1139
-
1140
-
1141
- <table class="params">
1142
- <thead>
1143
- <tr>
1144
-
1145
- <th>Name</th>
1146
-
1147
-
1148
- <th>Type</th>
1149
-
1150
-
1151
-
1152
-
1153
-
1154
- <th class="last">Description</th>
1155
- </tr>
1156
- </thead>
1157
-
1158
- <tbody>
1159
-
1160
-
1161
- <tr>
1162
-
1163
- <td class="name"><code>key</code></td>
1164
-
1165
-
1166
- <td class="type">
1167
-
1168
-
1169
- <span class="param-type">String</span>
1170
-
1171
-
1172
-
1173
- </td>
1174
-
1175
-
1176
-
1177
-
1178
-
1179
- <td class="description last">The name of the channel to subscribe to</td>
1180
- </tr>
1181
-
1182
-
1183
- </tbody>
1184
- </table>
1185
-
1186
-
1187
-
1188
-
1189
-
1190
-
1191
-
1192
-
1193
-
1194
-
1195
-
1196
-
1197
-
1198
-
1199
-
1200
-
1201
-
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
- <h4 class="name" id=".unsubscribe"><span class="type-signature">(static) </span>unsubscribe<span class="signature">(key)</span><span class="type-signature"></span></h4>
1210
-
1211
-
1212
-
1213
-
1214
-
1215
-
1216
- <dl class="details">
1217
-
1218
-
1219
- <dt class="tag-source">Source:</dt>
1220
- <dd class="tag-source"><ul class="dummy"><li>
1221
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line328">line 328</a>
1222
- </li></ul></dd>
1223
-
1224
-
1225
-
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
- </dl>
1255
-
1256
-
1257
-
1258
-
1259
-
1260
- <div class="description usertext">
1261
- Unsubscribe from a socket channel
1262
- </div>
1263
-
1264
-
1265
-
1266
-
1267
-
1268
-
1269
-
1270
-
1271
-
1272
- <h5>Example</h5>
1273
-
1274
- <pre class="prettyprint"><code>const unsubscribed = await sdk.socket.unsubscribe('some:cool:alert')</code></pre>
1275
-
1276
-
1277
-
1278
-
1279
- <h5>Parameters:</h5>
1280
-
1281
-
1282
- <table class="params">
1283
- <thead>
1284
- <tr>
1285
-
1286
- <th>Name</th>
1287
-
1288
-
1289
- <th>Type</th>
1290
-
1291
-
1292
-
1293
-
1294
-
1295
- <th class="last">Description</th>
1296
- </tr>
1297
- </thead>
1298
-
1299
- <tbody>
1300
-
1301
-
1302
- <tr>
1303
-
1304
- <td class="name"><code>key</code></td>
1305
-
1306
-
1307
- <td class="type">
1308
-
1309
-
1310
- <span class="param-type">String</span>
1311
-
1312
-
1313
-
1314
- </td>
1315
-
1316
-
1317
-
1318
-
1319
-
1320
- <td class="description last">The name of the channel to unsubscribe from</td>
1321
- </tr>
1322
-
1323
-
1324
- </tbody>
1325
- </table>
1326
-
1327
-
1328
-
1329
-
1330
-
1331
-
1332
-
1333
-
1334
-
1335
-
1336
-
1337
-
1338
-
1339
-
1340
-
1341
-
1342
-
1343
-
1344
-
1345
-
1346
-
1347
-
1348
-
1349
-
1350
- <h4 class="name" id=".unsubscribe"><span class="type-signature">(static) </span>unsubscribe<span class="signature">(key)</span><span class="type-signature"></span></h4>
1351
-
1352
-
1353
-
1354
-
1355
-
1356
-
1357
- <dl class="details">
1358
-
1359
-
1360
- <dt class="tag-source">Source:</dt>
1361
- <dd class="tag-source"><ul class="dummy"><li>
1362
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line328">line 328</a>
1363
- </li></ul></dd>
1364
-
1365
-
1366
-
1367
-
1368
-
1369
-
1370
-
1371
-
1372
-
1373
-
1374
-
1375
-
1376
-
1377
-
1378
-
1379
-
1380
-
1381
-
1382
-
1383
-
1384
-
1385
-
1386
-
1387
-
1388
-
1389
-
1390
-
1391
-
1392
-
1393
-
1394
-
1395
- </dl>
1396
-
1397
-
1398
-
1399
-
1400
-
1401
- <div class="description usertext">
1402
- Unsubscribe from a socket channel
1403
- </div>
1404
-
1405
-
1406
-
1407
-
1408
-
1409
-
1410
-
1411
-
1412
-
1413
- <h5>Example</h5>
1414
-
1415
- <pre class="prettyprint"><code>const unsubscribed = await sdk.socket.unsubscribe('some:cool:alert')</code></pre>
1416
-
1417
-
1418
-
1419
-
1420
- <h5>Parameters:</h5>
1421
-
1422
-
1423
- <table class="params">
1424
- <thead>
1425
- <tr>
1426
-
1427
- <th>Name</th>
1428
-
1429
-
1430
- <th>Type</th>
1431
-
1432
-
1433
-
1434
-
1435
-
1436
- <th class="last">Description</th>
1437
- </tr>
1438
- </thead>
1439
-
1440
- <tbody>
1441
-
1442
-
1443
- <tr>
1444
-
1445
- <td class="name"><code>key</code></td>
1446
-
1447
-
1448
- <td class="type">
1449
-
1450
-
1451
- <span class="param-type">String</span>
1452
-
1453
-
1454
-
1455
- </td>
1456
-
1457
-
1458
-
1459
-
1460
-
1461
- <td class="description last">The name of the channel to unsubscribe from</td>
1462
- </tr>
1463
-
1464
-
1465
- </tbody>
1466
- </table>
1467
-
1468
-
1469
-
1470
-
1471
-
1472
-
1473
-
1474
-
1475
-
1476
-
1477
-
1478
-
1479
-
1480
-
1481
-
1482
-
1483
-
1484
-
1485
-
1486
-
1487
-
1488
-
1489
-
1490
-
1491
-
1492
- </article>
1493
-
1494
- </section>
1495
-
1496
-
1497
-
1498
-
1499
-
1500
-
1501
-
1502
- <section>
1503
-
1504
- <header>
1505
-
1506
- <h2>
1507
- socket
1508
- </h2>
1509
-
1510
-
1511
- </header>
1512
-
1513
- <article>
1514
-
1515
-
1516
-
1517
-
1518
-
1519
-
1520
-
1521
-
1522
-
1523
-
1524
-
1525
-
1526
-
1527
-
1528
-
1529
-
1530
-
1531
- <h3 class="subsection-title">Methods</h3>
1532
-
1533
-
1534
-
1535
-
1536
-
1537
-
1538
- <h4 class="name" id=".channel"><span class="type-signature">(static) </span>channel<span class="signature">(key)</span><span class="type-signature"></span></h4>
1539
-
1540
-
1541
-
1542
-
1543
-
1544
-
1545
- <dl class="details">
1546
-
1547
-
1548
- <dt class="tag-source">Source:</dt>
1549
- <dd class="tag-source"><ul class="dummy"><li>
1550
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line70">line 70</a>
1551
- </li></ul></dd>
1552
-
1553
-
1554
-
1555
-
1556
-
1557
-
1558
-
1559
-
1560
-
1561
-
1562
-
1563
-
1564
-
1565
-
1566
-
1567
-
1568
-
1569
-
1570
-
1571
-
1572
-
1573
-
1574
-
1575
-
1576
-
1577
-
1578
-
1579
-
1580
-
1581
-
1582
-
1583
- </dl>
1584
-
1585
-
1586
-
1587
-
1588
-
1589
- <div class="description usertext">
1590
- Create an event dispatcher instance and subscribe to a new socket channel.
1591
- This can then be used to receive socket events for this channel
1592
- </div>
1593
-
1594
-
1595
-
1596
-
1597
-
1598
-
1599
-
1600
-
1601
-
1602
- <h5>Example</h5>
1603
-
1604
- <pre class="prettyprint"><code>const socketChannel = await sdk.socket.channel('awesome:notifications')
1605
- socketChannel.addEventListener('message', function(message) {
1606
- console.log('Received a new message from the socket')
1607
- })
1608
-
1609
- // Disconnect from this channel and remove all listeners
1610
- socketChannel.destroy();</code></pre>
1611
-
1612
-
1613
-
1614
-
1615
- <h5>Parameters:</h5>
1616
-
1617
-
1618
- <table class="params">
1619
- <thead>
1620
- <tr>
1621
-
1622
- <th>Name</th>
1623
-
1624
-
1625
- <th>Type</th>
1626
-
1627
-
1628
-
1629
-
1630
-
1631
- <th class="last">Description</th>
1632
- </tr>
1633
- </thead>
1634
-
1635
- <tbody>
1636
-
1637
-
1638
- <tr>
1639
-
1640
- <td class="name"><code>key</code></td>
1641
-
1642
-
1643
- <td class="type">
1644
-
1645
-
1646
- <span class="param-type">String</span>
1647
-
1648
-
1649
-
1650
- </td>
1651
-
1652
-
1653
-
1654
-
1655
-
1656
- <td class="description last">The key or name of the channel to subscribe to</td>
1657
- </tr>
1658
-
1659
-
1660
- </tbody>
1661
- </table>
1662
-
1663
-
1664
-
1665
-
1666
-
1667
-
1668
-
1669
-
1670
-
1671
-
1672
-
1673
-
1674
-
1675
-
1676
-
1677
-
1678
-
1679
-
1680
-
1681
-
1682
-
1683
-
1684
-
1685
-
1686
- <h4 class="name" id=".channel"><span class="type-signature">(static) </span>channel<span class="signature">(key)</span><span class="type-signature"></span></h4>
1687
-
1688
-
1689
-
1690
-
1691
-
1692
-
1693
- <dl class="details">
1694
-
1695
-
1696
- <dt class="tag-source">Source:</dt>
1697
- <dd class="tag-source"><ul class="dummy"><li>
1698
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line70">line 70</a>
1699
- </li></ul></dd>
1700
-
1701
-
1702
-
1703
-
1704
-
1705
-
1706
-
1707
-
1708
-
1709
-
1710
-
1711
-
1712
-
1713
-
1714
-
1715
-
1716
-
1717
-
1718
-
1719
-
1720
-
1721
-
1722
-
1723
-
1724
-
1725
-
1726
-
1727
-
1728
-
1729
-
1730
-
1731
- </dl>
1732
-
1733
-
1734
-
1735
-
1736
-
1737
- <div class="description usertext">
1738
- Create an event dispatcher instance and subscribe to a new socket channel.
1739
- This can then be used to receive socket events for this channel
1740
- </div>
1741
-
1742
-
1743
-
1744
-
1745
-
1746
-
1747
-
1748
-
1749
-
1750
- <h5>Example</h5>
1751
-
1752
- <pre class="prettyprint"><code>const socketChannel = await sdk.socket.channel('awesome:notifications')
1753
- socketChannel.addEventListener('message', function(message) {
1754
- console.log('Received a new message from the socket')
1755
- })
1756
-
1757
- // Disconnect from this channel and remove all listeners
1758
- socketChannel.destroy();</code></pre>
1759
-
1760
-
1761
-
1762
-
1763
- <h5>Parameters:</h5>
1764
-
1765
-
1766
- <table class="params">
1767
- <thead>
1768
- <tr>
1769
-
1770
- <th>Name</th>
1771
-
1772
-
1773
- <th>Type</th>
1774
-
1775
-
1776
-
1777
-
1778
-
1779
- <th class="last">Description</th>
1780
- </tr>
1781
- </thead>
1782
-
1783
- <tbody>
1784
-
1785
-
1786
- <tr>
1787
-
1788
- <td class="name"><code>key</code></td>
1789
-
1790
-
1791
- <td class="type">
1792
-
1793
-
1794
- <span class="param-type">String</span>
1795
-
1796
-
1797
-
1798
- </td>
1799
-
1800
-
1801
-
1802
-
1803
-
1804
- <td class="description last">The key or name of the channel to subscribe to</td>
1805
- </tr>
1806
-
1807
-
1808
- </tbody>
1809
- </table>
1810
-
1811
-
1812
-
1813
-
1814
-
1815
-
1816
-
1817
-
1818
-
1819
-
1820
-
1821
-
1822
-
1823
-
1824
-
1825
-
1826
-
1827
-
1828
-
1829
-
1830
-
1831
-
1832
-
1833
-
1834
- <h4 class="name" id=".close"><span class="type-signature">(static) </span>close<span class="signature">()</span><span class="type-signature"></span></h4>
1835
-
1836
-
1837
-
1838
-
1839
-
1840
-
1841
- <dl class="details">
1842
-
1843
-
1844
- <dt class="tag-source">Source:</dt>
1845
- <dd class="tag-source"><ul class="dummy"><li>
1846
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line271">line 271</a>
1847
- </li></ul></dd>
1848
-
1849
-
1850
-
1851
-
1852
-
1853
-
1854
-
1855
-
1856
-
1857
-
1858
-
1859
-
1860
-
1861
-
1862
-
1863
-
1864
-
1865
-
1866
-
1867
-
1868
-
1869
-
1870
-
1871
-
1872
-
1873
-
1874
-
1875
-
1876
-
1877
-
1878
-
1879
- </dl>
1880
-
1881
-
1882
-
1883
-
1884
-
1885
- <div class="description usertext">
1886
- Close the connection to the socket service
1887
- </div>
1888
-
1889
-
1890
-
1891
-
1892
-
1893
-
1894
-
1895
-
1896
-
1897
- <h5>Example</h5>
1898
-
1899
- <pre class="prettyprint"><code>const closed = await sdk.socket.close()</code></pre>
1900
-
1901
-
1902
-
1903
-
1904
-
1905
-
1906
-
1907
-
1908
-
1909
-
1910
-
1911
-
1912
-
1913
-
1914
-
1915
-
1916
-
1917
-
1918
-
1919
-
1920
-
1921
-
1922
-
1923
-
1924
-
1925
-
1926
- <h4 class="name" id=".close"><span class="type-signature">(static) </span>close<span class="signature">()</span><span class="type-signature"></span></h4>
1927
-
1928
-
1929
-
1930
-
1931
-
1932
-
1933
- <dl class="details">
1934
-
1935
-
1936
- <dt class="tag-source">Source:</dt>
1937
- <dd class="tag-source"><ul class="dummy"><li>
1938
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line271">line 271</a>
1939
- </li></ul></dd>
1940
-
1941
-
1942
-
1943
-
1944
-
1945
-
1946
-
1947
-
1948
-
1949
-
1950
-
1951
-
1952
-
1953
-
1954
-
1955
-
1956
-
1957
-
1958
-
1959
-
1960
-
1961
-
1962
-
1963
-
1964
-
1965
-
1966
-
1967
-
1968
-
1969
-
1970
-
1971
- </dl>
1972
-
1973
-
1974
-
1975
-
1976
-
1977
- <div class="description usertext">
1978
- Close the connection to the socket service
1979
- </div>
1980
-
1981
-
1982
-
1983
-
1984
-
1985
-
1986
-
1987
-
1988
-
1989
- <h5>Example</h5>
1990
-
1991
- <pre class="prettyprint"><code>const closed = await sdk.socket.close()</code></pre>
1992
-
1993
-
1994
-
1995
-
1996
-
1997
-
1998
-
1999
-
2000
-
2001
-
2002
-
2003
-
2004
-
2005
-
2006
-
2007
-
2008
-
2009
-
2010
-
2011
-
2012
-
2013
-
2014
-
2015
-
2016
-
2017
-
2018
- <h4 class="name" id=".connect"><span class="type-signature">(static) </span>connect<span class="signature">()</span><span class="type-signature"></span></h4>
2019
-
2020
-
2021
-
2022
-
2023
-
2024
-
2025
- <dl class="details">
2026
-
2027
-
2028
- <dt class="tag-source">Source:</dt>
2029
- <dd class="tag-source"><ul class="dummy"><li>
2030
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line206">line 206</a>
2031
- </li></ul></dd>
2032
-
2033
-
2034
-
2035
-
2036
-
2037
-
2038
-
2039
-
2040
-
2041
-
2042
-
2043
-
2044
-
2045
-
2046
-
2047
-
2048
-
2049
-
2050
-
2051
-
2052
-
2053
-
2054
-
2055
-
2056
-
2057
-
2058
-
2059
-
2060
-
2061
-
2062
-
2063
- </dl>
2064
-
2065
-
2066
-
2067
-
2068
-
2069
- <div class="description usertext">
2070
- Connect to the socket service
2071
- </div>
2072
-
2073
-
2074
-
2075
-
2076
-
2077
-
2078
-
2079
-
2080
-
2081
- <h5>Example</h5>
2082
-
2083
- <pre class="prettyprint"><code>const connected = await sdk.socket.connect()</code></pre>
2084
-
2085
-
2086
-
2087
-
2088
-
2089
-
2090
-
2091
-
2092
-
2093
-
2094
-
2095
-
2096
-
2097
-
2098
-
2099
-
2100
-
2101
-
2102
-
2103
-
2104
-
2105
-
2106
-
2107
-
2108
-
2109
-
2110
- <h4 class="name" id=".connect"><span class="type-signature">(static) </span>connect<span class="signature">()</span><span class="type-signature"></span></h4>
2111
-
2112
-
2113
-
2114
-
2115
-
2116
-
2117
- <dl class="details">
2118
-
2119
-
2120
- <dt class="tag-source">Source:</dt>
2121
- <dd class="tag-source"><ul class="dummy"><li>
2122
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line206">line 206</a>
2123
- </li></ul></dd>
2124
-
2125
-
2126
-
2127
-
2128
-
2129
-
2130
-
2131
-
2132
-
2133
-
2134
-
2135
-
2136
-
2137
-
2138
-
2139
-
2140
-
2141
-
2142
-
2143
-
2144
-
2145
-
2146
-
2147
-
2148
-
2149
-
2150
-
2151
-
2152
-
2153
-
2154
-
2155
- </dl>
2156
-
2157
-
2158
-
2159
-
2160
-
2161
- <div class="description usertext">
2162
- Connect to the socket service
2163
- </div>
2164
-
2165
-
2166
-
2167
-
2168
-
2169
-
2170
-
2171
-
2172
-
2173
- <h5>Example</h5>
2174
-
2175
- <pre class="prettyprint"><code>const connected = await sdk.socket.connect()</code></pre>
2176
-
2177
-
2178
-
2179
-
2180
-
2181
-
2182
-
2183
-
2184
-
2185
-
2186
-
2187
-
2188
-
2189
-
2190
-
2191
-
2192
-
2193
-
2194
-
2195
-
2196
-
2197
-
2198
-
2199
-
2200
-
2201
-
2202
- <h4 class="name" id=".reconnect"><span class="type-signature">(static) </span>reconnect<span class="signature">()</span><span class="type-signature"></span></h4>
227
+ <h4 class="name" id=".close"><span class="type-signature">(static) </span>close<span class="signature">()</span><span class="type-signature"></span></h4>
2203
228
 
2204
229
 
2205
230
 
@@ -2211,7 +236,7 @@ socketChannel.destroy();</code></pre>
2211
236
 
2212
237
  <dt class="tag-source">Source:</dt>
2213
238
  <dd class="tag-source"><ul class="dummy"><li>
2214
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line242">line 242</a>
239
+ <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line277">line 277</a>
2215
240
  </li></ul></dd>
2216
241
 
2217
242
 
@@ -2251,7 +276,7 @@ socketChannel.destroy();</code></pre>
2251
276
 
2252
277
 
2253
278
  <div class="description usertext">
2254
- Reconnect to the socket service
279
+ Close the connection to the socket service
2255
280
  </div>
2256
281
 
2257
282
 
@@ -2264,7 +289,7 @@ socketChannel.destroy();</code></pre>
2264
289
 
2265
290
  <h5>Example</h5>
2266
291
 
2267
- <pre class="prettyprint"><code>const connected = await sdk.socket.reconnect()</code></pre>
292
+ <pre class="prettyprint"><code>const closed = await sdk.socket.close()</code></pre>
2268
293
 
2269
294
 
2270
295
 
@@ -2291,7 +316,7 @@ socketChannel.destroy();</code></pre>
2291
316
 
2292
317
 
2293
318
 
2294
- <h4 class="name" id=".reconnect"><span class="type-signature">(static) </span>reconnect<span class="signature">()</span><span class="type-signature"></span></h4>
319
+ <h4 class="name" id=".connect"><span class="type-signature">(static) </span>connect<span class="signature">()</span><span class="type-signature"></span></h4>
2295
320
 
2296
321
 
2297
322
 
@@ -2303,7 +328,7 @@ socketChannel.destroy();</code></pre>
2303
328
 
2304
329
  <dt class="tag-source">Source:</dt>
2305
330
  <dd class="tag-source"><ul class="dummy"><li>
2306
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line242">line 242</a>
331
+ <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line212">line 212</a>
2307
332
  </li></ul></dd>
2308
333
 
2309
334
 
@@ -2343,7 +368,7 @@ socketChannel.destroy();</code></pre>
2343
368
 
2344
369
 
2345
370
  <div class="description usertext">
2346
- Reconnect to the socket service
371
+ Connect to the socket service
2347
372
  </div>
2348
373
 
2349
374
 
@@ -2356,7 +381,7 @@ socketChannel.destroy();</code></pre>
2356
381
 
2357
382
  <h5>Example</h5>
2358
383
 
2359
- <pre class="prettyprint"><code>const connected = await sdk.socket.reconnect()</code></pre>
384
+ <pre class="prettyprint"><code>const connected = await sdk.socket.connect()</code></pre>
2360
385
 
2361
386
 
2362
387
 
@@ -2383,7 +408,7 @@ socketChannel.destroy();</code></pre>
2383
408
 
2384
409
 
2385
410
 
2386
- <h4 class="name" id=".subscribe"><span class="type-signature">(static) </span>subscribe<span class="signature">(key)</span><span class="type-signature"></span></h4>
411
+ <h4 class="name" id=".reconnect"><span class="type-signature">(static) </span>reconnect<span class="signature">()</span><span class="type-signature"></span></h4>
2387
412
 
2388
413
 
2389
414
 
@@ -2395,7 +420,7 @@ socketChannel.destroy();</code></pre>
2395
420
 
2396
421
  <dt class="tag-source">Source:</dt>
2397
422
  <dd class="tag-source"><ul class="dummy"><li>
2398
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line301">line 301</a>
423
+ <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line248">line 248</a>
2399
424
  </li></ul></dd>
2400
425
 
2401
426
 
@@ -2435,7 +460,7 @@ socketChannel.destroy();</code></pre>
2435
460
 
2436
461
 
2437
462
  <div class="description usertext">
2438
- Subscribe to a socket channel
463
+ Reconnect to the socket service
2439
464
  </div>
2440
465
 
2441
466
 
@@ -2448,58 +473,9 @@ socketChannel.destroy();</code></pre>
2448
473
 
2449
474
  <h5>Example</h5>
2450
475
 
2451
- <pre class="prettyprint"><code>const subscribed = await sdk.socket.subscribe('some:cool:alert')</code></pre>
2452
-
2453
-
2454
-
2455
-
2456
- <h5>Parameters:</h5>
2457
-
2458
-
2459
- <table class="params">
2460
- <thead>
2461
- <tr>
2462
-
2463
- <th>Name</th>
2464
-
2465
-
2466
- <th>Type</th>
2467
-
2468
-
2469
-
2470
-
2471
-
2472
- <th class="last">Description</th>
2473
- </tr>
2474
- </thead>
2475
-
2476
- <tbody>
2477
-
2478
-
2479
- <tr>
2480
-
2481
- <td class="name"><code>key</code></td>
2482
-
2483
-
2484
- <td class="type">
2485
-
2486
-
2487
- <span class="param-type">String</span>
2488
-
2489
-
2490
-
2491
- </td>
2492
-
2493
-
2494
-
2495
-
476
+ <pre class="prettyprint"><code>const connected = await sdk.socket.reconnect()</code></pre>
2496
477
 
2497
- <td class="description last">The name of the channel to subscribe to</td>
2498
- </tr>
2499
478
 
2500
-
2501
- </tbody>
2502
- </table>
2503
479
 
2504
480
 
2505
481
 
@@ -2536,7 +512,7 @@ socketChannel.destroy();</code></pre>
2536
512
 
2537
513
  <dt class="tag-source">Source:</dt>
2538
514
  <dd class="tag-source"><ul class="dummy"><li>
2539
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line301">line 301</a>
515
+ <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line307">line 307</a>
2540
516
  </li></ul></dd>
2541
517
 
2542
518
 
@@ -2677,148 +653,7 @@ socketChannel.destroy();</code></pre>
2677
653
 
2678
654
  <dt class="tag-source">Source:</dt>
2679
655
  <dd class="tag-source"><ul class="dummy"><li>
2680
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line328">line 328</a>
2681
- </li></ul></dd>
2682
-
2683
-
2684
-
2685
-
2686
-
2687
-
2688
-
2689
-
2690
-
2691
-
2692
-
2693
-
2694
-
2695
-
2696
-
2697
-
2698
-
2699
-
2700
-
2701
-
2702
-
2703
-
2704
-
2705
-
2706
-
2707
-
2708
-
2709
-
2710
-
2711
-
2712
-
2713
- </dl>
2714
-
2715
-
2716
-
2717
-
2718
-
2719
- <div class="description usertext">
2720
- Unsubscribe from a socket channel
2721
- </div>
2722
-
2723
-
2724
-
2725
-
2726
-
2727
-
2728
-
2729
-
2730
-
2731
- <h5>Example</h5>
2732
-
2733
- <pre class="prettyprint"><code>const unsubscribed = await sdk.socket.unsubscribe('some:cool:alert')</code></pre>
2734
-
2735
-
2736
-
2737
-
2738
- <h5>Parameters:</h5>
2739
-
2740
-
2741
- <table class="params">
2742
- <thead>
2743
- <tr>
2744
-
2745
- <th>Name</th>
2746
-
2747
-
2748
- <th>Type</th>
2749
-
2750
-
2751
-
2752
-
2753
-
2754
- <th class="last">Description</th>
2755
- </tr>
2756
- </thead>
2757
-
2758
- <tbody>
2759
-
2760
-
2761
- <tr>
2762
-
2763
- <td class="name"><code>key</code></td>
2764
-
2765
-
2766
- <td class="type">
2767
-
2768
-
2769
- <span class="param-type">String</span>
2770
-
2771
-
2772
-
2773
- </td>
2774
-
2775
-
2776
-
2777
-
2778
-
2779
- <td class="description last">The name of the channel to unsubscribe from</td>
2780
- </tr>
2781
-
2782
-
2783
- </tbody>
2784
- </table>
2785
-
2786
-
2787
-
2788
-
2789
-
2790
-
2791
-
2792
-
2793
-
2794
-
2795
-
2796
-
2797
-
2798
-
2799
-
2800
-
2801
-
2802
-
2803
-
2804
-
2805
-
2806
-
2807
-
2808
-
2809
- <h4 class="name" id=".unsubscribe"><span class="type-signature">(static) </span>unsubscribe<span class="signature">(key)</span><span class="type-signature"></span></h4>
2810
-
2811
-
2812
-
2813
-
2814
-
2815
-
2816
- <dl class="details">
2817
-
2818
-
2819
- <dt class="tag-source">Source:</dt>
2820
- <dd class="tag-source"><ul class="dummy"><li>
2821
- <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line328">line 328</a>
656
+ <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line334">line 334</a>
2822
657
  </li></ul></dd>
2823
658
 
2824
659
 
@@ -2962,7 +797,7 @@ socketChannel.destroy();</code></pre>
2962
797
  <br class="clear">
2963
798
 
2964
799
  <footer>
2965
- 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.
800
+ 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.
2966
801
  </footer>
2967
802
 
2968
803
  <script>prettyPrint();</script>