@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/geo.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">
@@ -385,2735 +385,7 @@
385
385
 
386
386
 
387
387
 
388
- <h4 class="name" id=".distance"><span class="type-signature">(static) </span>distance<span class="signature">(positionOne, positionTwo)</span><span class="type-signature"></span></h4>
389
-
390
-
391
-
392
-
393
-
394
-
395
- <dl class="details">
396
-
397
-
398
- <dt class="tag-source">Source:</dt>
399
- <dd class="tag-source"><ul class="dummy"><li>
400
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line47">line 47</a>
401
- </li></ul></dd>
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
- </dl>
434
-
435
-
436
-
437
-
438
-
439
- <div class="description usertext">
440
- Get the distance between two geo location points
441
- </div>
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
- <h5>Example</h5>
452
-
453
- <pre class="prettyprint"><code>const meters = await sdk.geo.distance({lat, lon}, {lat, lon})
454
- // Returns 634</code></pre>
455
-
456
-
457
-
458
-
459
- <h5>Parameters:</h5>
460
-
461
-
462
- <table class="params">
463
- <thead>
464
- <tr>
465
-
466
- <th>Name</th>
467
-
468
-
469
- <th>Type</th>
470
-
471
-
472
-
473
-
474
-
475
- <th class="last">Description</th>
476
- </tr>
477
- </thead>
478
-
479
- <tbody>
480
-
481
-
482
- <tr>
483
-
484
- <td class="name"><code>positionOne</code></td>
485
-
486
-
487
- <td class="type">
488
-
489
-
490
- <span class="param-type">Object</span>
491
-
492
-
493
-
494
- </td>
495
-
496
-
497
-
498
-
499
-
500
- <td class="description last">The first position
501
- <h6>Properties</h6>
502
-
503
-
504
- <table class="params">
505
- <thead>
506
- <tr>
507
-
508
- <th>Name</th>
509
-
510
-
511
- <th>Type</th>
512
-
513
-
514
-
515
-
516
-
517
- <th class="last">Description</th>
518
- </tr>
519
- </thead>
520
-
521
- <tbody>
522
-
523
-
524
- <tr>
525
-
526
- <td class="name"><code>lat</code></td>
527
-
528
-
529
- <td class="type">
530
-
531
-
532
- <span class="param-type">Number</span>
533
-
534
-
535
-
536
- </td>
537
-
538
-
539
-
540
-
541
-
542
- <td class="description last">The first positions latitude</td>
543
- </tr>
544
-
545
-
546
-
547
- <tr>
548
-
549
- <td class="name"><code>lon</code></td>
550
-
551
-
552
- <td class="type">
553
-
554
-
555
- <span class="param-type">Number</span>
556
-
557
-
558
-
559
- </td>
560
-
561
-
562
-
563
-
564
-
565
- <td class="description last">The first positions longitude</td>
566
- </tr>
567
-
568
-
569
- </tbody>
570
- </table>
571
-
572
- </td>
573
- </tr>
574
-
575
-
576
-
577
- <tr>
578
-
579
- <td class="name"><code>positionTwo</code></td>
580
-
581
-
582
- <td class="type">
583
-
584
-
585
- <span class="param-type">Object</span>
586
-
587
-
588
-
589
- </td>
590
-
591
-
592
-
593
-
594
-
595
- <td class="description last">The second position
596
- <h6>Properties</h6>
597
-
598
-
599
- <table class="params">
600
- <thead>
601
- <tr>
602
-
603
- <th>Name</th>
604
-
605
-
606
- <th>Type</th>
607
-
608
-
609
-
610
-
611
-
612
- <th class="last">Description</th>
613
- </tr>
614
- </thead>
615
-
616
- <tbody>
617
-
618
-
619
- <tr>
620
-
621
- <td class="name"><code>lat</code></td>
622
-
623
-
624
- <td class="type">
625
-
626
-
627
- <span class="param-type">Number</span>
628
-
629
-
630
-
631
- </td>
632
-
633
-
634
-
635
-
636
-
637
- <td class="description last">The second positions latitude</td>
638
- </tr>
639
-
640
-
641
-
642
- <tr>
643
-
644
- <td class="name"><code>lon</code></td>
645
-
646
-
647
- <td class="type">
648
-
649
-
650
- <span class="param-type">Number</span>
651
-
652
-
653
-
654
- </td>
655
-
656
-
657
-
658
-
659
-
660
- <td class="description last">The second positions longitude</td>
661
- </tr>
662
-
663
-
664
- </tbody>
665
- </table>
666
-
667
- </td>
668
- </tr>
669
-
670
-
671
- </tbody>
672
- </table>
673
-
674
-
675
-
676
-
677
-
678
-
679
-
680
-
681
-
682
-
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
- <h4 class="name" id=".getDefaultCountry"><span class="type-signature">(static) </span>getDefaultCountry<span class="signature">()</span><span class="type-signature"></span></h4>
698
-
699
-
700
-
701
-
702
-
703
-
704
- <dl class="details">
705
-
706
-
707
- <dt class="tag-source">Source:</dt>
708
- <dd class="tag-source"><ul class="dummy"><li>
709
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line876">line 876</a>
710
- </li></ul></dd>
711
-
712
-
713
-
714
-
715
-
716
-
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
- </dl>
743
-
744
-
745
-
746
-
747
-
748
- <div class="description usertext">
749
- Retrieves the default country for the current user/application
750
- will attempt to retrieve the country from the user or application's organisation or from services available within the browser
751
- </div>
752
-
753
-
754
-
755
-
756
-
757
-
758
-
759
-
760
-
761
- <h5>Example</h5>
762
-
763
- <pre class="prettyprint"><code>const result = sdk.geo.getDefaultCountry()
764
- // Would return something similar to:
765
- // { code:'AU', name:'Australia' }</code></pre>
766
-
767
-
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
- <h4 class="name" id=".getDefaultCountry"><span class="type-signature">(static) </span>getDefaultCountry<span class="signature">()</span><span class="type-signature"></span></h4>
793
-
794
-
795
-
796
-
797
-
798
-
799
- <dl class="details">
800
-
801
-
802
- <dt class="tag-source">Source:</dt>
803
- <dd class="tag-source"><ul class="dummy"><li>
804
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line876">line 876</a>
805
- </li></ul></dd>
806
-
807
-
808
-
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
-
836
-
837
- </dl>
838
-
839
-
840
-
841
-
842
-
843
- <div class="description usertext">
844
- Retrieves the default country for the current user/application
845
- will attempt to retrieve the country from the user or application's organisation or from services available within the browser
846
- </div>
847
-
848
-
849
-
850
-
851
-
852
-
853
-
854
-
855
-
856
- <h5>Example</h5>
857
-
858
- <pre class="prettyprint"><code>const result = sdk.geo.getDefaultCountry()
859
- // Would return something similar to:
860
- // { code:'AU', name:'Australia' }</code></pre>
861
-
862
-
863
-
864
-
865
-
866
-
867
-
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
- <h4 class="name" id=".getDefaultTimezone"><span class="type-signature">(static) </span>getDefaultTimezone<span class="signature">()</span><span class="type-signature"></span></h4>
888
-
889
-
890
-
891
-
892
-
893
-
894
- <dl class="details">
895
-
896
-
897
- <dt class="tag-source">Source:</dt>
898
- <dd class="tag-source"><ul class="dummy"><li>
899
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line141">line 141</a>
900
- </li></ul></dd>
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
-
928
-
929
-
930
-
931
-
932
- </dl>
933
-
934
-
935
-
936
-
937
-
938
- <div class="description usertext">
939
- Retrieves the default timezone for the current user/application
940
- will attempt to retrieve an accurate timezone either from the user's organisation or available services within the browser
941
- </div>
942
-
943
-
944
-
945
-
946
-
947
-
948
-
949
-
950
-
951
- <h5>Example</h5>
952
-
953
- <pre class="prettyprint"><code>const result = sdk.geo.getDefaultTimezone()
954
- // Would return something similar to:
955
- // Australia/Melbourne</code></pre>
956
-
957
-
958
-
959
-
960
-
961
-
962
-
963
-
964
-
965
-
966
-
967
-
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
-
979
-
980
-
981
-
982
- <h4 class="name" id=".getDefaultTimezone"><span class="type-signature">(static) </span>getDefaultTimezone<span class="signature">()</span><span class="type-signature"></span></h4>
983
-
984
-
985
-
986
-
987
-
988
-
989
- <dl class="details">
990
-
991
-
992
- <dt class="tag-source">Source:</dt>
993
- <dd class="tag-source"><ul class="dummy"><li>
994
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line141">line 141</a>
995
- </li></ul></dd>
996
-
997
-
998
-
999
-
1000
-
1001
-
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
-
1010
-
1011
-
1012
-
1013
-
1014
-
1015
-
1016
-
1017
-
1018
-
1019
-
1020
-
1021
-
1022
-
1023
-
1024
-
1025
-
1026
-
1027
- </dl>
1028
-
1029
-
1030
-
1031
-
1032
-
1033
- <div class="description usertext">
1034
- Retrieves the default timezone for the current user/application
1035
- will attempt to retrieve an accurate timezone either from the user's organisation or available services within the browser
1036
- </div>
1037
-
1038
-
1039
-
1040
-
1041
-
1042
-
1043
-
1044
-
1045
-
1046
- <h5>Example</h5>
1047
-
1048
- <pre class="prettyprint"><code>const result = sdk.geo.getDefaultTimezone()
1049
- // Would return something similar to:
1050
- // Australia/Melbourne</code></pre>
1051
-
1052
-
1053
-
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
-
1062
-
1063
-
1064
-
1065
-
1066
-
1067
-
1068
-
1069
-
1070
-
1071
-
1072
-
1073
-
1074
-
1075
-
1076
-
1077
- <h4 class="name" id=".getPosition"><span class="type-signature">(static) </span>getPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
1078
-
1079
-
1080
-
1081
-
1082
-
1083
-
1084
- <dl class="details">
1085
-
1086
-
1087
- <dt class="tag-source">Source:</dt>
1088
- <dd class="tag-source"><ul class="dummy"><li>
1089
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line73">line 73</a>
1090
- </li></ul></dd>
1091
-
1092
-
1093
-
1094
-
1095
-
1096
-
1097
-
1098
-
1099
-
1100
-
1101
-
1102
-
1103
-
1104
-
1105
-
1106
-
1107
-
1108
-
1109
-
1110
-
1111
-
1112
-
1113
-
1114
-
1115
-
1116
-
1117
-
1118
-
1119
-
1120
-
1121
-
1122
- </dl>
1123
-
1124
-
1125
-
1126
-
1127
-
1128
- <div class="description usertext">
1129
- Start watching the user's geolocation
1130
- </div>
1131
-
1132
-
1133
-
1134
-
1135
-
1136
-
1137
-
1138
-
1139
-
1140
- <h5>Example</h5>
1141
-
1142
- <pre class="prettyprint"><code>const position = await sdk.geo.getPosition()
1143
- // Returns {coords:{latitude, longitude, altitude, accuracy, ...}}</code></pre>
1144
-
1145
-
1146
-
1147
-
1148
- <h5>Parameters:</h5>
1149
-
1150
-
1151
- <table class="params">
1152
- <thead>
1153
- <tr>
1154
-
1155
- <th>Name</th>
1156
-
1157
-
1158
- <th>Type</th>
1159
-
1160
-
1161
-
1162
-
1163
-
1164
- <th class="last">Description</th>
1165
- </tr>
1166
- </thead>
1167
-
1168
- <tbody>
1169
-
1170
-
1171
- <tr>
1172
-
1173
- <td class="name"><code>callback</code></td>
1174
-
1175
-
1176
- <td class="type">
1177
-
1178
-
1179
- <span class="param-type">function</span>
1180
-
1181
-
1182
-
1183
- </td>
1184
-
1185
-
1186
-
1187
-
1188
-
1189
- <td class="description last">A function that will be called with updated position data</td>
1190
- </tr>
1191
-
1192
-
1193
- </tbody>
1194
- </table>
1195
-
1196
-
1197
-
1198
-
1199
-
1200
-
1201
-
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
-
1210
-
1211
-
1212
-
1213
-
1214
-
1215
-
1216
-
1217
-
1218
-
1219
- <h4 class="name" id=".getPosition"><span class="type-signature">(static) </span>getPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
1220
-
1221
-
1222
-
1223
-
1224
-
1225
-
1226
- <dl class="details">
1227
-
1228
-
1229
- <dt class="tag-source">Source:</dt>
1230
- <dd class="tag-source"><ul class="dummy"><li>
1231
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line73">line 73</a>
1232
- </li></ul></dd>
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
-
1258
-
1259
-
1260
-
1261
-
1262
-
1263
-
1264
- </dl>
1265
-
1266
-
1267
-
1268
-
1269
-
1270
- <div class="description usertext">
1271
- Start watching the user's geolocation
1272
- </div>
1273
-
1274
-
1275
-
1276
-
1277
-
1278
-
1279
-
1280
-
1281
-
1282
- <h5>Example</h5>
1283
-
1284
- <pre class="prettyprint"><code>const position = await sdk.geo.getPosition()
1285
- // Returns {coords:{latitude, longitude, altitude, accuracy, ...}}</code></pre>
1286
-
1287
-
1288
-
1289
-
1290
- <h5>Parameters:</h5>
1291
-
1292
-
1293
- <table class="params">
1294
- <thead>
1295
- <tr>
1296
-
1297
- <th>Name</th>
1298
-
1299
-
1300
- <th>Type</th>
1301
-
1302
-
1303
-
1304
-
1305
-
1306
- <th class="last">Description</th>
1307
- </tr>
1308
- </thead>
1309
-
1310
- <tbody>
1311
-
1312
-
1313
- <tr>
1314
-
1315
- <td class="name"><code>callback</code></td>
1316
-
1317
-
1318
- <td class="type">
1319
-
1320
-
1321
- <span class="param-type">function</span>
1322
-
1323
-
1324
-
1325
- </td>
1326
-
1327
-
1328
-
1329
-
1330
-
1331
- <td class="description last">A function that will be called with updated position data</td>
1332
- </tr>
1333
-
1334
-
1335
- </tbody>
1336
- </table>
1337
-
1338
-
1339
-
1340
-
1341
-
1342
-
1343
-
1344
-
1345
-
1346
-
1347
-
1348
-
1349
-
1350
-
1351
-
1352
-
1353
-
1354
-
1355
-
1356
-
1357
-
1358
-
1359
-
1360
-
1361
- <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
1362
-
1363
-
1364
-
1365
-
1366
-
1367
-
1368
- <dl class="details">
1369
-
1370
-
1371
- <dt class="tag-source">Source:</dt>
1372
- <dd class="tag-source"><ul class="dummy"><li>
1373
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line94">line 94</a>
1374
- </li></ul></dd>
1375
-
1376
-
1377
-
1378
-
1379
-
1380
-
1381
-
1382
-
1383
-
1384
-
1385
-
1386
-
1387
-
1388
-
1389
-
1390
-
1391
-
1392
-
1393
-
1394
-
1395
-
1396
-
1397
-
1398
-
1399
-
1400
-
1401
-
1402
-
1403
-
1404
-
1405
-
1406
- </dl>
1407
-
1408
-
1409
-
1410
-
1411
-
1412
- <div class="description usertext">
1413
- Start watching the user's geolocation
1414
- </div>
1415
-
1416
-
1417
-
1418
-
1419
-
1420
-
1421
-
1422
-
1423
-
1424
- <h5>Example</h5>
1425
-
1426
- <pre class="prettyprint"><code>const result = await sdk.geo.watchPosition(callback)
1427
- // Returns {id:&lt;watcherID>}</code></pre>
1428
-
1429
-
1430
-
1431
-
1432
- <h5>Parameters:</h5>
1433
-
1434
-
1435
- <table class="params">
1436
- <thead>
1437
- <tr>
1438
-
1439
- <th>Name</th>
1440
-
1441
-
1442
- <th>Type</th>
1443
-
1444
-
1445
-
1446
-
1447
-
1448
- <th class="last">Description</th>
1449
- </tr>
1450
- </thead>
1451
-
1452
- <tbody>
1453
-
1454
-
1455
- <tr>
1456
-
1457
- <td class="name"><code>callback</code></td>
1458
-
1459
-
1460
- <td class="type">
1461
-
1462
-
1463
- <span class="param-type">function</span>
1464
-
1465
-
1466
-
1467
- </td>
1468
-
1469
-
1470
-
1471
-
1472
-
1473
- <td class="description last">A function that will be called with updated position data</td>
1474
- </tr>
1475
-
1476
-
1477
- </tbody>
1478
- </table>
1479
-
1480
-
1481
-
1482
-
1483
-
1484
-
1485
-
1486
-
1487
-
1488
-
1489
-
1490
-
1491
-
1492
-
1493
-
1494
-
1495
-
1496
-
1497
-
1498
-
1499
-
1500
-
1501
-
1502
-
1503
- <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(watchID)</span><span class="type-signature"></span></h4>
1504
-
1505
-
1506
-
1507
-
1508
-
1509
-
1510
- <dl class="details">
1511
-
1512
-
1513
- <dt class="tag-source">Source:</dt>
1514
- <dd class="tag-source"><ul class="dummy"><li>
1515
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line118">line 118</a>
1516
- </li></ul></dd>
1517
-
1518
-
1519
-
1520
-
1521
-
1522
-
1523
-
1524
-
1525
-
1526
-
1527
-
1528
-
1529
-
1530
-
1531
-
1532
-
1533
-
1534
-
1535
-
1536
-
1537
-
1538
-
1539
-
1540
-
1541
-
1542
-
1543
-
1544
-
1545
-
1546
-
1547
-
1548
- </dl>
1549
-
1550
-
1551
-
1552
-
1553
-
1554
- <div class="description usertext">
1555
- Start watching the user's geolocation
1556
- </div>
1557
-
1558
-
1559
-
1560
-
1561
-
1562
-
1563
-
1564
-
1565
-
1566
- <h5>Example</h5>
1567
-
1568
- <pre class="prettyprint"><code>const result = await sdk.geo.stopWatchPosition(watchID)
1569
- // Returns true after the watcher has been stopped</code></pre>
1570
-
1571
-
1572
-
1573
-
1574
- <h5>Parameters:</h5>
1575
-
1576
-
1577
- <table class="params">
1578
- <thead>
1579
- <tr>
1580
-
1581
- <th>Name</th>
1582
-
1583
-
1584
- <th>Type</th>
1585
-
1586
-
1587
-
1588
-
1589
-
1590
- <th class="last">Description</th>
1591
- </tr>
1592
- </thead>
1593
-
1594
- <tbody>
1595
-
1596
-
1597
- <tr>
1598
-
1599
- <td class="name"><code>watchID</code></td>
1600
-
1601
-
1602
- <td class="type">
1603
-
1604
-
1605
- <span class="param-type">String</span>
1606
-
1607
-
1608
-
1609
- </td>
1610
-
1611
-
1612
-
1613
-
1614
-
1615
- <td class="description last">the id of the watcher to stop</td>
1616
- </tr>
1617
-
1618
-
1619
- </tbody>
1620
- </table>
1621
-
1622
-
1623
-
1624
-
1625
-
1626
-
1627
-
1628
-
1629
-
1630
-
1631
-
1632
-
1633
-
1634
-
1635
-
1636
-
1637
-
1638
-
1639
-
1640
-
1641
-
1642
-
1643
-
1644
-
1645
- <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
1646
-
1647
-
1648
-
1649
-
1650
-
1651
-
1652
- <dl class="details">
1653
-
1654
-
1655
- <dt class="tag-source">Source:</dt>
1656
- <dd class="tag-source"><ul class="dummy"><li>
1657
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line94">line 94</a>
1658
- </li></ul></dd>
1659
-
1660
-
1661
-
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
-
1687
-
1688
-
1689
-
1690
- </dl>
1691
-
1692
-
1693
-
1694
-
1695
-
1696
- <div class="description usertext">
1697
- Start watching the user's geolocation
1698
- </div>
1699
-
1700
-
1701
-
1702
-
1703
-
1704
-
1705
-
1706
-
1707
-
1708
- <h5>Example</h5>
1709
-
1710
- <pre class="prettyprint"><code>const result = await sdk.geo.watchPosition(callback)
1711
- // Returns {id:&lt;watcherID>}</code></pre>
1712
-
1713
-
1714
-
1715
-
1716
- <h5>Parameters:</h5>
1717
-
1718
-
1719
- <table class="params">
1720
- <thead>
1721
- <tr>
1722
-
1723
- <th>Name</th>
1724
-
1725
-
1726
- <th>Type</th>
1727
-
1728
-
1729
-
1730
-
1731
-
1732
- <th class="last">Description</th>
1733
- </tr>
1734
- </thead>
1735
-
1736
- <tbody>
1737
-
1738
-
1739
- <tr>
1740
-
1741
- <td class="name"><code>callback</code></td>
1742
-
1743
-
1744
- <td class="type">
1745
-
1746
-
1747
- <span class="param-type">function</span>
1748
-
1749
-
1750
-
1751
- </td>
1752
-
1753
-
1754
-
1755
-
1756
-
1757
- <td class="description last">A function that will be called with updated position data</td>
1758
- </tr>
1759
-
1760
-
1761
- </tbody>
1762
- </table>
1763
-
1764
-
1765
-
1766
-
1767
-
1768
-
1769
-
1770
-
1771
-
1772
-
1773
-
1774
-
1775
-
1776
-
1777
-
1778
-
1779
-
1780
-
1781
-
1782
-
1783
-
1784
-
1785
-
1786
-
1787
- <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(watchID)</span><span class="type-signature"></span></h4>
1788
-
1789
-
1790
-
1791
-
1792
-
1793
-
1794
- <dl class="details">
1795
-
1796
-
1797
- <dt class="tag-source">Source:</dt>
1798
- <dd class="tag-source"><ul class="dummy"><li>
1799
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line118">line 118</a>
1800
- </li></ul></dd>
1801
-
1802
-
1803
-
1804
-
1805
-
1806
-
1807
-
1808
-
1809
-
1810
-
1811
-
1812
-
1813
-
1814
-
1815
-
1816
-
1817
-
1818
-
1819
-
1820
-
1821
-
1822
-
1823
-
1824
-
1825
-
1826
-
1827
-
1828
-
1829
-
1830
-
1831
-
1832
- </dl>
1833
-
1834
-
1835
-
1836
-
1837
-
1838
- <div class="description usertext">
1839
- Start watching the user's geolocation
1840
- </div>
1841
-
1842
-
1843
-
1844
-
1845
-
1846
-
1847
-
1848
-
1849
-
1850
- <h5>Example</h5>
1851
-
1852
- <pre class="prettyprint"><code>const result = await sdk.geo.stopWatchPosition(watchID)
1853
- // Returns true after the watcher has been stopped</code></pre>
1854
-
1855
-
1856
-
1857
-
1858
- <h5>Parameters:</h5>
1859
-
1860
-
1861
- <table class="params">
1862
- <thead>
1863
- <tr>
1864
-
1865
- <th>Name</th>
1866
-
1867
-
1868
- <th>Type</th>
1869
-
1870
-
1871
-
1872
-
1873
-
1874
- <th class="last">Description</th>
1875
- </tr>
1876
- </thead>
1877
-
1878
- <tbody>
1879
-
1880
-
1881
- <tr>
1882
-
1883
- <td class="name"><code>watchID</code></td>
1884
-
1885
-
1886
- <td class="type">
1887
-
1888
-
1889
- <span class="param-type">String</span>
1890
-
1891
-
1892
-
1893
- </td>
1894
-
1895
-
1896
-
1897
-
1898
-
1899
- <td class="description last">the id of the watcher to stop</td>
1900
- </tr>
1901
-
1902
-
1903
- </tbody>
1904
- </table>
1905
-
1906
-
1907
-
1908
-
1909
-
1910
-
1911
-
1912
-
1913
-
1914
-
1915
-
1916
-
1917
-
1918
-
1919
-
1920
-
1921
-
1922
-
1923
-
1924
-
1925
-
1926
-
1927
-
1928
-
1929
-
1930
- </article>
1931
-
1932
- </section>
1933
-
1934
-
1935
-
1936
-
1937
-
1938
-
1939
-
1940
- <section>
1941
-
1942
- <header>
1943
-
1944
- <h2>
1945
- geo
1946
- </h2>
1947
-
1948
-
1949
- </header>
1950
-
1951
- <article>
1952
-
1953
-
1954
-
1955
-
1956
-
1957
-
1958
-
1959
-
1960
-
1961
-
1962
-
1963
-
1964
-
1965
-
1966
-
1967
-
1968
-
1969
- <h3 class="subsection-title">Methods</h3>
1970
-
1971
-
1972
-
1973
-
1974
-
1975
-
1976
- <h4 class="name" id=".distance"><span class="type-signature">(static) </span>distance<span class="signature">(positionOne, positionTwo)</span><span class="type-signature"></span></h4>
1977
-
1978
-
1979
-
1980
-
1981
-
1982
-
1983
- <dl class="details">
1984
-
1985
-
1986
- <dt class="tag-source">Source:</dt>
1987
- <dd class="tag-source"><ul class="dummy"><li>
1988
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line47">line 47</a>
1989
- </li></ul></dd>
1990
-
1991
-
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
-
2019
-
2020
-
2021
- </dl>
2022
-
2023
-
2024
-
2025
-
2026
-
2027
- <div class="description usertext">
2028
- Get the distance between two geo location points
2029
- </div>
2030
-
2031
-
2032
-
2033
-
2034
-
2035
-
2036
-
2037
-
2038
-
2039
- <h5>Example</h5>
2040
-
2041
- <pre class="prettyprint"><code>const meters = await sdk.geo.distance({lat, lon}, {lat, lon})
2042
- // Returns 634</code></pre>
2043
-
2044
-
2045
-
2046
-
2047
- <h5>Parameters:</h5>
2048
-
2049
-
2050
- <table class="params">
2051
- <thead>
2052
- <tr>
2053
-
2054
- <th>Name</th>
2055
-
2056
-
2057
- <th>Type</th>
2058
-
2059
-
2060
-
2061
-
2062
-
2063
- <th class="last">Description</th>
2064
- </tr>
2065
- </thead>
2066
-
2067
- <tbody>
2068
-
2069
-
2070
- <tr>
2071
-
2072
- <td class="name"><code>positionOne</code></td>
2073
-
2074
-
2075
- <td class="type">
2076
-
2077
-
2078
- <span class="param-type">Object</span>
2079
-
2080
-
2081
-
2082
- </td>
2083
-
2084
-
2085
-
2086
-
2087
-
2088
- <td class="description last">The first position
2089
- <h6>Properties</h6>
2090
-
2091
-
2092
- <table class="params">
2093
- <thead>
2094
- <tr>
2095
-
2096
- <th>Name</th>
2097
-
2098
-
2099
- <th>Type</th>
2100
-
2101
-
2102
-
2103
-
2104
-
2105
- <th class="last">Description</th>
2106
- </tr>
2107
- </thead>
2108
-
2109
- <tbody>
2110
-
2111
-
2112
- <tr>
2113
-
2114
- <td class="name"><code>lat</code></td>
2115
-
2116
-
2117
- <td class="type">
2118
-
2119
-
2120
- <span class="param-type">Number</span>
2121
-
2122
-
2123
-
2124
- </td>
2125
-
2126
-
2127
-
2128
-
2129
-
2130
- <td class="description last">The first positions latitude</td>
2131
- </tr>
2132
-
2133
-
2134
-
2135
- <tr>
2136
-
2137
- <td class="name"><code>lon</code></td>
2138
-
2139
-
2140
- <td class="type">
2141
-
2142
-
2143
- <span class="param-type">Number</span>
2144
-
2145
-
2146
-
2147
- </td>
2148
-
2149
-
2150
-
2151
-
2152
-
2153
- <td class="description last">The first positions longitude</td>
2154
- </tr>
2155
-
2156
-
2157
- </tbody>
2158
- </table>
2159
-
2160
- </td>
2161
- </tr>
2162
-
2163
-
2164
-
2165
- <tr>
2166
-
2167
- <td class="name"><code>positionTwo</code></td>
2168
-
2169
-
2170
- <td class="type">
2171
-
2172
-
2173
- <span class="param-type">Object</span>
2174
-
2175
-
2176
-
2177
- </td>
2178
-
2179
-
2180
-
2181
-
2182
-
2183
- <td class="description last">The second position
2184
- <h6>Properties</h6>
2185
-
2186
-
2187
- <table class="params">
2188
- <thead>
2189
- <tr>
2190
-
2191
- <th>Name</th>
2192
-
2193
-
2194
- <th>Type</th>
2195
-
2196
-
2197
-
2198
-
2199
-
2200
- <th class="last">Description</th>
2201
- </tr>
2202
- </thead>
2203
-
2204
- <tbody>
2205
-
2206
-
2207
- <tr>
2208
-
2209
- <td class="name"><code>lat</code></td>
2210
-
2211
-
2212
- <td class="type">
2213
-
2214
-
2215
- <span class="param-type">Number</span>
2216
-
2217
-
2218
-
2219
- </td>
2220
-
2221
-
2222
-
2223
-
2224
-
2225
- <td class="description last">The second positions latitude</td>
2226
- </tr>
2227
-
2228
-
2229
-
2230
- <tr>
2231
-
2232
- <td class="name"><code>lon</code></td>
2233
-
2234
-
2235
- <td class="type">
2236
-
2237
-
2238
- <span class="param-type">Number</span>
2239
-
2240
-
2241
-
2242
- </td>
2243
-
2244
-
2245
-
2246
-
2247
-
2248
- <td class="description last">The second positions longitude</td>
2249
- </tr>
2250
-
2251
-
2252
- </tbody>
2253
- </table>
2254
-
2255
- </td>
2256
- </tr>
2257
-
2258
-
2259
- </tbody>
2260
- </table>
2261
-
2262
-
2263
-
2264
-
2265
-
2266
-
2267
-
2268
-
2269
-
2270
-
2271
-
2272
-
2273
-
2274
-
2275
-
2276
-
2277
-
2278
-
2279
-
2280
-
2281
-
2282
-
2283
-
2284
-
2285
- <h4 class="name" id=".distance"><span class="type-signature">(static) </span>distance<span class="signature">(positionOne, positionTwo)</span><span class="type-signature"></span></h4>
2286
-
2287
-
2288
-
2289
-
2290
-
2291
-
2292
- <dl class="details">
2293
-
2294
-
2295
- <dt class="tag-source">Source:</dt>
2296
- <dd class="tag-source"><ul class="dummy"><li>
2297
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line47">line 47</a>
2298
- </li></ul></dd>
2299
-
2300
-
2301
-
2302
-
2303
-
2304
-
2305
-
2306
-
2307
-
2308
-
2309
-
2310
-
2311
-
2312
-
2313
-
2314
-
2315
-
2316
-
2317
-
2318
-
2319
-
2320
-
2321
-
2322
-
2323
-
2324
-
2325
-
2326
-
2327
-
2328
-
2329
-
2330
- </dl>
2331
-
2332
-
2333
-
2334
-
2335
-
2336
- <div class="description usertext">
2337
- Get the distance between two geo location points
2338
- </div>
2339
-
2340
-
2341
-
2342
-
2343
-
2344
-
2345
-
2346
-
2347
-
2348
- <h5>Example</h5>
2349
-
2350
- <pre class="prettyprint"><code>const meters = await sdk.geo.distance({lat, lon}, {lat, lon})
2351
- // Returns 634</code></pre>
2352
-
2353
-
2354
-
2355
-
2356
- <h5>Parameters:</h5>
2357
-
2358
-
2359
- <table class="params">
2360
- <thead>
2361
- <tr>
2362
-
2363
- <th>Name</th>
2364
-
2365
-
2366
- <th>Type</th>
2367
-
2368
-
2369
-
2370
-
2371
-
2372
- <th class="last">Description</th>
2373
- </tr>
2374
- </thead>
2375
-
2376
- <tbody>
2377
-
2378
-
2379
- <tr>
2380
-
2381
- <td class="name"><code>positionOne</code></td>
2382
-
2383
-
2384
- <td class="type">
2385
-
2386
-
2387
- <span class="param-type">Object</span>
2388
-
2389
-
2390
-
2391
- </td>
2392
-
2393
-
2394
-
2395
-
2396
-
2397
- <td class="description last">The first position
2398
- <h6>Properties</h6>
2399
-
2400
-
2401
- <table class="params">
2402
- <thead>
2403
- <tr>
2404
-
2405
- <th>Name</th>
2406
-
2407
-
2408
- <th>Type</th>
2409
-
2410
-
2411
-
2412
-
2413
-
2414
- <th class="last">Description</th>
2415
- </tr>
2416
- </thead>
2417
-
2418
- <tbody>
2419
-
2420
-
2421
- <tr>
2422
-
2423
- <td class="name"><code>lat</code></td>
2424
-
2425
-
2426
- <td class="type">
2427
-
2428
-
2429
- <span class="param-type">Number</span>
2430
-
2431
-
2432
-
2433
- </td>
2434
-
2435
-
2436
-
2437
-
2438
-
2439
- <td class="description last">The first positions latitude</td>
2440
- </tr>
2441
-
2442
-
2443
-
2444
- <tr>
2445
-
2446
- <td class="name"><code>lon</code></td>
2447
-
2448
-
2449
- <td class="type">
2450
-
2451
-
2452
- <span class="param-type">Number</span>
2453
-
2454
-
2455
-
2456
- </td>
2457
-
2458
-
2459
-
2460
-
2461
-
2462
- <td class="description last">The first positions longitude</td>
2463
- </tr>
2464
-
2465
-
2466
- </tbody>
2467
- </table>
2468
-
2469
- </td>
2470
- </tr>
2471
-
2472
-
2473
-
2474
- <tr>
2475
-
2476
- <td class="name"><code>positionTwo</code></td>
2477
-
2478
-
2479
- <td class="type">
2480
-
2481
-
2482
- <span class="param-type">Object</span>
2483
-
2484
-
2485
-
2486
- </td>
2487
-
2488
-
2489
-
2490
-
2491
-
2492
- <td class="description last">The second position
2493
- <h6>Properties</h6>
2494
-
2495
-
2496
- <table class="params">
2497
- <thead>
2498
- <tr>
2499
-
2500
- <th>Name</th>
2501
-
2502
-
2503
- <th>Type</th>
2504
-
2505
-
2506
-
2507
-
2508
-
2509
- <th class="last">Description</th>
2510
- </tr>
2511
- </thead>
2512
-
2513
- <tbody>
2514
-
2515
-
2516
- <tr>
2517
-
2518
- <td class="name"><code>lat</code></td>
2519
-
2520
-
2521
- <td class="type">
2522
-
2523
-
2524
- <span class="param-type">Number</span>
2525
-
2526
-
2527
-
2528
- </td>
2529
-
2530
-
2531
-
2532
-
2533
-
2534
- <td class="description last">The second positions latitude</td>
2535
- </tr>
2536
-
2537
-
2538
-
2539
- <tr>
2540
-
2541
- <td class="name"><code>lon</code></td>
2542
-
2543
-
2544
- <td class="type">
2545
-
2546
-
2547
- <span class="param-type">Number</span>
2548
-
2549
-
2550
-
2551
- </td>
2552
-
2553
-
2554
-
2555
-
2556
-
2557
- <td class="description last">The second positions longitude</td>
2558
- </tr>
2559
-
2560
-
2561
- </tbody>
2562
- </table>
2563
-
2564
- </td>
2565
- </tr>
2566
-
2567
-
2568
- </tbody>
2569
- </table>
2570
-
2571
-
2572
-
2573
-
2574
-
2575
-
2576
-
2577
-
2578
-
2579
-
2580
-
2581
-
2582
-
2583
-
2584
-
2585
-
2586
-
2587
-
2588
-
2589
-
2590
-
2591
-
2592
-
2593
-
2594
- <h4 class="name" id=".getDefaultCountry"><span class="type-signature">(static) </span>getDefaultCountry<span class="signature">()</span><span class="type-signature"></span></h4>
2595
-
2596
-
2597
-
2598
-
2599
-
2600
-
2601
- <dl class="details">
2602
-
2603
-
2604
- <dt class="tag-source">Source:</dt>
2605
- <dd class="tag-source"><ul class="dummy"><li>
2606
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line876">line 876</a>
2607
- </li></ul></dd>
2608
-
2609
-
2610
-
2611
-
2612
-
2613
-
2614
-
2615
-
2616
-
2617
-
2618
-
2619
-
2620
-
2621
-
2622
-
2623
-
2624
-
2625
-
2626
-
2627
-
2628
-
2629
-
2630
-
2631
-
2632
-
2633
-
2634
-
2635
-
2636
-
2637
-
2638
-
2639
- </dl>
2640
-
2641
-
2642
-
2643
-
2644
-
2645
- <div class="description usertext">
2646
- Retrieves the default country for the current user/application
2647
- will attempt to retrieve the country from the user or application's organisation or from services available within the browser
2648
- </div>
2649
-
2650
-
2651
-
2652
-
2653
-
2654
-
2655
-
2656
-
2657
-
2658
- <h5>Example</h5>
2659
-
2660
- <pre class="prettyprint"><code>const result = sdk.geo.getDefaultCountry()
2661
- // Would return something similar to:
2662
- // { code:'AU', name:'Australia' }</code></pre>
2663
-
2664
-
2665
-
2666
-
2667
-
2668
-
2669
-
2670
-
2671
-
2672
-
2673
-
2674
-
2675
-
2676
-
2677
-
2678
-
2679
-
2680
-
2681
-
2682
-
2683
-
2684
-
2685
-
2686
-
2687
-
2688
-
2689
- <h4 class="name" id=".getDefaultCountry"><span class="type-signature">(static) </span>getDefaultCountry<span class="signature">()</span><span class="type-signature"></span></h4>
2690
-
2691
-
2692
-
2693
-
2694
-
2695
-
2696
- <dl class="details">
2697
-
2698
-
2699
- <dt class="tag-source">Source:</dt>
2700
- <dd class="tag-source"><ul class="dummy"><li>
2701
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line876">line 876</a>
2702
- </li></ul></dd>
2703
-
2704
-
2705
-
2706
-
2707
-
2708
-
2709
-
2710
-
2711
-
2712
-
2713
-
2714
-
2715
-
2716
-
2717
-
2718
-
2719
-
2720
-
2721
-
2722
-
2723
-
2724
-
2725
-
2726
-
2727
-
2728
-
2729
-
2730
-
2731
-
2732
-
2733
-
2734
- </dl>
2735
-
2736
-
2737
-
2738
-
2739
-
2740
- <div class="description usertext">
2741
- Retrieves the default country for the current user/application
2742
- will attempt to retrieve the country from the user or application's organisation or from services available within the browser
2743
- </div>
2744
-
2745
-
2746
-
2747
-
2748
-
2749
-
2750
-
2751
-
2752
-
2753
- <h5>Example</h5>
2754
-
2755
- <pre class="prettyprint"><code>const result = sdk.geo.getDefaultCountry()
2756
- // Would return something similar to:
2757
- // { code:'AU', name:'Australia' }</code></pre>
2758
-
2759
-
2760
-
2761
-
2762
-
2763
-
2764
-
2765
-
2766
-
2767
-
2768
-
2769
-
2770
-
2771
-
2772
-
2773
-
2774
-
2775
-
2776
-
2777
-
2778
-
2779
-
2780
-
2781
-
2782
-
2783
-
2784
- <h4 class="name" id=".getDefaultTimezone"><span class="type-signature">(static) </span>getDefaultTimezone<span class="signature">()</span><span class="type-signature"></span></h4>
2785
-
2786
-
2787
-
2788
-
2789
-
2790
-
2791
- <dl class="details">
2792
-
2793
-
2794
- <dt class="tag-source">Source:</dt>
2795
- <dd class="tag-source"><ul class="dummy"><li>
2796
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line141">line 141</a>
2797
- </li></ul></dd>
2798
-
2799
-
2800
-
2801
-
2802
-
2803
-
2804
-
2805
-
2806
-
2807
-
2808
-
2809
-
2810
-
2811
-
2812
-
2813
-
2814
-
2815
-
2816
-
2817
-
2818
-
2819
-
2820
-
2821
-
2822
-
2823
-
2824
-
2825
-
2826
-
2827
-
2828
-
2829
- </dl>
2830
-
2831
-
2832
-
2833
-
2834
-
2835
- <div class="description usertext">
2836
- Retrieves the default timezone for the current user/application
2837
- will attempt to retrieve an accurate timezone either from the user's organisation or available services within the browser
2838
- </div>
2839
-
2840
-
2841
-
2842
-
2843
-
2844
-
2845
-
2846
-
2847
-
2848
- <h5>Example</h5>
2849
-
2850
- <pre class="prettyprint"><code>const result = sdk.geo.getDefaultTimezone()
2851
- // Would return something similar to:
2852
- // Australia/Melbourne</code></pre>
2853
-
2854
-
2855
-
2856
-
2857
-
2858
-
2859
-
2860
-
2861
-
2862
-
2863
-
2864
-
2865
-
2866
-
2867
-
2868
-
2869
-
2870
-
2871
-
2872
-
2873
-
2874
-
2875
-
2876
-
2877
-
2878
-
2879
- <h4 class="name" id=".getDefaultTimezone"><span class="type-signature">(static) </span>getDefaultTimezone<span class="signature">()</span><span class="type-signature"></span></h4>
2880
-
2881
-
2882
-
2883
-
2884
-
2885
-
2886
- <dl class="details">
2887
-
2888
-
2889
- <dt class="tag-source">Source:</dt>
2890
- <dd class="tag-source"><ul class="dummy"><li>
2891
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line141">line 141</a>
2892
- </li></ul></dd>
2893
-
2894
-
2895
-
2896
-
2897
-
2898
-
2899
-
2900
-
2901
-
2902
-
2903
-
2904
-
2905
-
2906
-
2907
-
2908
-
2909
-
2910
-
2911
-
2912
-
2913
-
2914
-
2915
-
2916
-
2917
-
2918
-
2919
-
2920
-
2921
-
2922
-
2923
-
2924
- </dl>
2925
-
2926
-
2927
-
2928
-
2929
-
2930
- <div class="description usertext">
2931
- Retrieves the default timezone for the current user/application
2932
- will attempt to retrieve an accurate timezone either from the user's organisation or available services within the browser
2933
- </div>
2934
-
2935
-
2936
-
2937
-
2938
-
2939
-
2940
-
2941
-
2942
-
2943
- <h5>Example</h5>
2944
-
2945
- <pre class="prettyprint"><code>const result = sdk.geo.getDefaultTimezone()
2946
- // Would return something similar to:
2947
- // Australia/Melbourne</code></pre>
2948
-
2949
-
2950
-
2951
-
2952
-
2953
-
2954
-
2955
-
2956
-
2957
-
2958
-
2959
-
2960
-
2961
-
2962
-
2963
-
2964
-
2965
-
2966
-
2967
-
2968
-
2969
-
2970
-
2971
-
2972
-
2973
-
2974
- <h4 class="name" id=".getPosition"><span class="type-signature">(static) </span>getPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
2975
-
2976
-
2977
-
2978
-
2979
-
2980
-
2981
- <dl class="details">
2982
-
2983
-
2984
- <dt class="tag-source">Source:</dt>
2985
- <dd class="tag-source"><ul class="dummy"><li>
2986
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line73">line 73</a>
2987
- </li></ul></dd>
2988
-
2989
-
2990
-
2991
-
2992
-
2993
-
2994
-
2995
-
2996
-
2997
-
2998
-
2999
-
3000
-
3001
-
3002
-
3003
-
3004
-
3005
-
3006
-
3007
-
3008
-
3009
-
3010
-
3011
-
3012
-
3013
-
3014
-
3015
-
3016
-
3017
-
3018
-
3019
- </dl>
3020
-
3021
-
3022
-
3023
-
3024
-
3025
- <div class="description usertext">
3026
- Start watching the user's geolocation
3027
- </div>
3028
-
3029
-
3030
-
3031
-
3032
-
3033
-
3034
-
3035
-
3036
-
3037
- <h5>Example</h5>
3038
-
3039
- <pre class="prettyprint"><code>const position = await sdk.geo.getPosition()
3040
- // Returns {coords:{latitude, longitude, altitude, accuracy, ...}}</code></pre>
3041
-
3042
-
3043
-
3044
-
3045
- <h5>Parameters:</h5>
3046
-
3047
-
3048
- <table class="params">
3049
- <thead>
3050
- <tr>
3051
-
3052
- <th>Name</th>
3053
-
3054
-
3055
- <th>Type</th>
3056
-
3057
-
3058
-
3059
-
3060
-
3061
- <th class="last">Description</th>
3062
- </tr>
3063
- </thead>
3064
-
3065
- <tbody>
3066
-
3067
-
3068
- <tr>
3069
-
3070
- <td class="name"><code>callback</code></td>
3071
-
3072
-
3073
- <td class="type">
3074
-
3075
-
3076
- <span class="param-type">function</span>
3077
-
3078
-
3079
-
3080
- </td>
3081
-
3082
-
3083
-
3084
-
3085
-
3086
- <td class="description last">A function that will be called with updated position data</td>
3087
- </tr>
3088
-
3089
-
3090
- </tbody>
3091
- </table>
3092
-
3093
-
3094
-
3095
-
3096
-
3097
-
3098
-
3099
-
3100
-
3101
-
3102
-
3103
-
3104
-
3105
-
3106
-
3107
-
3108
-
3109
-
3110
-
3111
-
3112
-
3113
-
3114
-
3115
-
3116
- <h4 class="name" id=".getPosition"><span class="type-signature">(static) </span>getPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
388
+ <h4 class="name" id=".getDefaultCountry"><span class="type-signature">(static) </span>getDefaultCountry<span class="signature">()</span><span class="type-signature"></span></h4>
3117
389
 
