@qikdev/sdk 1.0.2 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/README.md +1 -1
  2. package/dist/{docs/access.html → access.html} +353 -20
  3. package/dist/api.html +444 -0
  4. package/dist/{docs/auth.html → auth.html} +14 -14
  5. package/dist/cache.html +351 -0
  6. package/dist/{docs/content.html → content.html} +46 -21
  7. package/dist/{docs/files.html → files.html} +147 -6
  8. package/dist/{docs/filter.html → filter.html} +9 -9
  9. package/dist/geo.html +1029 -0
  10. package/dist/global.html +240 -0
  11. package/dist/index.html +96 -0
  12. package/dist/main.js +2 -3
  13. package/dist/module-QikStorage-CookieStorageAdapter.html +407 -0
  14. package/dist/module-QikStorage-LocalStorageAdapter.html +193 -0
  15. package/dist/module-QikStorage-StorageAdapter.html +977 -0
  16. package/dist/module-QikStorage.html +433 -0
  17. package/dist/qik.access.js.html +904 -0
  18. package/dist/qik.api.js.html +409 -0
  19. package/dist/{docs/qik.auth.js.html → qik.auth.js.html} +142 -104
  20. package/dist/qik.cache.js.html +125 -0
  21. package/dist/qik.content.js.html +967 -0
  22. package/dist/qik.core.js.html +322 -0
  23. package/dist/qik.files.js.html +249 -0
  24. package/dist/{docs/qik.filter.js.html → qik.filter.js.html} +3 -3
  25. package/dist/qik.geo.js.html +963 -0
  26. package/dist/{docs/qik.socket.js.html → qik.socket.js.html} +53 -12
  27. package/dist/qik.storage.js.html +375 -0
  28. package/dist/qik.system.js.html +117 -0
  29. package/dist/qik.utils.js.html +1548 -0
  30. package/dist/{docs/socket.html → socket.html} +7 -7
  31. package/dist/{docs/styles → styles}/jsdoc.css +2 -2
  32. package/dist/system.html +197 -0
  33. package/dist/utils.html +4422 -0
  34. package/package.json +2 -2
  35. package/src/api/qik.filter.js +1 -1
  36. package/src/api/qik.geo.js +1 -1
  37. package/src/api/qik.socket.js +18 -12
  38. package/src/api/qik.utils.js +6 -0
  39. package/src/version.js +1 -1
  40. package/dist/docs/api.html +0 -1356
  41. package/dist/docs/cache.html +0 -351
  42. package/dist/docs/index.html +0 -96
  43. package/dist/docs/qik.access.js.html +0 -790
  44. package/dist/docs/qik.api.js.html +0 -511
  45. package/dist/docs/qik.cache.js.html +0 -131
  46. package/dist/docs/qik.content.js.html +0 -918
  47. package/dist/docs/qik.core.js.html +0 -301
  48. package/dist/docs/qik.files.js.html +0 -219
  49. package/dist/docs/qik.system.js.html +0 -117
  50. package/dist/docs/qik.utils.js.html +0 -1467
  51. package/dist/docs/system.html +0 -197
  52. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.eot +0 -0
  53. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.ttf +0 -0
  54. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff +0 -0
  55. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff2 +0 -0
  56. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.eot +0 -0
  57. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.ttf +0 -0
  58. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff +0 -0
  59. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff2 +0 -0
  60. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  61. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  62. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  63. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  64. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  65. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  66. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  67. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  68. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  69. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  70. /package/dist/{docs/scripts → scripts}/collapse.js +0 -0
  71. /package/dist/{docs/scripts → scripts}/linenumber.js +0 -0
  72. /package/dist/{docs/scripts → scripts}/nav.js +0 -0
  73. /package/dist/{docs/scripts → scripts}/polyfill.js +0 -0
  74. /package/dist/{docs/scripts → scripts}/prettify/Apache-License-2.0.txt +0 -0
  75. /package/dist/{docs/scripts → scripts}/prettify/lang-css.js +0 -0
  76. /package/dist/{docs/scripts → scripts}/prettify/prettify.js +0 -0
  77. /package/dist/{docs/scripts → scripts}/search.js +0 -0
  78. /package/dist/{docs/styles → styles}/prettify.css +0 -0
