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: Vibration</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: Vibration</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 | Vibration
|
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 vibration. 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-1014">line 1014</a>
|
143 | </li>
|
144 | </ul>
|
145 | </dd>
|
146 |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 | </dl>
|
154 |
|
155 |
|
156 |
|
157 |
|
158 | </div>
|
159 |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 |
|
165 |
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 | <h3 class="subsection-title">Methods</h3>
|
174 |
|
175 | <dl>
|
176 |
|
177 | <hr>
|
178 | <dt>
|
179 | <h4 class="name" id=".isSupported"><span class="type-signature"><static> </span>isSupported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
180 |
|
181 |
|
182 | </dt>
|
183 | <dd>
|
184 |
|
185 |
|
186 | <div class="description">
|
187 | <p>Tells whether the <a href="https://developer.mozilla.org/docs/Web/API/Vibration_API">Vibration API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-vibration">Apache Cordova's Vibration plugin</a>) is available or not.</p>
|
188 | </div>
|
189 |
|
190 |
|
191 |
|
192 |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |
|
199 | <dl class="details">
|
200 |
|
201 |
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
230 | <dd class="tag-source">
|
231 | <ul class="dummy">
|
232 | <li>
|
233 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
234 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-1021">line 1021</a>
|
235 | </li>
|
236 | </ul>
|
237 | </dd>
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 | </dl>
|
246 |
|
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 |
|
259 | <h5>Returns:</h5>
|
260 |
|
261 |
|
262 |
|
263 |
|
264 | <dl>
|
265 | <dt>
|
266 | Type
|
267 | </dt>
|
268 | <dd>
|
269 |
|
270 | <span class="param-type">boolean</span>
|
271 |
|
272 |
|
273 |
|
274 | </dd>
|
275 | </dl>
|
276 |
|
277 |
|
278 |
|
279 |
|
280 |
|
281 | </dd>
|
282 |
|
283 |
|
284 |
|
285 | <hr>
|
286 | <dt>
|
287 | <h4 class="name" id=".start"><span class="type-signature"><static> </span>start<span class="signature">( [vibration])</span><span class="type-signature"> → {undefined|false}</span></h4>
|
288 |
|
289 |
|
290 | </dt>
|
291 | <dd>
|
292 |
|
293 |
|
294 | <div class="description">
|
295 | <p>Makes the device vibrate using the <a href="https://developer.mozilla.org/docs/Web/API/Vibration_API">Vibration API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-vibration">Apache Cordova's Vibration plugin</a>).</p>
|
296 | </div>
|
297 |
|
298 |
|
299 |
|
300 |
|
301 |
|
302 |
|
303 |
|
304 |
|
305 | <h5>Parameters:</h5>
|
306 |
|
307 |
|
308 | <table class="params table table-striped">
|
309 | <thead>
|
310 | <tr>
|
311 |
|
312 | <th style="width:12%; min-width:110px;">Name</th>
|
313 |
|
314 |
|
315 | <th style="width:12%; min-width:110px;">Type</th>
|
316 |
|
317 |
|
318 | <th style="width:12%; min-width:110px;">Argument</th>
|
319 |
|
320 |
|
321 |
|
322 |
|
323 | <th class="last" style="min-width:310px;">Description</th>
|
324 | </tr>
|
325 | </thead>
|
326 |
|
327 | <tbody>
|
328 |
|
329 |
|
330 | <tr>
|
331 |
|
332 | <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>vibration</code></td>
|
333 |
|
334 |
|
335 | <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;">
|
336 |
|
337 |
|
338 | <span class="param-type">integer</span>
|
339 | |
|
340 |
|
341 | <span class="param-type">array</span>
|
342 |
|
343 |
|
344 |
|
345 |
|
346 | </td>
|
347 |
|
348 |
|
349 | <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;">
|
350 |
|
351 | <optional><br>
|
352 |
|
353 |
|
354 |
|
355 |
|
356 |
|
357 | </td>
|
358 |
|
359 |
|
360 |
|
361 |
|
362 | <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 vibration pattern which can be either a single integer value or an array of integers. Following the same rules as the first parameter of the native <a href="https://developer.mozilla.org/docs/Web/API/Navigator/vibrate">vibrate</a> function.</p></td>
|
363 | </tr>
|
364 |
|
365 |
|
366 | </tbody>
|
367 | </table>
|
368 |
|
369 |
|
370 |
|
371 |
|
372 | <dl class="details">
|
373 |
|
374 |
|
375 |
|
376 |
|
377 |
|
378 |
|
379 |
|
380 |
|
381 |
|
382 |
|
383 |
|
384 |
|
385 |
|
386 |
|
387 |
|
388 |
|
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 |
|
401 |
|
402 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
403 | <dd class="tag-source">
|
404 | <ul class="dummy">
|
405 | <li>
|
406 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
407 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-1033">line 1033</a>
|
408 | </li>
|
409 | </ul>
|
410 | </dd>
|
411 |
|
412 |
|
413 |
|
414 |
|
415 |
|
416 |
|
417 |
|
418 | </dl>
|
419 |
|
420 |
|
421 |
|
422 |
|
423 |
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 |
|
430 |
|
431 |
|
432 | <h5>Returns:</h5>
|
433 |
|
434 |
|
435 | <div class="param-desc">
|
436 | <p>Returns false in the case that <a href="https://developer.mozilla.org/docs/Web/API/Vibration_API">Vibration API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-vibration">Apache Cordova's Vibration plugin</a>) cannot be used or undefined otherwise.</p>
|
437 | </div>
|
438 |
|
439 |
|
440 |
|
441 | <dl>
|
442 | <dt>
|
443 | Type
|
444 | </dt>
|
445 | <dd>
|
446 |
|
447 | <span class="param-type">undefined</span>
|
448 | |
|
449 |
|
450 | <span class="param-type">false</span>
|
451 |
|
452 |
|
453 |
|
454 | </dd>
|
455 | </dl>
|
456 |
|
457 |
|
458 |
|
459 |
|
460 |
|
461 | </dd>
|
462 |
|
463 |
|
464 |
|
465 | <hr>
|
466 | <dt>
|
467 | <h4 class="name" id=".stop"><span class="type-signature"><static> </span>stop<span class="signature">()</span><span class="type-signature"> → {undefined|false}</span></h4>
|
468 |
|
469 |
|
470 | </dt>
|
471 | <dd>
|
472 |
|
473 |
|
474 | <div class="description">
|
475 | <p>Makes the device stop vibrating using the <a href="https://developer.mozilla.org/docs/Web/API/Vibration_API">Vibration API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-vibration">Apache Cordova's Vibration plugin</a>).</p>
|
476 | </div>
|
477 |
|
478 |
|
479 |
|
480 |
|
481 |
|
482 |
|
483 |
|
484 |
|
485 |
|
486 |
|
487 | <dl class="details">
|
488 |
|
489 |
|
490 |
|
491 |
|
492 |
|
493 |
|
494 |
|
495 |
|
496 |
|
497 |
|
498 |
|
499 |
|
500 |
|
501 |
|
502 |
|
503 |
|
504 |
|
505 |
|
506 |
|
507 |
|
508 |
|
509 |
|
510 |
|
511 |
|
512 |
|
513 |
|
514 |
|
515 |
|
516 |
|
517 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
518 | <dd class="tag-source">
|
519 | <ul class="dummy">
|
520 | <li>
|
521 | <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
|
522 | <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-1049">line 1049</a>
|
523 | </li>
|
524 | </ul>
|
525 | </dd>
|
526 |
|
527 |
|
528 |
|
529 |
|
530 |
|
531 |
|
532 |
|
533 | </dl>
|
534 |
|
535 |
|
536 |
|
537 |
|
538 |
|
539 |
|
540 |
|
541 |
|
542 |
|
543 |
|
544 |
|
545 |
|
546 |
|
547 | <h5>Returns:</h5>
|
548 |
|
549 |
|
550 | <div class="param-desc">
|
551 | <p>Returns false in the case that <a href="https://developer.mozilla.org/docs/Web/API/Vibration_API">Vibration API</a> (or compatible one as <a href="https://github.com/apache/cordova-plugin-vibration">Apache Cordova's Vibration plugin</a>) cannot be used or undefined otherwise.</p>
|
552 | </div>
|
553 |
|
554 |
|
555 |
|
556 | <dl>
|
557 | <dt>
|
558 | Type
|
559 | </dt>
|
560 | <dd>
|
561 |
|
562 | <span class="param-type">undefined</span>
|
563 | |
|
564 |
|
565 | <span class="param-type">false</span>
|
566 |
|
567 |
|
568 |
|
569 | </dd>
|
570 | </dl>
|
571 |
|
572 |
|
573 |
|
574 |
|
575 |
|
576 | </dd>
|
577 |
|
578 | </dl>
|
579 |
|
580 |
|
581 |
|
582 |
|
583 |
|
584 | </article>
|
585 |
|
586 | </section>
|
587 |
|
588 |
|
589 |
|
590 |
|
591 | </div>
|
592 | </div>
|
593 |
|
594 | <div class="clearfix"></div>
|
595 |
|
596 |
|
597 | <div class="col-md-3">
|
598 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
599 | </div>
|
600 |
|
601 |
|
602 | </div>
|
603 | </div>
|
604 |
|
605 |
|
606 | <div class="modal fade" id="searchResults">
|
607 | <div class="modal-dialog">
|
608 | <div class="modal-content">
|
609 | <div class="modal-header">
|
610 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
611 | <h4 class="modal-title">Search results</h4>
|
612 | </div>
|
613 | <div class="modal-body"></div>
|
614 | <div class="modal-footer">
|
615 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
616 | </div>
|
617 | </div>
|
618 | </div>
|
619 | </div>
|
620 |
|
621 |
|
622 | <footer>
|
623 |
|
624 |
|
625 | <span class="copyright">
|
626 | <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>
|
627 | </span>
|
628 |
|
629 | <span class="jsdoc-message">
|
630 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
631 |
|
632 | on Mon Feb 3rd 2020
|
633 |
|
634 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
635 | </span>
|
636 | </footer>
|
637 |
|
638 | <script src="scripts/docstrap.lib.js"></script>
|
639 | <script src="scripts/toc.js"></script>
|
640 |
|
641 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
642 |
|
643 |
|
644 | <script>
|
645 | $( function () {
|
646 | $( "[id*='$']" ).each( function () {
|
647 | var $this = $( this );
|
648 |
|
649 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
650 | } );
|
651 |
|
652 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
653 | var $this = $( this );
|
654 |
|
655 | var example = $this.find( "code" );
|
656 | exampleText = example.html();
|
657 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
658 | if ( lang && lang[1] ) {
|
659 | exampleText = exampleText.replace( lang[0], "" );
|
660 | example.html( exampleText );
|
661 | lang = lang[1];
|
662 | } else {
|
663 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
664 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
665 | }
|
666 |
|
667 | if ( lang ) {
|
668 |
|
669 | $this
|
670 | .addClass( "sunlight-highlight-" + lang )
|
671 | .addClass( "linenums" )
|
672 | .html( example.html() );
|
673 |
|
674 | }
|
675 | } );
|
676 |
|
677 | Sunlight.highlightAll( {
|
678 | lineNumbers : true,
|
679 | showMenu : true,
|
680 | enableDoclinks : true
|
681 | } );
|
682 |
|
683 | $.catchAnchorLinks( {
|
684 | navbarOffset: 10
|
685 | } );
|
686 | $( "#toc" ).toc( {
|
687 | anchorName : function ( i, heading, prefix ) {
|
688 | return $( heading ).attr( "id" ) || ( prefix + i );
|
689 | },
|
690 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
691 | showAndHide : false,
|
692 | smoothScrolling: true
|
693 | } );
|
694 |
|
695 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
696 | $( '.dropdown-toggle' ).dropdown();
|
697 |
|
698 | $( "table" ).each( function () {
|
699 | var $this = $( this );
|
700 | $this.addClass('table');
|
701 | } );
|
702 |
|
703 | } );
|
704 | </script>
|
705 |
|
706 |
|
707 |
|
708 |
|
709 |
|
710 | <script>
|
711 | $( function () {
|
712 | $( '#main' ).localScroll( {
|
713 | offset : { top : 60 }
|
714 | } );
|
715 | $( "dt.name" ).each( function () {
|
716 | var $this = $( this ).find("h4");
|
717 | var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
|
718 | var dt = $(this);
|
719 | var children = dt.next( "dd" );
|
720 |
|
721 | dt.prepend( icon ).css( {cursor : "pointer"} );
|
722 | dt.addClass( "member-collapsed" ).addClass( "member" );
|
723 |
|
724 |
|
725 | children.hide();
|
726 |
|
727 | dt.children().on( "click", function () {
|
728 | children = dt.next( "dd" );
|
729 | children.slideToggle( "fast", function () {
|
730 |
|
731 | if ( children.is( ":visible" ) ) {
|
732 | icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
|
733 | dt.addClass( "member-open" ).animate( "member-collapsed" );
|
734 | } else {
|
735 | icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
|
736 | dt.addClass( "member-collapsed" ).removeClass( "member-open" );
|
737 | }
|
738 | } );
|
739 | } );
|
740 |
|
741 | } );
|
742 | } );
|
743 | </script>
|
744 |
|
745 |
|
746 |
|
747 |
|
748 |
|
749 |
|
750 | <script type="text/javascript">
|
751 | $(document).ready(function() {
|
752 | SearcherDisplay.init();
|
753 | });
|
754 | </script>
|
755 |
|
756 |
|
757 | </body>
|
758 | </html> |
\ | No newline at end of file |