3118
390
 
3119
391
 
@@ -3125,7 +397,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3125
397
 
3126
398
  <dt class="tag-source">Source:</dt>
3127
399
  <dd class="tag-source"><ul class="dummy"><li>
3128
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line73">line 73</a>
400
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line876">line 876</a>
3129
401
  </li></ul></dd>
3130
402
 
3131
403
 
@@ -3165,7 +437,8 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3165
437
 
3166
438
 
3167
439
  <div class="description usertext">
3168
- Start watching the user's geolocation
440
+ Retrieves the default country for the current user/application
441
+ will attempt to retrieve the country from the user or application's organisation or from services available within the browser
3169
442
  </div>
3170
443
 
3171
444
 
@@ -3178,59 +451,11 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3178
451
 
3179
452
  <h5>Example</h5>
3180
453
 
3181
- <pre class="prettyprint"><code>const position = await sdk.geo.getPosition()
3182
- // Returns {coords:{latitude, longitude, altitude, accuracy, ...}}</code></pre>
3183
-
3184
-
3185
-
3186
-
3187
- <h5>Parameters:</h5>
3188
-
3189
-
3190
- <table class="params">
3191
- <thead>
3192
- <tr>
3193
-
3194
- <th>Name</th>
3195
-
3196
-
3197
- <th>Type</th>
3198
-
3199
-
3200
-
3201
-
3202
-
3203
- <th class="last">Description</th>
3204
- </tr>
3205
- </thead>
3206
-
3207
- <tbody>
3208
-
3209
-
3210
- <tr>
3211
-
3212
- <td class="name"><code>callback</code></td>
3213
-
3214
-
3215
- <td class="type">
3216
-
3217
-
3218
- <span class="param-type">function</span>
3219
-
3220
-
3221
-
3222
- </td>
3223
-
3224
-
3225
-
3226
-
454
+ <pre class="prettyprint"><code>const result = sdk.geo.getDefaultCountry()
455
+ // Would return something similar to:
456
+ // { code:'AU', name:'Australia' }</code></pre>
3227
457
 
