1 | <!DOCTYPE html>
|
2 |
|
3 | <html lang="en">
|
4 | <head>
|
5 | <meta charset="utf-8">
|
6 | <meta name="viewport" content="width=device-width">
|
7 | <title>CrossBrowdy API documentation Namespace: Location</title>
|
8 |
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
13 |
|
14 | <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
|
15 |
|
16 | </head>
|
17 |
|
18 | <body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
19 |
|
20 | <div class="navbar navbar-default navbar-fixed-top ">
|
21 | <div class="container">
|
22 | <div class="navbar-header">
|
23 | <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
|
24 | <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
25 | <span class="icon-bar"></span>
|
26 | <span class="icon-bar"></span>
|
27 | <span class="icon-bar"></span>
|
28 | </button>
|
29 | </div>
|
30 | <div class="navbar-collapse collapse" id="topNavigation">
|
31 | <ul class="nav navbar-nav">
|
32 |
|
33 | <li class="dropdown">
|
34 | <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
|
35 | <ul class="dropdown-menu inline">
|
36 | <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li>
|
37 | </ul>
|
38 | </li>
|
39 |
|
40 | <li class="dropdown">
|
41 | <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
|
42 | <ul class="dropdown-menu inline">
|
43 | <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
|
44 | </ul>
|
45 | </li>
|
46 |
|
47 | <li class="dropdown">
|
48 | <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
|
49 | <ul class="dropdown-menu inline">
|
50 | <li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li>
|
51 | </ul>
|
52 | </li>
|
53 |
|
54 | </ul>
|
55 |
|
56 | <div class="col-sm-3 col-md-3">
|
57 | <form class="navbar-form" role="search">
|
58 | <div class="input-group">
|
59 | <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
60 | <div class="input-group-btn">
|
61 | <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
62 | </div>
|
63 | </div>
|
64 | </form>
|
65 | </div>
|
66 |
|
67 | </div>
|
68 |
|
69 | </div>
|
70 | </div>
|
71 |
|
72 |
|
73 | <div class="container" id="toc-content" style="width:100%;">
|
74 | <div class="row" style="width:100%;">
|
75 |
|
76 |
|
77 | <div class="col-md-8" style="width:85%;">
|
78 |
|
79 | <div id="main">
|
80 |
|
81 |
|
82 |
|
83 | <h1 class="page-title">Namespace: Location</h1>
|
84 |
|
85 | <section>
|
86 |
|
87 | <header>
|
88 |
|
89 | <h2>
|
90 | <span class="ancestors"><a href="CB_Device.html">CB_Device</a>.</span>
|
91 |
|
92 | Location
|
93 | </h2>
|
94 |
|
95 |
|
96 | </header>
|
97 |
|
98 |
|
99 | <article>
|
100 | <div class="container-overview">
|
101 |
|
102 |
|
103 | <div class="description"><p>Static class to manage the device's location. It will return itself if it is tried to be instantiated.</p></div>
|
104 |
|
105 |
|
106 |
|
107 | <dl class="details">
|
108 |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 |
|
124 |
|
125 |
|
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 |
|
137 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
138 | <dd class="tag-source">
|
139 | <ul class="dummy">
|
140 | <li>
|
141 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
142 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-96">line 96</a>
|
143 | </li>
|
144 | </ul>
|
145 | </dd>
|
146 |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
154 | <dd class="tag-todo">
|
155 | <ul>
|
156 | <li>Normalize more differences between web clients.</li>
|
157 | </ul>
|
158 | </dd>
|
159 |
|
160 | </dl>
|
161 |
|
162 |
|
163 |
|
164 |
|
165 | </div>
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 | <h3 class="subsection-title">Members</h3>
|
179 |
|
180 | <dl>
|
181 |
|
182 | <hr>
|
183 | <dt class="name" id=".get_callbackError">
|
184 | <h4 id=".get_callbackError"><span class="type-signature"><static, readonly> </span>get_callbackError<span class="type-signature"> :function|null</span></h4>
|
185 |
|
186 |
|
187 | </dt>
|
188 | <dd>
|
189 |
|
190 | <div class="description">
|
191 | <p>Keeps the callback function used when there is an error getting the location for the <a href="CB_Device.Location.html#.get"><code>CB_Device.Location.get</code></a> function.</p>
|
192 | </div>
|
193 |
|
194 |
|
195 |
|
196 | <h5>Type:</h5>
|
197 | <ul>
|
198 | <li>
|
199 |
|
200 | <span class="param-type">function</span>
|
201 | |
|
202 |
|
203 | <span class="param-type">null</span>
|
204 |
|
205 |
|
206 |
|
207 | </li>
|
208 | </ul>
|
209 |
|
210 |
|
211 |
|
212 | <dl class="details">
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 |
|
230 |
|
231 |
|
232 |
|
233 |
|
234 |
|
235 |
|
236 |
|
237 |
|
238 |
|
239 |
|
240 |
|
241 |
|
242 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
243 | <dd class="tag-source">
|
244 | <ul class="dummy">
|
245 | <li>
|
246 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
247 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-135">line 135</a>
|
248 | </li>
|
249 | </ul>
|
250 | </dd>
|
251 |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 | </dl>
|
259 |
|
260 |
|
261 |
|
262 | </dd>
|
263 |
|
264 |
|
265 |
|
266 | <hr>
|
267 | <dt class="name" id=".get_callbackOk">
|
268 | <h4 id=".get_callbackOk"><span class="type-signature"><static, readonly> </span>get_callbackOk<span class="type-signature"> :function|null</span></h4>
|
269 |
|
270 |
|
271 | </dt>
|
272 | <dd>
|
273 |
|
274 | <div class="description">
|
275 | <p>Keeps the callback function used when location can be gotten successfully for the <a href="CB_Device.Location.html#.get"><code>CB_Device.Location.get</code></a> function.</p>
|
276 | </div>
|
277 |
|
278 |
|
279 |
|
280 | <h5>Type:</h5>
|
281 | <ul>
|
282 | <li>
|
283 |
|
284 | <span class="param-type">function</span>
|
285 | |
|
286 |
|
287 | <span class="param-type">null</span>
|
288 |
|
289 |
|
290 |
|
291 | </li>
|
292 | </ul>
|
293 |
|
294 |
|
295 |
|
296 | <dl class="details">
|
297 |
|
298 |
|
299 |
|
300 |
|
301 |
|
302 |
|
303 |
|
304 |
|
305 |
|
306 |
|
307 |
|
308 |
|
309 |
|
310 |
|
311 |
|
312 |
|
313 |
|
314 |
|
315 |
|
316 |
|
317 |
|
318 |
|
319 |
|
320 |
|
321 |
|
322 |
|
323 |
|
324 |
|
325 |
|
326 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
327 | <dd class="tag-source">
|
328 | <ul class="dummy">
|
329 | <li>
|
330 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
331 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-125">line 125</a>
|
332 | </li>
|
333 | </ul>
|
334 | </dd>
|
335 |
|
336 |
|
337 |
|
338 |
|
339 |
|
340 |
|
341 |
|
342 | </dl>
|
343 |
|
344 |
|
345 |
|
346 | </dd>
|
347 |
|
348 |
|
349 |
|
350 | <hr>
|
351 | <dt class="name" id=".get_options">
|
352 | <h4 id=".get_options"><span class="type-signature"><static, readonly> </span>get_options<span class="type-signature"> :Object|undefined</span></h4>
|
353 |
|
354 |
|
355 | </dt>
|
356 | <dd>
|
357 |
|
358 | <div class="description">
|
359 | <p>Keeps the last options used by the <a href="CB_Device.Location.html#.get"><code>CB_Device.Location.get</code></a> function.</p>
|
360 | </div>
|
361 |
|
362 |
|
363 |
|
364 | <h5>Type:</h5>
|
365 | <ul>
|
366 | <li>
|
367 |
|
368 | <span class="param-type">Object</span>
|
369 | |
|
370 |
|
371 | <span class="param-type">undefined</span>
|
372 |
|
373 |
|
374 |
|
375 | </li>
|
376 | </ul>
|
377 |
|
378 |
|
379 |
|
380 | <dl class="details">
|
381 |
|
382 |
|
383 |
|
384 |
|
385 |
|
386 |
|
387 |
|
388 |
|
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 |
|
401 |
|
402 |
|
403 |
|
404 |
|
405 |
|
406 |
|
407 |
|
408 |
|
409 |
|
410 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
411 | <dd class="tag-source">
|
412 | <ul class="dummy">
|
413 | <li>
|
414 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
415 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-145">line 145</a>
|
416 | </li>
|
417 | </ul>
|
418 | </dd>
|
419 |
|
420 |
|
421 |
|
422 |
|
423 |
|
424 |
|
425 |
|
426 | </dl>
|
427 |
|
428 |
|
429 |
|
430 | </dd>
|
431 |
|
432 |
|
433 |
|
434 | <hr>
|
435 | <dt class="name" id=".getConstantly_callbackError">
|
436 | <h4 id=".getConstantly_callbackError"><span class="type-signature"><static, readonly> </span>getConstantly_callbackError<span class="type-signature"> :function|null</span></h4>
|
437 |
|
438 |
|
439 | </dt>
|
440 | <dd>
|
441 |
|
442 | <div class="description">
|
443 | <p>Keeps the callback function used when there is an error getting the location for the <a href="CB_Device.Location.html#.getConstantly"><code>CB_Device.Location.getConstantly</code></a> function.</p>
|
444 | </div>
|
445 |
|
446 |
|
447 |
|
448 | <h5>Type:</h5>
|
449 | <ul>
|
450 | <li>
|
451 |
|
452 | <span class="param-type">function</span>
|
453 | |
|
454 |
|
455 | <span class="param-type">null</span>
|
456 |
|
457 |
|
458 |
|
459 | </li>
|
460 | </ul>
|
461 |
|
462 |
|
463 |
|
464 | <dl class="details">
|
465 |
|
466 |
|
467 |
|
468 |
|
469 |
|
470 |
|
471 |
|
472 |
|
473 |
|
474 |
|
475 |
|
476 |
|
477 |
|
478 |
|
479 |
|
480 |
|
481 |
|
482 |
|
483 |
|
484 |
|
485 |
|
486 |
|
487 |
|
488 |
|
489 |
|
490 |
|
491 |
|
492 |
|
493 |
|
494 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
495 | <dd class="tag-source">
|
496 | <ul class="dummy">
|
497 | <li>
|
498 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
499 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-165">line 165</a>
|
500 | </li>
|
501 | </ul>
|
502 | </dd>
|
503 |
|
504 |
|
505 |
|
506 |
|
507 |
|
508 |
|
509 |
|
510 | </dl>
|
511 |
|
512 |
|
513 |
|
514 | </dd>
|
515 |
|
516 |
|
517 |
|
518 | <hr>
|
519 | <dt class="name" id=".getConstantly_callbackOk">
|
520 | <h4 id=".getConstantly_callbackOk"><span class="type-signature"><static, readonly> </span>getConstantly_callbackOk<span class="type-signature"> :function|null</span></h4>
|
521 |
|
522 |
|
523 | </dt>
|
524 | <dd>
|
525 |
|
526 | <div class="description">
|
527 | <p>Keeps the callback function used when location can be gotten successfully for the <a href="CB_Device.Location.html#.getConstantly"><code>CB_Device.Location.getConstantly</code></a> function.</p>
|
528 | </div>
|
529 |
|
530 |
|
531 |
|
532 | <h5>Type:</h5>
|
533 | <ul>
|
534 | <li>
|
535 |
|
536 | <span class="param-type">function</span>
|
537 | |
|
538 |
|
539 | <span class="param-type">null</span>
|
540 |
|
541 |
|
542 |
|
543 | </li>
|
544 | </ul>
|
545 |
|
546 |
|
547 |
|
548 | <dl class="details">
|
549 |
|
550 |
|
551 |
|
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 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
579 | <dd class="tag-source">
|
580 | <ul class="dummy">
|
581 | <li>
|
582 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
583 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-155">line 155</a>
|
584 | </li>
|
585 | </ul>
|
586 | </dd>
|
587 |
|
588 |
|
589 |
|
590 |
|
591 |
|
592 |
|
593 |
|
594 | </dl>
|
595 |
|
596 |
|
597 |
|
598 | </dd>
|
599 |
|
600 |
|
601 |
|
602 | <hr>
|
603 | <dt class="name" id=".getConstantly_lastId">
|
604 | <h4 id=".getConstantly_lastId"><span class="type-signature"><static, readonly> </span>getConstantly_lastId<span class="type-signature"> :integer|null</span></h4>
|
605 |
|
606 |
|
607 | </dt>
|
608 | <dd>
|
609 |
|
610 | <div class="description">
|
611 | <p>Keeps the last watch ID that gets the location constantly. Used by the <a href="CB_Device.Location.html#.getConstantly"><code>CB_Device.Location.getConstantly</code></a> function.</p>
|
612 | </div>
|
613 |
|
614 |
|
615 |
|
616 | <h5>Type:</h5>
|
617 | <ul>
|
618 | <li>
|
619 |
|
620 | <span class="param-type">integer</span>
|
621 | |
|
622 |
|
623 | <span class="param-type">null</span>
|
624 |
|
625 |
|
626 |
|
627 | </li>
|
628 | </ul>
|
629 |
|
630 |
|
631 |
|
632 | <dl class="details">
|
633 |
|
634 |
|
635 |
|
636 |
|
637 |
|
638 |
|
639 |
|
640 |
|
641 |
|
642 |
|
643 |
|
644 |
|
645 |
|
646 |
|
647 |
|
648 |
|
649 |
|
650 |
|
651 |
|
652 |
|
653 |
|
654 |
|
655 |
|
656 |
|
657 |
|
658 |
|
659 |
|
660 |
|
661 |
|
662 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
663 | <dd class="tag-source">
|
664 | <ul class="dummy">
|
665 | <li>
|
666 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
667 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-105">line 105</a>
|
668 | </li>
|
669 | </ul>
|
670 | </dd>
|
671 |
|
672 |
|
673 |
|
674 |
|
675 |
|
676 |
|
677 |
|
678 | </dl>
|
679 |
|
680 |
|
681 |
|
682 | </dd>
|
683 |
|
684 |
|
685 |
|
686 | <hr>
|
687 | <dt class="name" id=".getConstantly_options">
|
688 | <h4 id=".getConstantly_options"><span class="type-signature"><static, readonly> </span>getConstantly_options<span class="type-signature"> :Object|undefined</span></h4>
|
689 |
|
690 |
|
691 | </dt>
|
692 | <dd>
|
693 |
|
694 | <div class="description">
|
695 | <p>Keeps the last options used by the <a href="CB_Device.Location.html#.getConstantly"><code>CB_Device.Location.getConstantly</code></a> function.</p>
|
696 | </div>
|
697 |
|
698 |
|
699 |
|
700 | <h5>Type:</h5>
|
701 | <ul>
|
702 | <li>
|
703 |
|
704 | <span class="param-type">Object</span>
|
705 | |
|
706 |
|
707 | <span class="param-type">undefined</span>
|
708 |
|
709 |
|
710 |
|
711 | </li>
|
712 | </ul>
|
713 |
|
714 |
|
715 |
|
716 | <dl class="details">
|
717 |
|
718 |
|
719 |
|
720 |
|
721 |
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 |
|
729 |
|
730 |
|
731 |
|
732 |
|
733 |
|
734 |
|
735 |
|
736 |
|
737 |
|
738 |
|
739 |
|
740 |
|
741 |
|
742 |
|
743 |
|
744 |
|
745 |
|
746 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
747 | <dd class="tag-source">
|
748 | <ul class="dummy">
|
749 | <li>
|
750 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
751 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-175">line 175</a>
|
752 | </li>
|
753 | </ul>
|
754 | </dd>
|
755 |
|
756 |
|
757 |
|
758 |
|
759 |
|
760 |
|
761 |
|
762 | </dl>
|
763 |
|
764 |
|
765 |
|
766 | </dd>
|
767 |
|
768 |
|
769 |
|
770 | <hr>
|
771 | <dt class="name" id=".keepAwake_locationLockGPS">
|
772 | <h4 id=".keepAwake_locationLockGPS"><span class="type-signature"><static, readonly> </span>keepAwake_locationLockGPS<span class="type-signature"> :Object|null</span></h4>
|
773 |
|
774 |
|
775 | </dt>
|
776 | <dd>
|
777 |
|
778 | <div class="description">
|
779 | <p>Keeps the "WakeLock" (<a href="https://developer.mozilla.org/docs/Web/API/MozWakeLock">MozWakeLock</a>) object to be able to release the lock related with the GPS (so far, only works in Firefox/Firefox OS). Used by the <a href="CB_Device.Location.html#.keepAwake"><code>CB_Device.Location.keepAwake</code></a> function.</p>
|
780 | </div>
|
781 |
|
782 |
|
783 |
|
784 | <h5>Type:</h5>
|
785 | <ul>
|
786 | <li>
|
787 |
|
788 | <span class="param-type">Object</span>
|
789 | |
|
790 |
|
791 | <span class="param-type">null</span>
|
792 |
|
793 |
|
794 |
|
795 | </li>
|
796 | </ul>
|
797 |
|
798 |
|
799 |
|
800 | <dl class="details">
|
801 |
|
802 |
|
803 |
|
804 |
|
805 |
|
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 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
831 | <dd class="tag-source">
|
832 | <ul class="dummy">
|
833 | <li>
|
834 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
835 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-115">line 115</a>
|
836 | </li>
|
837 | </ul>
|
838 | </dd>
|
839 |
|
840 |
|
841 |
|
842 |
|
843 |
|
844 |
|
845 |
|
846 | </dl>
|
847 |
|
848 |
|
849 |
|
850 | </dd>
|
851 |
|
852 | </dl>
|
853 |
|
854 |
|
855 |
|
856 | <h3 class="subsection-title">Methods</h3>
|
857 |
|
858 | <dl>
|
859 |
|
860 | <hr>
|
861 | <dt>
|
862 | <h4 class="name" id=".get"><span class="type-signature"><static> </span>get<span class="signature">( [callbackOk] [, callbackError] [, options] [, keepOldCallbackOk] [, keepOldCallbackError] [, keepOldOptions])</span><span class="type-signature"> → {undefined|false}</span></h4>
|
863 |
|
864 |
|
865 | </dt>
|
866 | <dd>
|
867 |
|
868 |
|
869 | <div class="description">
|
870 | <p>Gets the current position. Uses the <a href="https://developer.mozilla.org/docs/Web/API/Geolocation">Geolocation API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-geolocation">Apache Cordova's Geolocation plugin</a>).</p>
|
871 | </div>
|
872 |
|
873 |
|
874 |
|
875 |
|
876 |
|
877 |
|
878 |
|
879 |
|
880 | <h5>Parameters:</h5>
|
881 |
|
882 |
|
883 | <table class="params table table-striped">
|
884 | <thead>
|
885 | <tr>
|
886 |
|
887 | <th style="width:12%; min-width:110px;">Name</th>
|
888 |
|
889 |
|
890 | <th style="width:12%; min-width:110px;">Type</th>
|
891 |
|
892 |
|
893 | <th style="width:12%; min-width:110px;">Argument</th>
|
894 |
|
895 |
|
896 |
|
897 | <th style="width:12%; min-width:110px;">Default</th>
|
898 |
|
899 |
|
900 | <th class="last" style="min-width:310px;">Description</th>
|
901 | </tr>
|
902 | </thead>
|
903 |
|
904 | <tbody>
|
905 |
|
906 |
|
907 | <tr>
|
908 |
|
909 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackOk</code></td>
|
910 |
|
911 |
|
912 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
913 |
|
914 |
|
915 | <span class="param-type">function</span>
|
916 |
|
917 |
|
918 |
|
919 |
|
920 | </td>
|
921 |
|
922 |
|
923 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
924 |
|
925 | <optional><br>
|
926 |
|
927 |
|
928 |
|
929 |
|
930 |
|
931 | </td>
|
932 |
|
933 |
|
934 |
|
935 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
936 |
|
937 | </td>
|
938 |
|
939 |
|
940 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Callback that will be called if it gets the location successfully. Following the same rules as the first parameter of the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/getCurrentPosition">getCurrentPosition</a> function.</p></td>
|
941 | </tr>
|
942 |
|
943 |
|
944 |
|
945 | <tr>
|
946 |
|
947 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackError</code></td>
|
948 |
|
949 |
|
950 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
951 |
|
952 |
|
953 | <span class="param-type">function</span>
|
954 |
|
955 |
|
956 |
|
957 |
|
958 | </td>
|
959 |
|
960 |
|
961 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
962 |
|
963 | <optional><br>
|
964 |
|
965 |
|
966 |
|
967 |
|
968 |
|
969 | </td>
|
970 |
|
971 |
|
972 |
|
973 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
974 |
|
975 | </td>
|
976 |
|
977 |
|
978 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Callback that will be called if there is any error getting the location. Following the same rules as the second parameter of the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/getCurrentPosition">getCurrentPosition</a> function.</p></td>
|
979 | </tr>
|
980 |
|
981 |
|
982 |
|
983 | <tr>
|
984 |
|
985 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>options</code></td>
|
986 |
|
987 |
|
988 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
989 |
|
990 |
|
991 | <span class="param-type">Object</span>
|
992 |
|
993 |
|
994 |
|
995 |
|
996 | </td>
|
997 |
|
998 |
|
999 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1000 |
|
1001 | <optional><br>
|
1002 |
|
1003 |
|
1004 |
|
1005 |
|
1006 |
|
1007 | </td>
|
1008 |
|
1009 |
|
1010 |
|
1011 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1012 |
|
1013 | </td>
|
1014 |
|
1015 |
|
1016 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Object that represents the desired options. This parameter will be ignored if "keepOldOptions" is set to true. Following the same rules as the third parameter of the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/getCurrentPosition">getCurrentPosition</a> function.</p></td>
|
1017 | </tr>
|
1018 |
|
1019 |
|
1020 |
|
1021 | <tr>
|
1022 |
|
1023 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldCallbackOk</code></td>
|
1024 |
|
1025 |
|
1026 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1027 |
|
1028 |
|
1029 | <span class="param-type">boolean</span>
|
1030 |
|
1031 |
|
1032 |
|
1033 |
|
1034 | </td>
|
1035 |
|
1036 |
|
1037 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1038 |
|
1039 | <optional><br>
|
1040 |
|
1041 |
|
1042 |
|
1043 |
|
1044 |
|
1045 | </td>
|
1046 |
|
1047 |
|
1048 |
|
1049 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1050 |
|
1051 | true
|
1052 |
|
1053 | </td>
|
1054 |
|
1055 |
|
1056 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to false, it will not keep the old previous "callbackOk" (if any) which was/were set in previous calls to this function.</p></td>
|
1057 | </tr>
|
1058 |
|
1059 |
|
1060 |
|
1061 | <tr>
|
1062 |
|
1063 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldCallbackError</code></td>
|
1064 |
|
1065 |
|
1066 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1067 |
|
1068 |
|
1069 | <span class="param-type">boolean</span>
|
1070 |
|
1071 |
|
1072 |
|
1073 |
|
1074 | </td>
|
1075 |
|
1076 |
|
1077 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1078 |
|
1079 | <optional><br>
|
1080 |
|
1081 |
|
1082 |
|
1083 |
|
1084 |
|
1085 | </td>
|
1086 |
|
1087 |
|
1088 |
|
1089 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1090 |
|
1091 | true
|
1092 |
|
1093 | </td>
|
1094 |
|
1095 |
|
1096 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to false, it will not keep the old previous "callbackError" (if any) which was/were set in previous calls to this function.</p></td>
|
1097 | </tr>
|
1098 |
|
1099 |
|
1100 |
|
1101 | <tr>
|
1102 |
|
1103 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldOptions</code></td>
|
1104 |
|
1105 |
|
1106 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1107 |
|
1108 |
|
1109 | <span class="param-type">boolean</span>
|
1110 |
|
1111 |
|
1112 |
|
1113 |
|
1114 | </td>
|
1115 |
|
1116 |
|
1117 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1118 |
|
1119 | <optional><br>
|
1120 |
|
1121 |
|
1122 |
|
1123 |
|
1124 |
|
1125 | </td>
|
1126 |
|
1127 |
|
1128 |
|
1129 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1130 |
|
1131 | false
|
1132 |
|
1133 | </td>
|
1134 |
|
1135 |
|
1136 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, it will ignore the given options and it will try to use the old previous options (if any) which were set in previous calls to this function.</p></td>
|
1137 | </tr>
|
1138 |
|
1139 |
|
1140 | </tbody>
|
1141 | </table>
|
1142 |
|
1143 |
|
1144 |
|
1145 |
|
1146 | <dl class="details">
|
1147 |
|
1148 |
|
1149 |
|
1150 |
|
1151 |
|
1152 |
|
1153 |
|
1154 |
|
1155 |
|
1156 |
|
1157 |
|
1158 |
|
1159 |
|
1160 |
|
1161 |
|
1162 |
|
1163 |
|
1164 |
|
1165 |
|
1166 |
|
1167 |
|
1168 |
|
1169 |
|
1170 |
|
1171 |
|
1172 |
|
1173 |
|
1174 |
|
1175 |
|
1176 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1177 | <dd class="tag-source">
|
1178 | <ul class="dummy">
|
1179 | <li>
|
1180 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
1181 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-201">line 201</a>
|
1182 | </li>
|
1183 | </ul>
|
1184 | </dd>
|
1185 |
|
1186 |
|
1187 |
|
1188 |
|
1189 |
|
1190 |
|
1191 |
|
1192 | </dl>
|
1193 |
|
1194 |
|
1195 |
|
1196 |
|
1197 |
|
1198 |
|
1199 |
|
1200 |
|
1201 |
|
1202 |
|
1203 |
|
1204 |
|
1205 |
|
1206 | <h5>Returns:</h5>
|
1207 |
|
1208 |
|
1209 | <div class="param-desc">
|
1210 | <p>Returns false in the case that <a href="https://developer.mozilla.org/docs/Web/API/Geolocation">Geolocation API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-geolocation">Apache Cordova's Geolocation plugin</a>) is not supported or undefined otherwise.</p>
|
1211 | </div>
|
1212 |
|
1213 |
|
1214 |
|
1215 | <dl>
|
1216 | <dt>
|
1217 | Type
|
1218 | </dt>
|
1219 | <dd>
|
1220 |
|
1221 | <span class="param-type">undefined</span>
|
1222 | |
|
1223 |
|
1224 | <span class="param-type">false</span>
|
1225 |
|
1226 |
|
1227 |
|
1228 | </dd>
|
1229 | </dl>
|
1230 |
|
1231 |
|
1232 |
|
1233 |
|
1234 |
|
1235 | </dd>
|
1236 |
|
1237 |
|
1238 |
|
1239 | <hr>
|
1240 | <dt>
|
1241 | <h4 class="name" id=".getConstantly"><span class="type-signature"><static> </span>getConstantly<span class="signature">( [callbackOkOrId] [, callbackError] [, options] [, keepOldCallbackOk] [, keepOldCallbackError] [, keepOldOptions])</span><span class="type-signature"> → {integer|undefined|false}</span></h4>
|
1242 |
|
1243 |
|
1244 | </dt>
|
1245 | <dd>
|
1246 |
|
1247 |
|
1248 | <div class="description">
|
1249 | <p>Starts or stops getting the current position constantly (real-time) every time it changes. Uses the <a href="https://developer.mozilla.org/docs/Web/API/Geolocation">Geolocation API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-geolocation">Apache Cordova's Geolocation plugin</a>).</p>
|
1250 | </div>
|
1251 |
|
1252 |
|
1253 |
|
1254 |
|
1255 |
|
1256 |
|
1257 |
|
1258 |
|
1259 | <h5>Parameters:</h5>
|
1260 |
|
1261 |
|
1262 | <table class="params table table-striped">
|
1263 | <thead>
|
1264 | <tr>
|
1265 |
|
1266 | <th style="width:12%; min-width:110px;">Name</th>
|
1267 |
|
1268 |
|
1269 | <th style="width:12%; min-width:110px;">Type</th>
|
1270 |
|
1271 |
|
1272 | <th style="width:12%; min-width:110px;">Argument</th>
|
1273 |
|
1274 |
|
1275 |
|
1276 | <th style="width:12%; min-width:110px;">Default</th>
|
1277 |
|
1278 |
|
1279 | <th class="last" style="min-width:310px;">Description</th>
|
1280 | </tr>
|
1281 | </thead>
|
1282 |
|
1283 | <tbody>
|
1284 |
|
1285 |
|
1286 | <tr>
|
1287 |
|
1288 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackOkOrId</code></td>
|
1289 |
|
1290 |
|
1291 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1292 |
|
1293 |
|
1294 | <span class="param-type">function</span>
|
1295 | |
|
1296 |
|
1297 | <span class="param-type">integer</span>
|
1298 |
|
1299 |
|
1300 |
|
1301 |
|
1302 | </td>
|
1303 |
|
1304 |
|
1305 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1306 |
|
1307 | <optional><br>
|
1308 |
|
1309 |
|
1310 |
|
1311 |
|
1312 |
|
1313 | </td>
|
1314 |
|
1315 |
|
1316 |
|
1317 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1318 |
|
1319 | <a href="CB_Device.Location.html#.getConstantly_lastId"><code>CB_Device.Location.getConstantly_lastId</code></a>
|
1320 |
|
1321 | </td>
|
1322 |
|
1323 |
|
1324 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>In the case that we want to start getting the position, use a function callback that will be called every time it gets the location successfully (using the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/watchPosition">watchPosition</a> function). To stop getting the position, use the watch ID that we want to stop (using the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/clearWatch">clearWatch</a> function). Following the same rules as the first parameter of the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/watchPosition">watchPosition</a> function (when we want to start watching) or the first parameter of <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/clearWatch">clearWatch</a> function (when we want to stop watching).</p></td>
|
1325 | </tr>
|
1326 |
|
1327 |
|
1328 |
|
1329 | <tr>
|
1330 |
|
1331 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackError</code></td>
|
1332 |
|
1333 |
|
1334 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1335 |
|
1336 |
|
1337 | <span class="param-type">function</span>
|
1338 |
|
1339 |
|
1340 |
|
1341 |
|
1342 | </td>
|
1343 |
|
1344 |
|
1345 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1346 |
|
1347 | <optional><br>
|
1348 |
|
1349 |
|
1350 |
|
1351 |
|
1352 |
|
1353 | </td>
|
1354 |
|
1355 |
|
1356 |
|
1357 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1358 |
|
1359 | </td>
|
1360 |
|
1361 |
|
1362 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Callback that will be called if there is any error getting the location. Only used when we want to start getting the current position ("callbackOkOrId" is a function). Following the same rules as the second parameter of the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/watchPosition">watchPosition</a> function.</p></td>
|
1363 | </tr>
|
1364 |
|
1365 |
|
1366 |
|
1367 | <tr>
|
1368 |
|
1369 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>options</code></td>
|
1370 |
|
1371 |
|
1372 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1373 |
|
1374 |
|
1375 | <span class="param-type">Object</span>
|
1376 |
|
1377 |
|
1378 |
|
1379 |
|
1380 | </td>
|
1381 |
|
1382 |
|
1383 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1384 |
|
1385 | <optional><br>
|
1386 |
|
1387 |
|
1388 |
|
1389 |
|
1390 |
|
1391 | </td>
|
1392 |
|
1393 |
|
1394 |
|
1395 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1396 |
|
1397 | </td>
|
1398 |
|
1399 |
|
1400 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Object that represents the desired options. This parameter will be ignored if "keepOldOptions" is set to true. Only used when we want to start getting the current position ("callbackOkOrId" is a function). Following the same rules as the third parameter of the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/watchPosition">watchPosition</a> function.</p></td>
|
1401 | </tr>
|
1402 |
|
1403 |
|
1404 |
|
1405 | <tr>
|
1406 |
|
1407 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldCallbackOk</code></td>
|
1408 |
|
1409 |
|
1410 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1411 |
|
1412 |
|
1413 | <span class="param-type">boolean</span>
|
1414 |
|
1415 |
|
1416 |
|
1417 |
|
1418 | </td>
|
1419 |
|
1420 |
|
1421 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1422 |
|
1423 | <optional><br>
|
1424 |
|
1425 |
|
1426 |
|
1427 |
|
1428 |
|
1429 | </td>
|
1430 |
|
1431 |
|
1432 |
|
1433 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1434 |
|
1435 | true
|
1436 |
|
1437 | </td>
|
1438 |
|
1439 |
|
1440 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to false, it will not keep the old previous "callbackOk" (if any) which was/were set in previous calls to this function. Only used when we want to start getting the current position ("callbackOkOrId" is a function).</p></td>
|
1441 | </tr>
|
1442 |
|
1443 |
|
1444 |
|
1445 | <tr>
|
1446 |
|
1447 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldCallbackError</code></td>
|
1448 |
|
1449 |
|
1450 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1451 |
|
1452 |
|
1453 | <span class="param-type">boolean</span>
|
1454 |
|
1455 |
|
1456 |
|
1457 |
|
1458 | </td>
|
1459 |
|
1460 |
|
1461 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1462 |
|
1463 | <optional><br>
|
1464 |
|
1465 |
|
1466 |
|
1467 |
|
1468 |
|
1469 | </td>
|
1470 |
|
1471 |
|
1472 |
|
1473 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1474 |
|
1475 | true
|
1476 |
|
1477 | </td>
|
1478 |
|
1479 |
|
1480 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to false, it will not keep the old previous "callbackError" (if any) which was/were set in previous calls to this function. Only used when we want to start getting the current position ("callbackOkOrId" is a function).</p></td>
|
1481 | </tr>
|
1482 |
|
1483 |
|
1484 |
|
1485 | <tr>
|
1486 |
|
1487 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldOptions</code></td>
|
1488 |
|
1489 |
|
1490 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1491 |
|
1492 |
|
1493 | <span class="param-type">boolean</span>
|
1494 |
|
1495 |
|
1496 |
|
1497 |
|
1498 | </td>
|
1499 |
|
1500 |
|
1501 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1502 |
|
1503 | <optional><br>
|
1504 |
|
1505 |
|
1506 |
|
1507 |
|
1508 |
|
1509 | </td>
|
1510 |
|
1511 |
|
1512 |
|
1513 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1514 |
|
1515 | false
|
1516 |
|
1517 | </td>
|
1518 |
|
1519 |
|
1520 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, it will ignore the given options and it will try to use the old previous options (if any) which were set in previous calls to this function. Only used when we want to start getting the current position ("callbackOkOrId" is a function).</p></td>
|
1521 | </tr>
|
1522 |
|
1523 |
|
1524 | </tbody>
|
1525 | </table>
|
1526 |
|
1527 |
|
1528 |
|
1529 |
|
1530 | <dl class="details">
|
1531 |
|
1532 |
|
1533 |
|
1534 |
|
1535 |
|
1536 |
|
1537 |
|
1538 |
|
1539 |
|
1540 |
|
1541 |
|
1542 |
|
1543 |
|
1544 |
|
1545 |
|
1546 |
|
1547 |
|
1548 |
|
1549 |
|
1550 |
|
1551 |
|
1552 |
|
1553 |
|
1554 |
|
1555 |
|
1556 |
|
1557 |
|
1558 |
|
1559 |
|
1560 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1561 | <dd class="tag-source">
|
1562 | <ul class="dummy">
|
1563 | <li>
|
1564 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
1565 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-265">line 265</a>
|
1566 | </li>
|
1567 | </ul>
|
1568 | </dd>
|
1569 |
|
1570 |
|
1571 |
|
1572 |
|
1573 |
|
1574 |
|
1575 |
|
1576 | </dl>
|
1577 |
|
1578 |
|
1579 |
|
1580 |
|
1581 |
|
1582 |
|
1583 |
|
1584 |
|
1585 |
|
1586 |
|
1587 |
|
1588 |
|
1589 |
|
1590 | <h5>Returns:</h5>
|
1591 |
|
1592 |
|
1593 | <div class="param-desc">
|
1594 | <p>Returns false in the case that <a href="https://developer.mozilla.org/docs/Web/API/Geolocation">Geolocation API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-geolocation">Apache Cordova's Geolocation plugin</a>) is not supported. In the case that we want to start getting the current position ("callbackOkOrId" is a function), it will return the watch ID that has been created. In the case that we want to stop getting the position ("callbackOkOrId" is a watch ID), it will return undefined.</p>
|
1595 | </div>
|
1596 |
|
1597 |
|
1598 |
|
1599 | <dl>
|
1600 | <dt>
|
1601 | Type
|
1602 | </dt>
|
1603 | <dd>
|
1604 |
|
1605 | <span class="param-type">integer</span>
|
1606 | |
|
1607 |
|
1608 | <span class="param-type">undefined</span>
|
1609 | |
|
1610 |
|
1611 | <span class="param-type">false</span>
|
1612 |
|
1613 |
|
1614 |
|
1615 | </dd>
|
1616 | </dl>
|
1617 |
|
1618 |
|
1619 |
|
1620 |
|
1621 |
|
1622 | </dd>
|
1623 |
|
1624 |
|
1625 |
|
1626 | <hr>
|
1627 | <dt>
|
1628 | <h4 class="name" id=".getConstantlyDisable"><span class="type-signature"><static> </span>getConstantlyDisable<span class="signature">( [id] [, keepOldCallbackOk] [, keepOldCallbackError] [, keepOldOptions])</span><span class="type-signature"> → {undefined|false}</span></h4>
|
1629 |
|
1630 |
|
1631 | </dt>
|
1632 | <dd>
|
1633 |
|
1634 |
|
1635 | <div class="description">
|
1636 | <p>Stops getting the current position constantly (real-time) every time it changes. Uses the <a href="https://developer.mozilla.org/docs/Web/API/Geolocation">Geolocation API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-geolocation">Apache Cordova's Geolocation plugin</a>).</p>
|
1637 | </div>
|
1638 |
|
1639 |
|
1640 |
|
1641 |
|
1642 |
|
1643 |
|
1644 |
|
1645 |
|
1646 | <h5>Parameters:</h5>
|
1647 |
|
1648 |
|
1649 | <table class="params table table-striped">
|
1650 | <thead>
|
1651 | <tr>
|
1652 |
|
1653 | <th style="width:12%; min-width:110px;">Name</th>
|
1654 |
|
1655 |
|
1656 | <th style="width:12%; min-width:110px;">Type</th>
|
1657 |
|
1658 |
|
1659 | <th style="width:12%; min-width:110px;">Argument</th>
|
1660 |
|
1661 |
|
1662 |
|
1663 | <th style="width:12%; min-width:110px;">Default</th>
|
1664 |
|
1665 |
|
1666 | <th class="last" style="min-width:310px;">Description</th>
|
1667 | </tr>
|
1668 | </thead>
|
1669 |
|
1670 | <tbody>
|
1671 |
|
1672 |
|
1673 | <tr>
|
1674 |
|
1675 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>id</code></td>
|
1676 |
|
1677 |
|
1678 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1679 |
|
1680 |
|
1681 | <span class="param-type">integer</span>
|
1682 |
|
1683 |
|
1684 |
|
1685 |
|
1686 | </td>
|
1687 |
|
1688 |
|
1689 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1690 |
|
1691 | <optional><br>
|
1692 |
|
1693 |
|
1694 |
|
1695 |
|
1696 |
|
1697 | </td>
|
1698 |
|
1699 |
|
1700 |
|
1701 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1702 |
|
1703 | <a href="CB_Device.Location.html#.getConstantly_lastId"><code>CB_Device.Location.getConstantly_lastId</code></a>
|
1704 |
|
1705 | </td>
|
1706 |
|
1707 |
|
1708 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The watch ID that we want to stop. Following the same rules as the first parameter of the native <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/clearWatch">clearWatch</a> function.</p></td>
|
1709 | </tr>
|
1710 |
|
1711 |
|
1712 |
|
1713 | <tr>
|
1714 |
|
1715 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldCallbackOk</code></td>
|
1716 |
|
1717 |
|
1718 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1719 |
|
1720 |
|
1721 | <span class="param-type">boolean</span>
|
1722 |
|
1723 |
|
1724 |
|
1725 |
|
1726 | </td>
|
1727 |
|
1728 |
|
1729 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1730 |
|
1731 | <optional><br>
|
1732 |
|
1733 |
|
1734 |
|
1735 |
|
1736 |
|
1737 | </td>
|
1738 |
|
1739 |
|
1740 |
|
1741 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1742 |
|
1743 | false
|
1744 |
|
1745 | </td>
|
1746 |
|
1747 |
|
1748 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to false, it will not remove the current "callbackOk" (if any) which was/were set previously.</p></td>
|
1749 | </tr>
|
1750 |
|
1751 |
|
1752 |
|
1753 | <tr>
|
1754 |
|
1755 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldCallbackError</code></td>
|
1756 |
|
1757 |
|
1758 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1759 |
|
1760 |
|
1761 | <span class="param-type">boolean</span>
|
1762 |
|
1763 |
|
1764 |
|
1765 |
|
1766 | </td>
|
1767 |
|
1768 |
|
1769 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1770 |
|
1771 | <optional><br>
|
1772 |
|
1773 |
|
1774 |
|
1775 |
|
1776 |
|
1777 | </td>
|
1778 |
|
1779 |
|
1780 |
|
1781 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1782 |
|
1783 | false
|
1784 |
|
1785 | </td>
|
1786 |
|
1787 |
|
1788 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to false, it will remove the current "callbackError" (if any) which was/were set previously.</p></td>
|
1789 | </tr>
|
1790 |
|
1791 |
|
1792 |
|
1793 | <tr>
|
1794 |
|
1795 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldOptions</code></td>
|
1796 |
|
1797 |
|
1798 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1799 |
|
1800 |
|
1801 | <span class="param-type">boolean</span>
|
1802 |
|
1803 |
|
1804 |
|
1805 |
|
1806 | </td>
|
1807 |
|
1808 |
|
1809 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1810 |
|
1811 | <optional><br>
|
1812 |
|
1813 |
|
1814 |
|
1815 |
|
1816 |
|
1817 | </td>
|
1818 |
|
1819 |
|
1820 |
|
1821 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1822 |
|
1823 | false
|
1824 |
|
1825 | </td>
|
1826 |
|
1827 |
|
1828 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to false, it will remove the current "options" (if any) which were set previously.</p></td>
|
1829 | </tr>
|
1830 |
|
1831 |
|
1832 | </tbody>
|
1833 | </table>
|
1834 |
|
1835 |
|
1836 |
|
1837 |
|
1838 | <dl class="details">
|
1839 |
|
1840 |
|
1841 |
|
1842 |
|
1843 |
|
1844 |
|
1845 |
|
1846 |
|
1847 |
|
1848 |
|
1849 |
|
1850 |
|
1851 |
|
1852 |
|
1853 |
|
1854 |
|
1855 |
|
1856 |
|
1857 |
|
1858 |
|
1859 |
|
1860 |
|
1861 |
|
1862 |
|
1863 |
|
1864 |
|
1865 |
|
1866 |
|
1867 |
|
1868 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1869 | <dd class="tag-source">
|
1870 | <ul class="dummy">
|
1871 | <li>
|
1872 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
1873 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-342">line 342</a>
|
1874 | </li>
|
1875 | </ul>
|
1876 | </dd>
|
1877 |
|
1878 |
|
1879 |
|
1880 |
|
1881 |
|
1882 |
|
1883 |
|
1884 | </dl>
|
1885 |
|
1886 |
|
1887 |
|
1888 |
|
1889 |
|
1890 |
|
1891 |
|
1892 |
|
1893 |
|
1894 |
|
1895 |
|
1896 |
|
1897 |
|
1898 | <h5>Returns:</h5>
|
1899 |
|
1900 |
|
1901 | <div class="param-desc">
|
1902 | <p>Returns false in the case that <a href="https://developer.mozilla.org/docs/Web/API/Geolocation">Geolocation API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-geolocation">Apache Cordova's Geolocation plugin</a>) is not supported or undefined otherwise.</p>
|
1903 | </div>
|
1904 |
|
1905 |
|
1906 |
|
1907 | <dl>
|
1908 | <dt>
|
1909 | Type
|
1910 | </dt>
|
1911 | <dd>
|
1912 |
|
1913 | <span class="param-type">undefined</span>
|
1914 | |
|
1915 |
|
1916 | <span class="param-type">false</span>
|
1917 |
|
1918 |
|
1919 |
|
1920 | </dd>
|
1921 | </dl>
|
1922 |
|
1923 |
|
1924 |
|
1925 |
|
1926 |
|
1927 | </dd>
|
1928 |
|
1929 |
|
1930 |
|
1931 | <hr>
|
1932 | <dt>
|
1933 | <h4 class="name" id=".isSupported"><span class="type-signature"><static> </span>isSupported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
1934 |
|
1935 |
|
1936 | </dt>
|
1937 | <dd>
|
1938 |
|
1939 |
|
1940 | <div class="description">
|
1941 | <p>Tells whether the <a href="https://developer.mozilla.org/docs/Web/API/Geolocation">Geolocation API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-geolocation">Apache Cordova's Geolocation plugin</a>) is supported or not.</p>
|
1942 | </div>
|
1943 |
|
1944 |
|
1945 |
|
1946 |
|
1947 |
|
1948 |
|
1949 |
|
1950 |
|
1951 |
|
1952 |
|
1953 | <dl class="details">
|
1954 |
|
1955 |
|
1956 |
|
1957 |
|
1958 |
|
1959 |
|
1960 |
|
1961 |
|
1962 |
|
1963 |
|
1964 |
|
1965 |
|
1966 |
|
1967 |
|
1968 |
|
1969 |
|
1970 |
|
1971 |
|
1972 |
|
1973 |
|
1974 |
|
1975 |
|
1976 |
|
1977 |
|
1978 |
|
1979 |
|
1980 |
|
1981 |
|
1982 |
|
1983 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1984 | <dd class="tag-source">
|
1985 | <ul class="dummy">
|
1986 | <li>
|
1987 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
1988 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-183">line 183</a>
|
1989 | </li>
|
1990 | </ul>
|
1991 | </dd>
|
1992 |
|
1993 |
|
1994 |
|
1995 |
|
1996 |
|
1997 |
|
1998 |
|
1999 | </dl>
|
2000 |
|
2001 |
|
2002 |
|
2003 |
|
2004 |
|
2005 |
|
2006 |
|
2007 |
|
2008 |
|
2009 |
|
2010 |
|
2011 |
|
2012 |
|
2013 | <h5>Returns:</h5>
|
2014 |
|
2015 |
|
2016 |
|
2017 |
|
2018 | <dl>
|
2019 | <dt>
|
2020 | Type
|
2021 | </dt>
|
2022 | <dd>
|
2023 |
|
2024 | <span class="param-type">boolean</span>
|
2025 |
|
2026 |
|
2027 |
|
2028 | </dd>
|
2029 | </dl>
|
2030 |
|
2031 |
|
2032 |
|
2033 |
|
2034 |
|
2035 | </dd>
|
2036 |
|
2037 |
|
2038 |
|
2039 | <hr>
|
2040 | <dt>
|
2041 | <h4 class="name" id=".keepAwake"><span class="type-signature"><static> </span>keepAwake<span class="signature">( [keepAwake] [, lock])</span><span class="type-signature"> → {undefined|Object|false}</span></h4>
|
2042 |
|
2043 |
|
2044 | </dt>
|
2045 | <dd>
|
2046 |
|
2047 |
|
2048 | <div class="description">
|
2049 | <p>Keeps or stops keeping the application getting the position, even when the application is invisible or screen is locked, by using <a href="https://developer.mozilla.org/docs/Web/API/Navigator/requestWakeLock">requestWakeLock</a> (so far, only works in Firefox/Firefox OS).</p>
|
2050 | </div>
|
2051 |
|
2052 |
|
2053 |
|
2054 |
|
2055 |
|
2056 |
|
2057 |
|
2058 |
|
2059 | <h5>Parameters:</h5>
|
2060 |
|
2061 |
|
2062 | <table class="params table table-striped">
|
2063 | <thead>
|
2064 | <tr>
|
2065 |
|
2066 | <th style="width:12%; min-width:110px;">Name</th>
|
2067 |
|
2068 |
|
2069 | <th style="width:12%; min-width:110px;">Type</th>
|
2070 |
|
2071 |
|
2072 | <th style="width:12%; min-width:110px;">Argument</th>
|
2073 |
|
2074 |
|
2075 |
|
2076 | <th style="width:12%; min-width:110px;">Default</th>
|
2077 |
|
2078 |
|
2079 | <th class="last" style="min-width:310px;">Description</th>
|
2080 | </tr>
|
2081 | </thead>
|
2082 |
|
2083 | <tbody>
|
2084 |
|
2085 |
|
2086 | <tr>
|
2087 |
|
2088 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepAwake</code></td>
|
2089 |
|
2090 |
|
2091 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2092 |
|
2093 |
|
2094 | <span class="param-type">boolean</span>
|
2095 |
|
2096 |
|
2097 |
|
2098 |
|
2099 | </td>
|
2100 |
|
2101 |
|
2102 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2103 |
|
2104 | <optional><br>
|
2105 |
|
2106 |
|
2107 |
|
2108 |
|
2109 |
|
2110 | </td>
|
2111 |
|
2112 |
|
2113 |
|
2114 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2115 |
|
2116 | true
|
2117 |
|
2118 | </td>
|
2119 |
|
2120 |
|
2121 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep it awake or stop doing it.</p></td>
|
2122 | </tr>
|
2123 |
|
2124 |
|
2125 |
|
2126 | <tr>
|
2127 |
|
2128 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>lock</code></td>
|
2129 |
|
2130 |
|
2131 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2132 |
|
2133 |
|
2134 | <span class="param-type">Object</span>
|
2135 |
|
2136 |
|
2137 |
|
2138 |
|
2139 | </td>
|
2140 |
|
2141 |
|
2142 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2143 |
|
2144 | <optional><br>
|
2145 |
|
2146 |
|
2147 |
|
2148 |
|
2149 |
|
2150 | </td>
|
2151 |
|
2152 |
|
2153 |
|
2154 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2155 |
|
2156 | <a href="CB_Device.Location.html#.keepAwake_locationLockGPS"><code>CB_Device.Location.keepAwake_locationLockGPS</code></a>
|
2157 |
|
2158 | </td>
|
2159 |
|
2160 |
|
2161 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The "WakeLock" (<a href="https://developer.mozilla.org/docs/Web/API/MozWakeLock">MozWakeLock</a>) object that we want to unlock. It will be used only when "keepAwake" is set to false.</p></td>
|
2162 | </tr>
|
2163 |
|
2164 |
|
2165 | </tbody>
|
2166 | </table>
|
2167 |
|
2168 |
|
2169 |
|
2170 |
|
2171 | <dl class="details">
|
2172 |
|
2173 |
|
2174 |
|
2175 |
|
2176 |
|
2177 |
|
2178 |
|
2179 |
|
2180 |
|
2181 |
|
2182 |
|
2183 |
|
2184 |
|
2185 |
|
2186 |
|
2187 |
|
2188 |
|
2189 |
|
2190 |
|
2191 |
|
2192 |
|
2193 |
|
2194 |
|
2195 |
|
2196 |
|
2197 |
|
2198 |
|
2199 |
|
2200 |
|
2201 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2202 | <dd class="tag-source">
|
2203 | <ul class="dummy">
|
2204 | <li>
|
2205 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
2206 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-360">line 360</a>
|
2207 | </li>
|
2208 | </ul>
|
2209 | </dd>
|
2210 |
|
2211 |
|
2212 |
|
2213 |
|
2214 |
|
2215 |
|
2216 |
|
2217 | </dl>
|
2218 |
|
2219 |
|
2220 |
|
2221 |
|
2222 |
|
2223 |
|
2224 |
|
2225 |
|
2226 |
|
2227 |
|
2228 |
|
2229 |
|
2230 |
|
2231 | <h5>Returns:</h5>
|
2232 |
|
2233 |
|
2234 | <div class="param-desc">
|
2235 | <p>Returns false in the case that "WakeLock" (<a href="https://developer.mozilla.org/docs/Web/API/MozWakeLock">MozWakeLock</a>) is not supported or something went wrong. Returns the "WakeLock" (<a href="https://developer.mozilla.org/docs/Web/API/MozWakeLock">MozWakeLock</a>) object in the case that we wanted to keep it awake ("keepAwake" is set to true). Returns undefined in the case that we do not want it to keep it awake ("keepAwake" is set to false and the lock is a valid "WakeLock" object).</p>
|
2236 | </div>
|
2237 |
|
2238 |
|
2239 |
|
2240 | <dl>
|
2241 | <dt>
|
2242 | Type
|
2243 | </dt>
|
2244 | <dd>
|
2245 |
|
2246 | <span class="param-type">undefined</span>
|
2247 | |
|
2248 |
|
2249 | <span class="param-type">Object</span>
|
2250 | |
|
2251 |
|
2252 | <span class="param-type">false</span>
|
2253 |
|
2254 |
|
2255 |
|
2256 | </dd>
|
2257 | </dl>
|
2258 |
|
2259 |
|
2260 |
|
2261 |
|
2262 |
|
2263 | </dd>
|
2264 |
|
2265 | </dl>
|
2266 |
|
2267 |
|
2268 |
|
2269 |
|
2270 |
|
2271 | </article>
|
2272 |
|
2273 | </section>
|
2274 |
|
2275 |
|
2276 |
|
2277 |
|
2278 | </div>
|
2279 | </div>
|
2280 |
|
2281 | <div class="clearfix"></div>
|
2282 |
|
2283 |
|
2284 | <div class="col-md-3">
|
2285 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
2286 | </div>
|
2287 |
|
2288 |
|
2289 | </div>
|
2290 | </div>
|
2291 |
|
2292 |
|
2293 | <div class="modal fade" id="searchResults">
|
2294 | <div class="modal-dialog">
|
2295 | <div class="modal-content">
|
2296 | <div class="modal-header">
|
2297 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
2298 | <h4 class="modal-title">Search results</h4>
|
2299 | </div>
|
2300 | <div class="modal-body"></div>
|
2301 | <div class="modal-footer">
|
2302 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
2303 | </div>
|
2304 | </div>
|
2305 | </div>
|
2306 | </div>
|
2307 |
|
2308 |
|
2309 | <footer>
|
2310 |
|
2311 |
|
2312 | <span class="copyright">
|
2313 | <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
|
2314 | </span>
|
2315 |
|
2316 | <span class="jsdoc-message">
|
2317 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
2318 |
|
2319 | on Mon Feb 3rd 2020
|
2320 |
|
2321 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
2322 | </span>
|
2323 | </footer>
|
2324 |
|
2325 | <script src="scripts/docstrap.lib.js"></script>
|
2326 | <script src="scripts/toc.js"></script>
|
2327 |
|
2328 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
2329 |
|
2330 |
|
2331 | <script>
|
2332 | $( function () {
|
2333 | $( "[id*='$']" ).each( function () {
|
2334 | var $this = $( this );
|
2335 |
|
2336 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
2337 | } );
|
2338 |
|
2339 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
2340 | var $this = $( this );
|
2341 |
|
2342 | var example = $this.find( "code" );
|
2343 | exampleText = example.html();
|
2344 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
2345 | if ( lang && lang[1] ) {
|
2346 | exampleText = exampleText.replace( lang[0], "" );
|
2347 | example.html( exampleText );
|
2348 | lang = lang[1];
|
2349 | } else {
|
2350 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
2351 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
2352 | }
|
2353 |
|
2354 | if ( lang ) {
|
2355 |
|
2356 | $this
|
2357 | .addClass( "sunlight-highlight-" + lang )
|
2358 | .addClass( "linenums" )
|
2359 | .html( example.html() );
|
2360 |
|
2361 | }
|
2362 | } );
|
2363 |
|
2364 | Sunlight.highlightAll( {
|
2365 | lineNumbers : true,
|
2366 | showMenu : true,
|
2367 | enableDoclinks : true
|
2368 | } );
|
2369 |
|
2370 | $.catchAnchorLinks( {
|
2371 | navbarOffset: 10
|
2372 | } );
|
2373 | $( "#toc" ).toc( {
|
2374 | anchorName : function ( i, heading, prefix ) {
|
2375 | return $( heading ).attr( "id" ) || ( prefix + i );
|
2376 | },
|
2377 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
2378 | showAndHide : false,
|
2379 | smoothScrolling: true
|
2380 | } );
|
2381 |
|
2382 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
2383 | $( '.dropdown-toggle' ).dropdown();
|
2384 |
|
2385 | $( "table" ).each( function () {
|
2386 | var $this = $( this );
|
2387 | $this.addClass('table');
|
2388 | } );
|
2389 |
|
2390 | } );
|
2391 | </script>
|
2392 |
|
2393 |
|
2394 |
|
2395 |
|
2396 |
|
2397 | <script>
|
2398 | $( function () {
|
2399 | $( '#main' ).localScroll( {
|
2400 | offset : { top : 60 }
|
2401 | } );
|
2402 | $( "dt.name" ).each( function () {
|
2403 | var $this = $( this ).find("h4");
|
2404 | var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
|
2405 | var dt = $(this);
|
2406 | var children = dt.next( "dd" );
|
2407 |
|
2408 | dt.prepend( icon ).css( {cursor : "pointer"} );
|
2409 | dt.addClass( "member-collapsed" ).addClass( "member" );
|
2410 |
|
2411 |
|
2412 | children.hide();
|
2413 |
|
2414 | dt.children().on( "click", function () {
|
2415 | children = dt.next( "dd" );
|
2416 | children.slideToggle( "fast", function () {
|
2417 |
|
2418 | if ( children.is( ":visible" ) ) {
|
2419 | icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
|
2420 | dt.addClass( "member-open" ).animate( "member-collapsed" );
|
2421 | } else {
|
2422 | icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
|
2423 | dt.addClass( "member-collapsed" ).removeClass( "member-open" );
|
2424 | }
|
2425 | } );
|
2426 | } );
|
2427 |
|
2428 | } );
|
2429 | } );
|
2430 | </script>
|
2431 |
|
2432 |
|
2433 |
|
2434 |
|
2435 |
|
2436 |
|
2437 | <script type="text/javascript">
|
2438 | $(document).ready(function() {
|
2439 | SearcherDisplay.init();
|
2440 | });
|
2441 | </script>
|
2442 |
|
2443 |
|
2444 | </body>
|
2445 | </html> |
\ | No newline at end of file |