package/dist/geo.html ADDED
@@ -0,0 +1,1029 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>geo - Documentation</title>
7
+
8
+
9
+ <script src="scripts/prettify/prettify.js"></script>
10
+ <script src="scripts/prettify/lang-css.js"></script>
11
+ <!--[if lt IE 9]>
12
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
+ <script src="scripts/nav.js" defer></script>
17
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
+ </head>
19
+ <body>
20
+
21
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
22
+ <label for="nav-trigger" class="navicon-button x">
23
+ <div class="navicon"></div>
24
+ </label>
25
+
26
+ <label for="nav-trigger" class="overlay"></label>
27
+
28
+ <nav >
29
+
30
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.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
+ </nav>
32
+
33
+ <div id="main">
34
+
35
+ <h1 class="page-title">geo</h1>
36
+
37
+
38
+
39
+
40
+
41
+
42
+
43
+ <section>
44
+
45
+ <header>
46
+
47
+ <h2>
48
+ geo
49
+ </h2>
50
+
51
+
52
+ </header>
53
+
54
+ <article>
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+ <h3 class="subsection-title">Methods</h3>
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <h4 class="name" id=".distance"><span class="type-signature">(static) </span>distance<span class="signature">(positionOne, positionTwo)</span><span class="type-signature"></span></h4>
80
+
81
+
82
+
83
+
84
+
85
+
86
+ <dl class="details">
87
+
88
+
89
+ <dt class="tag-source">Source:</dt>
90
+ <dd class="tag-source"><ul class="dummy"><li>
91
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line47">line 47</a>
92
+ </li></ul></dd>
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+ </dl>
125
+
126
+
127
+
128
+
129
+
130
+ <div class="description usertext">
131
+ Get the distance between two geo location points
132
+ </div>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <h5>Example</h5>
143
+
144
+ <pre class="prettyprint"><code>const meters = await sdk.geo.distance({lat, lon}, {lat, lon})
145
+ // Returns 634</code></pre>
146
+
147
+
148
+
149
+
150
+ <h5>Parameters:</h5>
151
+
152
+
153
+ <table class="params">
154
+ <thead>
155
+ <tr>
156
+
157
+ <th>Name</th>
158
+
159
+
160
+ <th>Type</th>
161
+
162
+
163
+
164
+
165
+
166
+ <th class="last">Description</th>
167
+ </tr>
168
+ </thead>
169
+
170
+ <tbody>
171
+
172
+
173
+ <tr>
174
+
175
+ <td class="name"><code>positionOne</code></td>
176
+
177
+
178
+ <td class="type">
179
+
180
+
181
+ <span class="param-type">Object</span>
182
+
183
+
184
+
185
+ </td>
186
+
187
+
188
+
189
+
190
+
191
+ <td class="description last">The first position
192
+ <h6>Properties</h6>
193
+
194
+
195
+ <table class="params">
196
+ <thead>
197
+ <tr>
198
+
199
+ <th>Name</th>
200
+
201
+
202
+ <th>Type</th>
203
+
204
+
205
+
206
+
207
+
208
+ <th class="last">Description</th>
209
+ </tr>
210
+ </thead>
211
+
212
+ <tbody>
213
+
214
+
215
+ <tr>
216
+
217
+ <td class="name"><code>lat</code></td>
218
+
219
+
220
+ <td class="type">
221
+
222
+
223
+ <span class="param-type">Number</span>
224
+
225
+
226
+
227
+ </td>
228
+
229
+
230
+
231
+
232
+
233
+ <td class="description last">The first positions latitude</td>
234
+ </tr>
235
+
236
+
237
+
238
+ <tr>
239
+
240
+ <td class="name"><code>lon</code></td>
241
+
242
+
243
+ <td class="type">
244
+
245
+
246
+ <span class="param-type">Number</span>
247
+
248
+
249
+
250
+ </td>
251
+
252
+
253
+
254
+
255
+
256
+ <td class="description last">The first positions longitude</td>
257
+ </tr>
258
+
259
+
260
+ </tbody>
261
+ </table>
262
+
263
+ </td>
264
+ </tr>
265
+
266
+
267
+
268
+ <tr>
269
+
270
+ <td class="name"><code>positionTwo</code></td>
271
+
272
+
273
+ <td class="type">
274
+
275
+
276
+ <span class="param-type">Object</span>
277
+
278
+
279
+
280
+ </td>
281
+
282
+
283
+
284
+
285
+
286
+ <td class="description last">The second position
287
+ <h6>Properties</h6>
288
+
289
+
290
+ <table class="params">
291
+ <thead>
292
+ <tr>
293
+
294
+ <th>Name</th>
295
+
296
+
297
+ <th>Type</th>
298
+
299
+
300
+
301
+
302
+
303
+ <th class="last">Description</th>
304
+ </tr>
305
+ </thead>
306
+
307
+ <tbody>
308
+
309
+
310
+ <tr>
311
+
312
+ <td class="name"><code>lat</code></td>
313
+
314
+
315
+ <td class="type">
316
+
317
+
318
+ <span class="param-type">Number</span>
319
+
320
+
321
+
322
+ </td>
323
+
324
+
325
+
326
+
327
+
328
+ <td class="description last">The second positions latitude</td>
329
+ </tr>
330
+
331
+
332
+
333
+ <tr>
334
+
335
+ <td class="name"><code>lon</code></td>
336
+
337
+
338
+ <td class="type">
339
+
340
+
341
+ <span class="param-type">Number</span>
342
+
343
+
344
+
345
+ </td>
346
+
347
+
348
+
349
+
350
+
351
+ <td class="description last">The second positions longitude</td>
352
+ </tr>
353
+
354
+
355
+ </tbody>
356
+ </table>
357
+
358
+ </td>
359
+ </tr>
360
+
361
+
362
+ </tbody>
363
+ </table>
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+ <h4 class="name" id=".getDefaultCountry"><span class="type-signature">(static) </span>getDefaultCountry<span class="signature">()</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#line876">line 876</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
+ 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
442
+ </div>
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+ <h5>Example</h5>
453
+
454
+ <pre class="prettyprint"><code>const result = sdk.geo.getDefaultCountry()
455
+ // Would return something similar to:
456
+ // { code:'AU', name:'Australia' }</code></pre>
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+ <h4 class="name" id=".getDefaultTimezone"><span class="type-signature">(static) </span>getDefaultTimezone<span class="signature">()</span><span class="type-signature"></span></h4>
484
+
485
+
486
+
487
+
488
+
489
+
490
+ <dl class="details">
491
+
492
+
493
+ <dt class="tag-source">Source:</dt>
494
+ <dd class="tag-source"><ul class="dummy"><li>
495
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line141">line 141</a>
496
+ </li></ul></dd>
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+ </dl>
529
+
530
+
531
+
532
+
533
+
534
+ <div class="description usertext">
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
537
+ </div>
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+ <h5>Example</h5>
548
+
549
+ <pre class="prettyprint"><code>const result = sdk.geo.getDefaultTimezone()
550
+ // Would return something similar to:
551
+ // Australia/Melbourne</code></pre>
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+ <h4 class="name" id=".getPosition"><span class="type-signature">(static) </span>getPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
579
+
580
+
581
+
582
+
583
+
584
+
585
+ <dl class="details">
586
+
587
+
588
+ <dt class="tag-source">Source:</dt>
589
+ <dd class="tag-source"><ul class="dummy"><li>
590
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line73">line 73</a>
591
+ </li></ul></dd>
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+
623
+ </dl>
624
+
625
+
626
+
627
+
628
+
629
+ <div class="description usertext">
630
+ Start watching the user's geolocation
631
+ </div>
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+ <h5>Example</h5>
642
+
643
+ <pre class="prettyprint"><code>const position = await sdk.geo.getPosition()
644
+ // Returns {coords:{latitude, longitude, altitude, accuracy, ...}}</code></pre>
645
+
646
+
647
+
648
+
649
+ <h5>Parameters:</h5>
650
+
651
+
652
+ <table class="params">
653
+ <thead>
654
+ <tr>
655
+
656
+ <th>Name</th>
657
+
658
+
659
+ <th>Type</th>
660
+
661
+
662
+
663
+
664
+
665
+ <th class="last">Description</th>
666
+ </tr>
667
+ </thead>
668
+
669
+ <tbody>
670
+
671
+
672
+ <tr>
673
+
674
+ <td class="name"><code>callback</code></td>
675
+
676
+
677
+ <td class="type">
678
+
679
+
680
+ <span class="param-type">function</span>
681
+
682
+
683
+
684
+ </td>
685
+
686
+
687
+
688
+
689
+
690
+ <td class="description last">A function that will be called with updated position data</td>
691
+ </tr>
692
+
693
+
694
+ </tbody>
695
+ </table>
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+ <h4 class="name" id=".stopWatchPosition"><span class="type-signature">(static) </span>stopWatchPosition<span class="signature">(watchID)</span><span class="type-signature"></span></h4>
721
+
722
+
723
+
724
+
725
+
726
+
727
+ <dl class="details">
728
+
729
+
730
+ <dt class="tag-source">Source:</dt>
731
+ <dd class="tag-source"><ul class="dummy"><li>
732
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line118">line 118</a>
733
+ </li></ul></dd>
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+ </dl>
766
+
767
+
768
+
769
+
770
+
771
+ <div class="description usertext">
772
+ Start watching the user's geolocation
773
+ </div>
774
+
775
+
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+ <h5>Example</h5>
784
+
785
+ <pre class="prettyprint"><code>const result = await sdk.geo.stopWatchPosition(watchID)
786
+ // Returns true after the watcher has been stopped</code></pre>
787
+
788
+
789
+
790
+
791
+ <h5>Parameters:</h5>
792
+
793
+
794
+ <table class="params">
795
+ <thead>
796
+ <tr>
797
+
798
+ <th>Name</th>
799
+
800
+
801
+ <th>Type</th>
802
+
803
+
804
+
805
+
806
+
807
+ <th class="last">Description</th>
808
+ </tr>
809
+ </thead>
810
+
811
+ <tbody>
812
+
813
+
814
+ <tr>
815
+
816
+ <td class="name"><code>watchID</code></td>
817
+
818
+
819
+ <td class="type">
820
+
821
+
822
+ <span class="param-type">String</span>
823
+
824
+
825
+
826
+ </td>
827
+
828
+
829
+
830
+
831
+
832
+ <td class="description last">the id of the watcher to stop</td>
833
+ </tr>
834
+
835
+
836
+ </tbody>
837
+ </table>
838
+
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+
850
+
851
+
852
+
853
+
854
+
855
+
856
+
857
+
858
+
859
+
860
+
861
+
862
+ <h4 class="name" id=".watchPosition"><span class="type-signature">(static) </span>watchPosition<span class="signature">(callback)</span><span class="type-signature"></span></h4>
863
+
864
+
865
+
866
+
867
+
868
+
869
+ <dl class="details">
870
+
871
+
872
+ <dt class="tag-source">Source:</dt>
873
+ <dd class="tag-source"><ul class="dummy"><li>
874
+ <a href="qik.geo.js.html">qik.geo.js</a>, <a href="qik.geo.js.html#line94">line 94</a>
875
+ </li></ul></dd>
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+
898
+
899
+
900
+
901
+
902
+
903
+
904
+
905
+
906
+
907
+ </dl>
908
+
909
+
910
+
911
+
912
+
913
+ <div class="description usertext">
914
+ Start watching the user's geolocation
915
+ </div>
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+ <h5>Example</h5>
926
+
927
+ <pre class="prettyprint"><code>const result = await sdk.geo.watchPosition(callback)
928
+ // Returns {id:&lt;watcherID>}</code></pre>
929
+
930
+
931
+
932
+
933
+ <h5>Parameters:</h5>
934
+
935
+
936
+ <table class="params">
937
+ <thead>
938
+ <tr>
939
+
940
+ <th>Name</th>
941
+
942
+
943
+ <th>Type</th>
944
+
945
+
946
+
947
+
948
+
949
+ <th class="last">Description</th>
950
+ </tr>
951
+ </thead>
952
+
953
+ <tbody>
954
+
955
+
956
+ <tr>
957
+
958
+ <td class="name"><code>callback</code></td>
959
+
960
+
961
+ <td class="type">
962
+
963
+
964
+ <span class="param-type">function</span>
965
+
966
+
967
+
968
+ </td>
969
+
970
+
971
+
972
+
973
+
974
+ <td class="description last">A function that will be called with updated position data</td>
975
+ </tr>
976
+
977
+
978
+ </tbody>
979
+ </table>
980
+
981
+
982
+
983
+
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+
1004
+
1005
+ </article>
1006
+
1007
+ </section>
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+ </div>
1015
+
1016
+ <br class="clear">
1017
+
1018
+ <footer>
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.
1020
+ </footer>
1021
+
1022
+ <script>prettyPrint();</script>
1023
+ <script src="scripts/polyfill.js"></script>
1024
+ <script src="scripts/linenumber.js"></script>
1025
+
1026
+
1027
+
1028
+ </body>
1029
+ </html>