3228
- <td class="description last">A function that will be called with updated position data</td>
3229
- </tr>
3230
458
 
3231
-
3232
- </tbody>
3233
- </table>
3234
459
 
3235
460
 
3236
461
 
@@ -3255,7 +480,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3255
480
 
3256
481
 
3257
482
 
3258
- <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
483
+ <h4 class="name" id=".getDefaultTimezone"><span class="type-signature">(static) </span>getDefaultTimezone<span class="signature">()</span><span class="type-signature"></span></h4>
3259
484
 
3260
485
 
3261
486
 
@@ -3267,7 +492,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3267
492
 
3268
493
  <dt class="tag-source">Source:</dt>
3269
494
  <dd class="tag-source"><ul class="dummy"><li>
3270
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line94">line 94</a>
495
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line141">line 141</a>
3271
496
  </li></ul></dd>
3272
497
 
3273
498
 
@@ -3307,7 +532,8 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3307
532
 
3308
533
 
3309
534
  <div class="description usertext">
3310
- Start watching the user's geolocation
535
+ Retrieves the default timezone for the current user/application
536
+ will attempt to retrieve an accurate timezone either from the user's organisation or available services within the browser
3311
537
  </div>
3312
538
 
3313
539
 
@@ -3320,59 +546,11 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3320
546
 
3321
547
  <h5>Example</h5>
3322
548
 
3323
- <pre class="prettyprint"><code>const result = await sdk.geo.watchPosition(callback)
3324
- // Returns {id:&lt;watcherID>}</code></pre>
3325
-
3326
-
3327
-
3328
-
3329
- <h5>Parameters:</h5>
3330
-
3331
-
3332
- <table class="params">
3333
- <thead>
3334
- <tr>
3335
-
3336
- <th>Name</th>
3337
-
3338
-
3339
- <th>Type</th>
3340
-
3341
-
3342
-
3343
-
3344
-
3345
- <th class="last">Description</th>
3346
- </tr>
3347
- </thead>
3348
-
3349
- <tbody>
3350
-
3351
-
3352
- <tr>
3353
-
3354
- <td class="name"><code>callback</code></td>
3355
-
3356
-
3357
- <td class="type">
3358
-
3359
-
3360
- <span class="param-type">function</span>
3361
-
3362
-
3363
-
3364
- </td>
3365
-
3366
-
3367
-
3368
-
549
+ <pre class="prettyprint"><code>const result = sdk.geo.getDefaultTimezone()
550
+ // Would return something similar to:
551
+ // Australia/Melbourne</code></pre>
3369
552
 
3370
- <td class="description last">A function that will be called with updated position data</td>
3371
- </tr>
3372
553
 
3373
-
3374
- </tbody>
3375
- </table>
3376
554
 
3377
555
 
3378
556
 
@@ -3397,7 +575,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3397
575
 
3398
576
 
3399
577
 
3400
- <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(watchID)</span><span class="type-signature"></span></h4>
578
+ <h4 class="name" id=".getPosition"><span class="type-signature">(static) </span>getPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
3401
579
 
3402
580
 
3403
581
 
@@ -3409,7 +587,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3409
587
 
3410
588
  <dt class="tag-source">Source:</dt>
3411
589
  <dd class="tag-source"><ul class="dummy"><li>
3412
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line118">line 118</a>
590
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line73">line 73</a>
3413
591
  </li></ul></dd>
3414
592
 
3415
593
 
@@ -3462,8 +640,8 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3462
640
 
3463
641
  <h5>Example</h5>
3464
642
 
3465
- <pre class="prettyprint"><code>const result = await sdk.geo.stopWatchPosition(watchID)
3466
- // Returns true after the watcher has been stopped</code></pre>
643
+ <pre class="prettyprint"><code>const position = await sdk.geo.getPosition()
644
+ // Returns {coords:{latitude, longitude, altitude, accuracy, ...}}</code></pre>
3467
645
 
3468
646
 
3469
647
 
@@ -3493,13 +671,13 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3493
671
 
3494
672
  <tr>
3495
673
 
3496
- <td class="name"><code>watchID</code></td>
674
+ <td class="name"><code>callback</code></td>
3497
675
 
3498
676
 
3499
677
  <td class="type">
3500
678
 
3501
679
 
3502
- <span class="param-type">String</span>
680
+ <span class="param-type">function</span>
3503
681
 
3504
682
 
3505
683
 
@@ -3509,7 +687,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3509
687
 
3510
688
 
3511
689
 
3512
- <td class="description last">the id of the watcher to stop</td>
690
+ <td class="description last">A function that will be called with updated position data</td>
3513
691
  </tr>
3514
692
 
3515
693
 
@@ -3539,7 +717,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3539
717
 
3540
718
 
3541
719
 
3542
- <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
720
+ <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(watchID)</span><span class="type-signature"></span></h4>
3543
721
 
3544
722
 
3545
723
 
@@ -3551,7 +729,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3551
729
 
3552
730
  <dt class="tag-source">Source:</dt>
3553
731
  <dd class="tag-source"><ul class="dummy"><li>
3554
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line94">line 94</a>
732
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line118">line 118</a>
3555
733
  </li></ul></dd>
3556
734
 
3557
735
 
@@ -3604,8 +782,8 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3604
782
 
3605
783
  <h5>Example</h5>
3606
784
 
3607
- <pre class="prettyprint"><code>const result = await sdk.geo.watchPosition(callback)
3608
- // Returns {id:&lt;watcherID>}</code></pre>
785
+ <pre class="prettyprint"><code>const result = await sdk.geo.stopWatchPosition(watchID)
786
+ // Returns true after the watcher has been stopped</code></pre>
3609
787
 
3610
788
 
3611
789
 
@@ -3635,13 +813,13 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3635
813
 
3636
814
  <tr>
3637
815
 
3638
- <td class="name"><code>callback</code></td>
816
+ <td class="name"><code>watchID</code></td>
3639
817
 
3640
818
 
3641
819
  <td class="type">
3642
820
 
3643
821
 
3644
- <span class="param-type">function</span>
822
+ <span class="param-type">String</span>
3645
823
 
3646
824
 
3647
825
 
@@ -3651,7 +829,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3651
829
 
3652
830
 
3653
831
 
3654
- <td class="description last">A function that will be called with updated position data</td>
832
+ <td class="description last">the id of the watcher to stop</td>
3655
833
  </tr>
3656
834
 
3657
835
 
@@ -3681,7 +859,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3681
859
 
3682
860
 
3683
861
 
3684
- <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(watchID)</span><span class="type-signature"></span></h4>
862
+ <h4 class="name" id=".watchPosition"><span class="type-signature">(static) </span>watchPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
3685
863
 
3686
864
 
3687
865
 
@@ -3693,7 +871,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3693
871
 
3694
872
  <dt class="tag-source">Source:</dt>
3695
873
  <dd class="tag-source"><ul class="dummy"><li>
3696
- <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line118">line 118</a>
874
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line94">line 94</a>
3697
875
  </li></ul></dd>
3698
876
 
3699
877
 
@@ -3746,8 +924,8 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3746
924
 
3747
925
  <h5>Example</h5>
3748
926
 
3749
- <pre class="prettyprint"><code>const result = await sdk.geo.stopWatchPosition(watchID)
3750
- // Returns true after the watcher has been stopped</code></pre>
927
+ <pre class="prettyprint"><code>const result = await sdk.geo.watchPosition(callback)
928
+ // Returns {id:&lt;watcherID>}</code></pre>
3751
929
 
3752
930
 
3753
931
 
@@ -3777,13 +955,13 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3777
955
 
3778
956
  <tr>
3779
957
 
3780
- <td class="name"><code>watchID</code></td>
958
+ <td class="name"><code>callback</code></td>
3781
959
 
3782
960
 
3783
961
  <td class="type">
3784
962
 
3785
963
 
3786
- <span class="param-type">String</span>
964
+ <span class="param-type">function</span>
3787
965
 
3788
966
 
3789
967
 
@@ -3793,7 +971,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3793
971
 
3794
972
 
3795
973
 
3796
- <td class="description last">the id of the watcher to stop</td>
974
+ <td class="description last">A function that will be called with updated position data</td>
3797
975
  </tr>
3798
976
 
3799
977
 
@@ -3838,7 +1016,7 @@ will attempt to retrieve an accurate timezone either from the user's organisatio
3838
1016
  <br class="clear">
3839
1017
 
3840
1018
  <footer>
3841
- 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.
1019
+ 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.
3842
1020
  </footer>
3843
1021
 
3844
1022
  <script>prettyPrint();</script>