UNPKG

118 kBHTMLView Raw
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: CB_Client</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
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: CB_Client</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_Client
91 </h2>
92
93
94</header>
95
96
97<article>
98 <div class="container-overview">
99
100
101 <div class="description"><p>Static class to manage the current client. It will return itself if it is tried to be instantiated. It can use <a href="https://quirksmode.org/js/detect.html">BrowserDetect</a> (<a href="https://gist.github.com/mitchellhislop/2018348">source code rescued</a>).</p></div>
102
103
104
105<dl class="details">
106
107
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 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
136 <dd class="tag-source">
137 <ul class="dummy">
138 <li>
139 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
140 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-14">line 14</a>
141 </li>
142 </ul>
143 </dd>
144
145
146
147
148
149
150
151 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
152 <dd class="tag-todo">
153 <ul>
154 <li>Think about implementing a getDocumentParents function (similar to <a href="CB_Client.html#.getWindowParents"><code>CB_Client.getWindowParents</code></a>).</li>
155
156 <li>Think about implementing "onClose" event (to fire when app/web is going to be closed).</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
179
180 <h3 class="subsection-title">Methods</h3>
181
182 <dl>
183
184<hr>
185<dt>
186 <h4 class="name" id=".exit"><span class="type-signature">&lt;static> </span>exit<span class="signature">( [allowWindowCloseFallback] [, allowRedirectionFallback] [, redirectionAddress])</span><span class="type-signature"></span></h4>
187
188
189</dt>
190<dd>
191
192
193 <div class="description">
194 <p>Exits and finishes the script. In a browser, it will try to close the window or at least abandon it redirecting to an empty one (or to a desired URL). In an app (<a href="https://nwjs.io/">NW.js (formerly node-webkit)</a>/<a href="https://electronjs.org/">Electron (Electron.js)</a>/<a href="https://cordova.apache.org/">Apache Cordova</a>/<a href="https://phonegap.com/">Adobe PhoneGap</a>/<a href="https://en.wikipedia.org/wiki/Appcelerator_Titanium">Appcelerator Titanium SDK</a>/<a href="https://github.com/appcelerator-archive/titanium_desktop">Appcelerator TideSDK (Titanium Desktop)</a>/<a href="https://en.wikipedia.org/wiki/WeChat">Weixin (WeChat)</a>/etc.), it will try to close the app.</p>
195 </div>
196
197
198
199
200
201
202
203
204 <h5>Parameters:</h5>
205
206
207<table class="params table table-striped">
208 <thead>
209 <tr>
210
211 <th style="width:12%; min-width:110px;">Name</th>
212
213
214 <th style="width:12%; min-width:110px;">Type</th>
215
216
217 <th style="width:12%; min-width:110px;">Argument</th>
218
219
220
221 <th style="width:12%; min-width:110px;">Default</th>
222
223
224 <th class="last" style="min-width:310px;">Description</th>
225 </tr>
226 </thead>
227
228 <tbody>
229
230
231 <tr>
232
233 <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>allowWindowCloseFallback</code></td>
234
235
236 <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;">
237
238
239<span class="param-type">boolean</span>
240
241
242
243
244 </td>
245
246
247 <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;">
248
249 &lt;optional><br>
250
251
252
253
254
255 </td>
256
257
258
259 <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;">
260
261 true
262
263 </td>
264
265
266 <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 to allow using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/close">window.close</a> method as a fallback.</p></td>
267 </tr>
268
269
270
271 <tr>
272
273 <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>allowRedirectionFallback</code></td>
274
275
276 <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;">
277
278
279<span class="param-type">boolean</span>
280
281
282
283
284 </td>
285
286
287 <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;">
288
289 &lt;optional><br>
290
291
292
293
294
295 </td>
296
297
298
299 <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;">
300
301 true
302
303 </td>
304
305
306 <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 to redirect the current client as a fallback (to the URL defined in the &quot;redirectionAddress&quot; parameter).</p></td>
307 </tr>
308
309
310
311 <tr>
312
313 <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>redirectionAddress</code></td>
314
315
316 <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;">
317
318
319<span class="param-type">boolean</span>
320
321
322
323
324 </td>
325
326
327 <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;">
328
329 &lt;optional><br>
330
331
332
333
334
335 </td>
336
337
338
339 <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;">
340
341 'about:blank'
342
343 </td>
344
345
346 <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 the URL where the current client will be redirected to in the case that the window cannot be closed. Only used if the &quot;allowRedirectionFallback&quot; parameter is set to true.</p></td>
347 </tr>
348
349
350 </tbody>
351</table>
352
353
354
355
356<dl class="details">
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
387 <dd class="tag-source">
388 <ul class="dummy">
389 <li>
390 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
391 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-557">line 557</a>
392 </li>
393 </ul>
394 </dd>
395
396
397
398
399
400
401
402 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
403 <dd class="tag-todo">
404 <ul>
405 <li>Have in mind iframes (think about it).</li>
406 </ul>
407 </dd>
408
409</dl>
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425</dd>
426
427
428
429<hr>
430<dt>
431 <h4 class="name" id=".get"><span class="type-signature">&lt;static> </span>get<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
432
433
434</dt>
435<dd>
436
437
438 <div class="description">
439 <p>Returns the current web client (if possible) as a string. It uses <a href="https://quirksmode.org/js/detect.html">BrowserDetect</a> (<a href="https://gist.github.com/mitchellhislop/2018348">source code rescued</a>) internally.</p>
440 </div>
441
442
443
444
445
446
447
448
449
450
451<dl class="details">
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
482 <dd class="tag-source">
483 <ul class="dummy">
484 <li>
485 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
486 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-107">line 107</a>
487 </li>
488 </ul>
489 </dd>
490
491
492
493
494
495
496
497</dl>
498
499
500
501
502
503
504
505
506
507
508
509
510
511 <h5>Returns:</h5>
512
513
514
515
516<dl>
517 <dt>
518 Type
519 </dt>
520 <dd>
521
522<span class="param-type">string</span>
523
524
525
526 </dd>
527</dl>
528
529
530
531
532
533</dd>
534
535
536
537<hr>
538<dt>
539 <h4 class="name" id=".getAddressWithoutFile"><span class="type-signature">&lt;static> </span>getAddressWithoutFile<span class="signature">(address [, fallbackURL] [, allowsLocal])</span><span class="type-signature"> &rarr; {string}</span></h4>
540
541
542</dt>
543<dd>
544
545
546 <div class="description">
547 <p>Returns the given address without the file (for example, if &quot;http://whatever.com/index.html&quot; is given, it will return &quot;http://whatever.com/&quot;).</p>
548 </div>
549
550
551
552
553
554
555
556
557 <h5>Parameters:</h5>
558
559
560<table class="params table table-striped">
561 <thead>
562 <tr>
563
564 <th style="width:12%; min-width:110px;">Name</th>
565
566
567 <th style="width:12%; min-width:110px;">Type</th>
568
569
570 <th style="width:12%; min-width:110px;">Argument</th>
571
572
573
574 <th style="width:12%; min-width:110px;">Default</th>
575
576
577 <th class="last" style="min-width:310px;">Description</th>
578 </tr>
579 </thead>
580
581 <tbody>
582
583
584 <tr>
585
586 <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>address</code></td>
587
588
589 <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;">
590
591
592<span class="param-type">string</span>
593
594
595
596
597 </td>
598
599
600 <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;">
601
602
603
604
605
606 </td>
607
608
609
610 <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;">
611
612 </td>
613
614
615 <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 address that we want to filter.</p></td>
616 </tr>
617
618
619
620 <tr>
621
622 <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>fallbackURL</code></td>
623
624
625 <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;">
626
627
628<span class="param-type">string</span>
629
630
631
632
633 </td>
634
635
636 <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;">
637
638 &lt;optional><br>
639
640
641
642
643
644 </td>
645
646
647
648 <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;">
649
650 </td>
651
652
653 <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 address that we want it to return in the case that the given one is not allowed (used when &quot;allowsLocal&quot; does not allow a local address). If it contains a file, it will not be stripped out.</p></td>
654 </tr>
655
656
657
658 <tr>
659
660 <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>allowsLocal</code></td>
661
662
663 <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;">
664
665
666<span class="param-type">boolean</span>
667
668
669
670
671 </td>
672
673
674 <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;">
675
676 &lt;optional><br>
677
678
679
680
681
682 </td>
683
684
685
686 <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;">
687
688 true
689
690 </td>
691
692
693 <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 to allow returning a local address or not. If it is set to false and the address is local, it will return the &quot;fallbackURL&quot; instead (without stripping out the file, if any).</p></td>
694 </tr>
695
696
697 </tbody>
698</table>
699
700
701
702
703<dl class="details">
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
734 <dd class="tag-source">
735 <ul class="dummy">
736 <li>
737 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
738 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-762">line 762</a>
739 </li>
740 </ul>
741 </dd>
742
743
744
745
746
747
748
749</dl>
750
751
752
753
754
755
756
757
758
759
760
761
762
763 <h5>Returns:</h5>
764
765
766
767
768<dl>
769 <dt>
770 Type
771 </dt>
772 <dd>
773
774<span class="param-type">string</span>
775
776
777
778 </dd>
779</dl>
780
781
782
783
784
785</dd>
786
787
788
789<hr>
790<dt>
791 <h4 class="name" id=".getBoundingClientRectMargin"><span class="type-signature">&lt;static> </span>getBoundingClientRectMargin<span class="signature">( [leftOrTop])</span><span class="type-signature"> &rarr; {integer}</span></h4>
792
793
794</dt>
795<dd>
796
797
798 <div class="description">
799 <p>Gets the starting pixel of top or left coordinates for <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect">getBoundingClientRect</a> (it's not 0 in some Internet Explorer versions).</p>
800 </div>
801
802
803
804
805
806
807
808
809 <h5>Parameters:</h5>
810
811
812<table class="params table table-striped">
813 <thead>
814 <tr>
815
816 <th style="width:12%; min-width:110px;">Name</th>
817
818
819 <th style="width:12%; min-width:110px;">Type</th>
820
821
822 <th style="width:12%; min-width:110px;">Argument</th>
823
824
825
826 <th style="width:12%; min-width:110px;">Default</th>
827
828
829 <th class="last" style="min-width:310px;">Description</th>
830 </tr>
831 </thead>
832
833 <tbody>
834
835
836 <tr>
837
838 <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>leftOrTop</code></td>
839
840
841 <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;">
842
843
844<span class="param-type">'left'</span>
845|
846
847<span class="param-type">'top'</span>
848
849
850
851
852 </td>
853
854
855 <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;">
856
857 &lt;optional><br>
858
859
860
861
862
863 </td>
864
865
866
867 <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;">
868
869 'left'
870
871 </td>
872
873
874 <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>String that defines whether we want it to return the values for &quot;left&quot; or for &quot;top&quot;.</p></td>
875 </tr>
876
877
878 </tbody>
879</table>
880
881
882
883
884<dl class="details">
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
915 <dd class="tag-source">
916 <ul class="dummy">
917 <li>
918 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
919 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-798">line 798</a>
920 </li>
921 </ul>
922 </dd>
923
924
925
926
927
928
929
930</dl>
931
932
933
934
935
936
937
938
939
940
941
942
943
944 <h5>Returns:</h5>
945
946
947
948
949<dl>
950 <dt>
951 Type
952 </dt>
953 <dd>
954
955<span class="param-type">integer</span>
956
957
958
959 </dd>
960</dl>
961
962
963
964
965
966</dd>
967
968
969
970<hr>
971<dt>
972 <h4 class="name" id=".getBrowser"><span class="type-signature">&lt;static> </span>getBrowser<span class="signature">()</span><span class="type-signature"></span></h4>
973
974
975</dt>
976<dd>
977
978
979 <div class="description">
980 <p>Alias for <a href="CB_Client.html#.get"><code>CB_Client.get</code></a>.</p>
981 </div>
982
983
984
985
986
987
988
989
990
991
992<dl class="details">
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1023 <dd class="tag-source">
1024 <ul class="dummy">
1025 <li>
1026 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
1027 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-97">line 97</a>
1028 </li>
1029 </ul>
1030 </dd>
1031
1032
1033
1034
1035
1036 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1037 <dd class="tag-see">
1038 <ul>
1039 <li><a href="CB_Client.html#.get"><code>CB_Client.get</code></a></li>
1040 </ul>
1041 </dd>
1042
1043
1044
1045</dl>
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061</dd>
1062
1063
1064
1065<hr>
1066<dt>
1067 <h4 class="name" id=".getBrowserVersion"><span class="type-signature">&lt;static> </span>getBrowserVersion<span class="signature">()</span><span class="type-signature"></span></h4>
1068
1069
1070</dt>
1071<dd>
1072
1073
1074 <div class="description">
1075 <p>Alias for <a href="CB_Client.html#.getVersion"><code>CB_Client.getVersion</code></a>.</p>
1076 </div>
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087<dl class="details">
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1118 <dd class="tag-source">
1119 <ul class="dummy">
1120 <li>
1121 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
1122 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-113">line 113</a>
1123 </li>
1124 </ul>
1125 </dd>
1126
1127
1128
1129
1130
1131 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1132 <dd class="tag-see">
1133 <ul>
1134 <li><a href="CB_Client.html#.getVersion"><code>CB_Client.getVersion</code></a></li>
1135 </ul>
1136 </dd>
1137
1138
1139
1140</dl>
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156</dd>
1157
1158
1159
1160<hr>
1161<dt>
1162 <h4 class="name" id=".getBrowserVersionMain"><span class="type-signature">&lt;static> </span>getBrowserVersionMain<span class="signature">()</span><span class="type-signature"></span></h4>
1163
1164
1165</dt>
1166<dd>
1167
1168
1169 <div class="description">
1170 <p>Alias for <a href="CB_Client.html#.getVersionMain"><code>CB_Client.getVersionMain</code></a>.</p>
1171 </div>
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182<dl class="details">
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1213 <dd class="tag-source">
1214 <ul class="dummy">
1215 <li>
1216 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
1217 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-129">line 129</a>
1218 </li>
1219 </ul>
1220 </dd>
1221
1222
1223
1224
1225
1226 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1227 <dd class="tag-see">
1228 <ul>
1229 <li><a href="CB_Client.html#.getVersionMain"><code>CB_Client.getVersionMain</code></a></li>
1230 </ul>
1231 </dd>
1232
1233
1234
1235</dl>
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251</dd>
1252
1253
1254
1255<hr>
1256<dt>
1257 <h4 class="name" id=".getButtonsDown"><span class="type-signature">&lt;static> </span>getButtonsDown<span class="signature">()</span><span class="type-signature"></span></h4>
1258
1259
1260</dt>
1261<dd>
1262
1263
1264 <div class="description">
1265 <p>Alias for <code>CB_Client.getButtons</code>.</p>
1266 </div>
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277<dl class="details">
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1308 <dd class="tag-source">
1309 <ul class="dummy">
1310 <li>
1311 <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
1312 <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-291">line 291</a>
1313 </li>
1314 </ul>
1315 </dd>
1316
1317
1318
1319
1320
1321 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1322 <dd class="tag-see">
1323 <ul>
1324 <li><code>CB_Client.getButtons</code></li>
1325 </ul>
1326 </dd>
1327
1328
1329
1330</dl>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346</dd>
1347
1348
1349
1350<hr>
1351<dt>
1352 <h4 class="name" id=".getDocument"><span class="type-signature">&lt;static> </span>getDocument<span class="signature">( [mindIframes])</span><span class="type-signature"> &rarr; {Object}</span></h4>
1353
1354
1355</dt>
1356<dd>
1357
1358
1359 <div class="description">
1360 <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/document">document</a> object (having in mind whether the script is running in one <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more, if we want).</p>
1361 </div>
1362
1363
1364
1365
1366
1367
1368
1369
1370 <h5>Parameters:</h5>
1371
1372
1373<table class="params table table-striped">
1374 <thead>
1375 <tr>
1376
1377 <th style="width:12%; min-width:110px;">Name</th>
1378
1379
1380 <th style="width:12%; min-width:110px;">Type</th>
1381
1382
1383 <th style="width:12%; min-width:110px;">Argument</th>
1384
1385
1386
1387 <th style="width:12%; min-width:110px;">Default</th>
1388
1389
1390 <th class="last" style="min-width:310px;">Description</th>
1391 </tr>
1392 </thead>
1393
1394 <tbody>
1395
1396
1397 <tr>
1398
1399 <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>mindIframes</code></td>
1400
1401
1402 <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;">
1403
1404
1405<span class="param-type">boolean</span>
1406
1407
1408
1409
1410 </td>
1411
1412
1413 <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;">
1414
1415 &lt;optional><br>
1416
1417
1418
1419
1420
1421 </td>
1422
1423
1424
1425 <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;">
1426
1427 <a href="CB_Configuration.CrossBase.html#.MIND_IFRAMES"><code>CB_Configuration.CrossBase.MIND_IFRAMES</code></a>
1428
1429 </td>
1430
1431
1432 <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 set to true, it will try to get and return the topmost <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/document">document</a> object. Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p></td>
1433 </tr>
1434
1435
1436 </tbody>
1437</table>
1438
1439
1440
1441
1442<dl class="details">
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1473 <dd class="tag-source">
1474 <ul class="dummy">
1475 <li>
1476 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
1477 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-264">line 264</a>
1478 </li>
1479 </ul>
1480 </dd>
1481
1482
1483
1484
1485
1486
1487
1488</dl>
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502 <h5>Returns:</h5>
1503
1504
1505
1506
1507<dl>
1508 <dt>
1509 Type
1510 </dt>
1511 <dd>
1512
1513<span class="param-type">Object</span>
1514
1515
1516
1517 </dd>
1518</dl>
1519
1520
1521
1522
1523
1524</dd>
1525
1526
1527
1528<hr>
1529<dt>
1530 <h4 class="name" id=".getDocumentBase"><span class="type-signature">&lt;static> </span>getDocumentBase<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
1531
1532
1533</dt>
1534<dd>
1535
1536
1537 <div class="description">
1538 <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/document">document</a> object of the first parent (the topmost one). Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p>
1539 </div>
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550<dl class="details">
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1581 <dd class="tag-source">
1582 <ul class="dummy">
1583 <li>
1584 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
1585 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-246">line 246</a>
1586 </li>
1587 </ul>
1588 </dd>
1589
1590
1591
1592
1593
1594
1595
1596</dl>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610 <h5>Returns:</h5>
1611
1612
1613
1614
1615<dl>
1616 <dt>
1617 Type
1618 </dt>
1619 <dd>
1620
1621<span class="param-type">Object</span>
1622
1623
1624
1625 </dd>
1626</dl>
1627
1628
1629
1630
1631
1632</dd>
1633
1634
1635
1636<hr>
1637<dt>
1638 <h4 class="name" id=".getFlashVersion"><span class="type-signature">&lt;static> </span>getFlashVersion<span class="signature">( [asString])</span><span class="type-signature"> &rarr; {array|string}</span></h4>
1639
1640
1641</dt>
1642<dd>
1643
1644
1645 <div class="description">
1646 <p>Returns the available version of <a href="https://en.wikipedia.org/wiki/Adobe_Flash_Player">Adobe Flash (formerly Macromedia Flash)</a> plugin, if any, as either an array of strings or as a string.</p>
1647 </div>
1648
1649
1650
1651
1652
1653
1654
1655
1656 <h5>Parameters:</h5>
1657
1658
1659<table class="params table table-striped">
1660 <thead>
1661 <tr>
1662
1663 <th style="width:12%; min-width:110px;">Name</th>
1664
1665
1666 <th style="width:12%; min-width:110px;">Type</th>
1667
1668
1669 <th style="width:12%; min-width:110px;">Argument</th>
1670
1671
1672
1673 <th style="width:12%; min-width:110px;">Default</th>
1674
1675
1676 <th class="last" style="min-width:310px;">Description</th>
1677 </tr>
1678 </thead>
1679
1680 <tbody>
1681
1682
1683 <tr>
1684
1685 <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>asString</code></td>
1686
1687
1688 <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;">
1689
1690
1691<span class="param-type">boolean</span>
1692
1693
1694
1695
1696 </td>
1697
1698
1699 <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;">
1700
1701 &lt;optional><br>
1702
1703
1704
1705
1706
1707 </td>
1708
1709
1710
1711 <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;">
1712
1713 false
1714
1715 </td>
1716
1717
1718 <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 set to true, returns the version as a string.</p></td>
1719 </tr>
1720
1721
1722 </tbody>
1723</table>
1724
1725
1726
1727
1728<dl class="details">
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1759 <dd class="tag-source">
1760 <ul class="dummy">
1761 <li>
1762 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
1763 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-441">line 441</a>
1764 </li>
1765 </ul>
1766 </dd>
1767
1768
1769
1770
1771
1772
1773
1774</dl>
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788 <h5>Returns:</h5>
1789
1790
1791
1792
1793<dl>
1794 <dt>
1795 Type
1796 </dt>
1797 <dd>
1798
1799<span class="param-type">array</span>
1800|
1801
1802<span class="param-type">string</span>
1803
1804
1805
1806 </dd>
1807</dl>
1808
1809
1810
1811
1812
1813</dd>
1814
1815
1816
1817<hr>
1818<dt>
1819 <h4 class="name" id=".getLanguage"><span class="type-signature">&lt;static> </span>getLanguage<span class="signature">( [allowNavigatorLanguages] [, PHPAcceptedLanguagesFirst])</span><span class="type-signature"> &rarr; {string}</span></h4>
1820
1821
1822</dt>
1823<dd>
1824
1825
1826 <div class="description">
1827 <p>Returns the most preferred language as a string.</p>
1828 </div>
1829
1830
1831
1832
1833
1834
1835
1836
1837 <h5>Parameters:</h5>
1838
1839
1840<table class="params table table-striped">
1841 <thead>
1842 <tr>
1843
1844 <th style="width:12%; min-width:110px;">Name</th>
1845
1846
1847 <th style="width:12%; min-width:110px;">Type</th>
1848
1849
1850 <th style="width:12%; min-width:110px;">Argument</th>
1851
1852
1853
1854 <th style="width:12%; min-width:110px;">Default</th>
1855
1856
1857 <th class="last" style="min-width:310px;">Description</th>
1858 </tr>
1859 </thead>
1860
1861 <tbody>
1862
1863
1864 <tr>
1865
1866 <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>allowNavigatorLanguages</code></td>
1867
1868
1869 <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;">
1870
1871
1872<span class="param-type">boolean</span>
1873
1874
1875
1876
1877 </td>
1878
1879
1880 <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;">
1881
1882 &lt;optional><br>
1883
1884
1885
1886
1887
1888 </td>
1889
1890
1891
1892 <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;">
1893
1894 <a href="CB_Configuration.CrossBase.html#.CB_Client_allowNavigatorLanguages_DEFAULT"><code>CB_Configuration.CrossBase.CB_Client_allowNavigatorLanguages_DEFAULT</code></a>
1895
1896 </td>
1897
1898
1899 <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 to allow using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/NavigatorLanguage/languages">window.navigator.languages</a> property (if not available, it will proceed normally).</p></td>
1900 </tr>
1901
1902
1903
1904 <tr>
1905
1906 <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>PHPAcceptedLanguagesFirst</code></td>
1907
1908
1909 <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;">
1910
1911
1912<span class="param-type">boolean</span>
1913
1914
1915
1916
1917 </td>
1918
1919
1920 <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;">
1921
1922 &lt;optional><br>
1923
1924
1925
1926
1927
1928 </td>
1929
1930
1931
1932 <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;">
1933
1934 <a href="CB_Configuration.CrossBase.html#.CB_Client_PHPAcceptedLanguagesFirst_DEFAULT"><code>CB_Configuration.CrossBase.CB_Client_PHPAcceptedLanguagesFirst_DEFAULT</code></a>
1935
1936 </td>
1937
1938
1939 <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 try to return the accepted languages found out by <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> (if <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> is available) in <a href="http://php.net/manual/en/reserved.variables.server.php">$_SERVER</a>['HTTP_ACCEPT_LANGUAGE'] or it will proceed normally otherwise.</p></td>
1940 </tr>
1941
1942
1943 </tbody>
1944</table>
1945
1946
1947
1948
1949<dl class="details">
1950
1951
1952
1953
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 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1980 <dd class="tag-source">
1981 <ul class="dummy">
1982 <li>
1983 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
1984 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-47">line 47</a>
1985 </li>
1986 </ul>
1987 </dd>
1988
1989
1990
1991
1992
1993
1994
1995 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1996 <dd class="tag-todo">
1997 <ul>
1998 <li>Use other back-end ways to calculate the language (using Node.js, for example).</li>
1999 </ul>
2000 </dd>
2001
2002</dl>
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016 <h5>Returns:</h5>
2017
2018
2019
2020
2021<dl>
2022 <dt>
2023 Type
2024 </dt>
2025 <dd>
2026
2027<span class="param-type">string</span>
2028
2029
2030
2031 </dd>
2032</dl>
2033
2034
2035
2036
2037
2038</dd>
2039
2040
2041
2042<hr>
2043<dt>
2044 <h4 class="name" id=".getLanguages"><span class="type-signature">&lt;static> </span>getLanguages<span class="signature">( [allowNavigatorLanguages] [, PHPAcceptedLanguagesFirst])</span><span class="type-signature"> &rarr; {array}</span></h4>
2045
2046
2047</dt>
2048<dd>
2049
2050
2051 <div class="description">
2052 <p>Returns the most preferred languages as an array of strings.</p>
2053 </div>
2054
2055
2056
2057
2058
2059
2060
2061
2062 <h5>Parameters:</h5>
2063
2064
2065<table class="params table table-striped">
2066 <thead>
2067 <tr>
2068
2069 <th style="width:12%; min-width:110px;">Name</th>
2070
2071
2072 <th style="width:12%; min-width:110px;">Type</th>
2073
2074
2075 <th style="width:12%; min-width:110px;">Argument</th>
2076
2077
2078
2079 <th style="width:12%; min-width:110px;">Default</th>
2080
2081
2082 <th class="last" style="min-width:310px;">Description</th>
2083 </tr>
2084 </thead>
2085
2086 <tbody>
2087
2088
2089 <tr>
2090
2091 <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>allowNavigatorLanguages</code></td>
2092
2093
2094 <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;">
2095
2096
2097<span class="param-type">boolean</span>
2098
2099
2100
2101
2102 </td>
2103
2104
2105 <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;">
2106
2107 &lt;optional><br>
2108
2109
2110
2111
2112
2113 </td>
2114
2115
2116
2117 <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;">
2118
2119 <a href="CB_Configuration.CrossBase.html#.CB_Client_allowNavigatorLanguages_DEFAULT"><code>CB_Configuration.CrossBase.CB_Client_allowNavigatorLanguages_DEFAULT</code></a>
2120
2121 </td>
2122
2123
2124 <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 to allow using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/NavigatorLanguage/languages">window.navigator.languages</a> property (if not available, it will proceed normally).</p></td>
2125 </tr>
2126
2127
2128
2129 <tr>
2130
2131 <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>PHPAcceptedLanguagesFirst</code></td>
2132
2133
2134 <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;">
2135
2136
2137<span class="param-type">boolean</span>
2138
2139
2140
2141
2142 </td>
2143
2144
2145 <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;">
2146
2147 &lt;optional><br>
2148
2149
2150
2151
2152
2153 </td>
2154
2155
2156
2157 <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;">
2158
2159 <a href="CB_Configuration.CrossBase.html#.CB_Client_PHPAcceptedLanguagesFirst_DEFAULT"><code>CB_Configuration.CrossBase.CB_Client_PHPAcceptedLanguagesFirst_DEFAULT</code></a>
2160
2161 </td>
2162
2163
2164 <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 try to return the accepted languages found out by <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> (if <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> is available) in <a href="http://php.net/manual/en/reserved.variables.server.php">$_SERVER</a>['HTTP_ACCEPT_LANGUAGE'] or it will proceed normally otherwise.</p></td>
2165 </tr>
2166
2167
2168 </tbody>
2169</table>
2170
2171
2172
2173
2174<dl class="details">
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
2202
2203
2204 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2205 <dd class="tag-source">
2206 <ul class="dummy">
2207 <li>
2208 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
2209 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-78">line 78</a>
2210 </li>
2211 </ul>
2212 </dd>
2213
2214
2215
2216
2217
2218
2219
2220 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
2221 <dd class="tag-todo">
2222 <ul>
2223 <li>Use other back-end ways to calculate languages (using Node.js, for example).</li>
2224 </ul>
2225 </dd>
2226
2227</dl>
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241 <h5>Returns:</h5>
2242
2243
2244
2245
2246<dl>
2247 <dt>
2248 Type
2249 </dt>
2250 <dd>
2251
2252<span class="param-type">array</span>
2253
2254
2255
2256 </dd>
2257</dl>
2258
2259
2260
2261
2262
2263</dd>
2264
2265
2266
2267<hr>
2268<dt>
2269 <h4 class="name" id=".getLocation"><span class="type-signature">&lt;static> </span>getLocation<span class="signature">( [mindIframes])</span><span class="type-signature"> &rarr; {string}</span></h4>
2270
2271
2272</dt>
2273<dd>
2274
2275
2276 <div class="description">
2277 <p>Returns the current URL, if possible (having in mind whether the script is running in one <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more, if we want).</p>
2278 </div>
2279
2280
2281
2282
2283
2284
2285
2286
2287 <h5>Parameters:</h5>
2288
2289
2290<table class="params table table-striped">
2291 <thead>
2292 <tr>
2293
2294 <th style="width:12%; min-width:110px;">Name</th>
2295
2296
2297 <th style="width:12%; min-width:110px;">Type</th>
2298
2299
2300 <th style="width:12%; min-width:110px;">Argument</th>
2301
2302
2303
2304 <th style="width:12%; min-width:110px;">Default</th>
2305
2306
2307 <th class="last" style="min-width:310px;">Description</th>
2308 </tr>
2309 </thead>
2310
2311 <tbody>
2312
2313
2314 <tr>
2315
2316 <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>mindIframes</code></td>
2317
2318
2319 <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;">
2320
2321
2322<span class="param-type">boolean</span>
2323
2324
2325
2326
2327 </td>
2328
2329
2330 <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;">
2331
2332 &lt;optional><br>
2333
2334
2335
2336
2337
2338 </td>
2339
2340
2341
2342 <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;">
2343
2344 <a href="CB_Configuration.CrossBase.html#.MIND_IFRAMES"><code>CB_Configuration.CrossBase.MIND_IFRAMES</code></a>
2345
2346 </td>
2347
2348
2349 <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 set to true, it will try to get the location of the topmost <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window">window</a> object. Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p></td>
2350 </tr>
2351
2352
2353 </tbody>
2354</table>
2355
2356
2357
2358
2359<dl class="details">
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2390 <dd class="tag-source">
2391 <ul class="dummy">
2392 <li>
2393 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
2394 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-742">line 742</a>
2395 </li>
2396 </ul>
2397 </dd>
2398
2399
2400
2401
2402
2403
2404
2405</dl>
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419 <h5>Returns:</h5>
2420
2421
2422
2423
2424<dl>
2425 <dt>
2426 Type
2427 </dt>
2428 <dd>
2429
2430<span class="param-type">string</span>
2431
2432
2433
2434 </dd>
2435</dl>
2436
2437
2438
2439
2440
2441</dd>
2442
2443
2444
2445<hr>
2446<dt>
2447 <h4 class="name" id=".getLocationWithoutFile"><span class="type-signature">&lt;static> </span>getLocationWithoutFile<span class="signature">( [fallbackURL] [, allowsLocal] [, mindIframes])</span><span class="type-signature"> &rarr; {string}</span></h4>
2448
2449
2450</dt>
2451<dd>
2452
2453
2454 <div class="description">
2455 <p>Returns the current URL without the file (for example, if &quot;http://whatever.com/index.html&quot; is the current URL, it will return &quot;http://whatever.com/&quot;), if possible (having in mind whether the script is running in one <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more, if we want).</p>
2456 </div>
2457
2458
2459
2460
2461
2462
2463
2464
2465 <h5>Parameters:</h5>
2466
2467
2468<table class="params table table-striped">
2469 <thead>
2470 <tr>
2471
2472 <th style="width:12%; min-width:110px;">Name</th>
2473
2474
2475 <th style="width:12%; min-width:110px;">Type</th>
2476
2477
2478 <th style="width:12%; min-width:110px;">Argument</th>
2479
2480
2481
2482 <th style="width:12%; min-width:110px;">Default</th>
2483
2484
2485 <th class="last" style="min-width:310px;">Description</th>
2486 </tr>
2487 </thead>
2488
2489 <tbody>
2490
2491
2492 <tr>
2493
2494 <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>fallbackURL</code></td>
2495
2496
2497 <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;">
2498
2499
2500<span class="param-type">string</span>
2501
2502
2503
2504
2505 </td>
2506
2507
2508 <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;">
2509
2510 &lt;optional><br>
2511
2512
2513
2514
2515
2516 </td>
2517
2518
2519
2520 <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;">
2521
2522 </td>
2523
2524
2525 <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 address that we want it to return in the case that the current one is not allowed (used when &quot;allowsLocal&quot; does not allow a local address). If it contains a file, it will not be stripped out.</p></td>
2526 </tr>
2527
2528
2529
2530 <tr>
2531
2532 <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>allowsLocal</code></td>
2533
2534
2535 <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;">
2536
2537
2538<span class="param-type">boolean</span>
2539
2540
2541
2542
2543 </td>
2544
2545
2546 <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;">
2547
2548 &lt;optional><br>
2549
2550
2551
2552
2553
2554 </td>
2555
2556
2557
2558 <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;">
2559
2560 true
2561
2562 </td>
2563
2564
2565 <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 to allow returning a local address or not. If it is set to false and the current address is local, it will return the &quot;fallbackURL&quot; instead (without stripping out the file, if any).</p></td>
2566 </tr>
2567
2568
2569
2570 <tr>
2571
2572 <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>mindIframes</code></td>
2573
2574
2575 <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;">
2576
2577
2578<span class="param-type">boolean</span>
2579
2580
2581
2582
2583 </td>
2584
2585
2586 <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;">
2587
2588 &lt;optional><br>
2589
2590
2591
2592
2593
2594 </td>
2595
2596
2597
2598 <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;">
2599
2600 <a href="CB_Configuration.CrossBase.html#.MIND_IFRAMES"><code>CB_Configuration.CrossBase.MIND_IFRAMES</code></a>
2601
2602 </td>
2603
2604
2605 <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 set to true, it will try to get the location of the topmost <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window">window</a> object. Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p></td>
2606 </tr>
2607
2608
2609 </tbody>
2610</table>
2611
2612
2613
2614
2615<dl class="details">
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2646 <dd class="tag-source">
2647 <ul class="dummy">
2648 <li>
2649 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
2650 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-785">line 785</a>
2651 </li>
2652 </ul>
2653 </dd>
2654
2655
2656
2657
2658
2659
2660
2661</dl>
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675 <h5>Returns:</h5>
2676
2677
2678
2679
2680<dl>
2681 <dt>
2682 Type
2683 </dt>
2684 <dd>
2685
2686<span class="param-type">string</span>
2687
2688
2689
2690 </dd>
2691</dl>
2692
2693
2694
2695
2696
2697</dd>
2698
2699
2700
2701<hr>
2702<dt>
2703 <h4 class="name" id=".getNodeJSVersion"><span class="type-signature">&lt;static> </span>getNodeJSVersion<span class="signature">( [asString])</span><span class="type-signature"> &rarr; {array|string}</span></h4>
2704
2705
2706</dt>
2707<dd>
2708
2709
2710 <div class="description">
2711 <p>Returns the available version of <a href="https://en.wikipedia.org/wiki/Node.js">Node.js</a> (if any), as either an array of strings or as a string.</p>
2712 </div>
2713
2714
2715
2716
2717
2718
2719
2720
2721 <h5>Parameters:</h5>
2722
2723
2724<table class="params table table-striped">
2725 <thead>
2726 <tr>
2727
2728 <th style="width:12%; min-width:110px;">Name</th>
2729
2730
2731 <th style="width:12%; min-width:110px;">Type</th>
2732
2733
2734 <th style="width:12%; min-width:110px;">Argument</th>
2735
2736
2737
2738 <th style="width:12%; min-width:110px;">Default</th>
2739
2740
2741 <th class="last" style="min-width:310px;">Description</th>
2742 </tr>
2743 </thead>
2744
2745 <tbody>
2746
2747
2748 <tr>
2749
2750 <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>asString</code></td>
2751
2752
2753 <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;">
2754
2755
2756<span class="param-type">boolean</span>
2757
2758
2759
2760
2761 </td>
2762
2763
2764 <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;">
2765
2766 &lt;optional><br>
2767
2768
2769
2770
2771
2772 </td>
2773
2774
2775
2776 <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;">
2777
2778 false
2779
2780 </td>
2781
2782
2783 <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 set to true, returns the version as a string.</p></td>
2784 </tr>
2785
2786
2787 </tbody>
2788</table>
2789
2790
2791
2792
2793<dl class="details">
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2824 <dd class="tag-source">
2825 <ul class="dummy">
2826 <li>
2827 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
2828 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-346">line 346</a>
2829 </li>
2830 </ul>
2831 </dd>
2832
2833
2834
2835
2836
2837
2838
2839</dl>
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853 <h5>Returns:</h5>
2854
2855
2856
2857
2858<dl>
2859 <dt>
2860 Type
2861 </dt>
2862 <dd>
2863
2864<span class="param-type">array</span>
2865|
2866
2867<span class="param-type">string</span>
2868
2869
2870
2871 </dd>
2872</dl>
2873
2874
2875
2876
2877
2878</dd>
2879
2880
2881
2882<hr>
2883<dt>
2884 <h4 class="name" id=".getPHPVersion"><span class="type-signature">&lt;static> </span>getPHPVersion<span class="signature">( [asString])</span><span class="type-signature"> &rarr; {array|string}</span></h4>
2885
2886
2887</dt>
2888<dd>
2889
2890
2891 <div class="description">
2892 <p>Returns the available version of <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> (if any), as either an array of strings or as a string.</p>
2893 </div>
2894
2895
2896
2897
2898
2899
2900
2901
2902 <h5>Parameters:</h5>
2903
2904
2905<table class="params table table-striped">
2906 <thead>
2907 <tr>
2908
2909 <th style="width:12%; min-width:110px;">Name</th>
2910
2911
2912 <th style="width:12%; min-width:110px;">Type</th>
2913
2914
2915 <th style="width:12%; min-width:110px;">Argument</th>
2916
2917
2918
2919 <th style="width:12%; min-width:110px;">Default</th>
2920
2921
2922 <th class="last" style="min-width:310px;">Description</th>
2923 </tr>
2924 </thead>
2925
2926 <tbody>
2927
2928
2929 <tr>
2930
2931 <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>asString</code></td>
2932
2933
2934 <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;">
2935
2936
2937<span class="param-type">boolean</span>
2938
2939
2940
2941
2942 </td>
2943
2944
2945 <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;">
2946
2947 &lt;optional><br>
2948
2949
2950
2951
2952
2953 </td>
2954
2955
2956
2957 <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;">
2958
2959 false
2960
2961 </td>
2962
2963
2964 <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 set to true, returns the version as a string.</p></td>
2965 </tr>
2966
2967
2968 </tbody>
2969</table>
2970
2971
2972
2973
2974<dl class="details">
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3005 <dd class="tag-source">
3006 <ul class="dummy">
3007 <li>
3008 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
3009 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-321">line 321</a>
3010 </li>
3011 </ul>
3012 </dd>
3013
3014
3015
3016
3017
3018
3019
3020</dl>
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034 <h5>Returns:</h5>
3035
3036
3037
3038
3039<dl>
3040 <dt>
3041 Type
3042 </dt>
3043 <dd>
3044
3045<span class="param-type">array</span>
3046|
3047
3048<span class="param-type">string</span>
3049
3050
3051
3052 </dd>
3053</dl>
3054
3055
3056
3057
3058
3059</dd>
3060
3061
3062
3063<hr>
3064<dt>
3065 <h4 class="name" id=".getSilverlightVersion"><span class="type-signature">&lt;static> </span>getSilverlightVersion<span class="signature">( [asString])</span><span class="type-signature"> &rarr; {array|string}</span></h4>
3066
3067
3068</dt>
3069<dd>
3070
3071
3072 <div class="description">
3073 <p>Returns the available version of <a href="https://en.wikipedia.org/wiki/Microsoft_Silverlight">Microsoft Silverlight</a> plugin (if any), as either an array of strings or as a string.</p>
3074 </div>
3075
3076
3077
3078
3079
3080
3081
3082
3083 <h5>Parameters:</h5>
3084
3085
3086<table class="params table table-striped">
3087 <thead>
3088 <tr>
3089
3090 <th style="width:12%; min-width:110px;">Name</th>
3091
3092
3093 <th style="width:12%; min-width:110px;">Type</th>
3094
3095
3096 <th style="width:12%; min-width:110px;">Argument</th>
3097
3098
3099
3100 <th style="width:12%; min-width:110px;">Default</th>
3101
3102
3103 <th class="last" style="min-width:310px;">Description</th>
3104 </tr>
3105 </thead>
3106
3107 <tbody>
3108
3109
3110 <tr>
3111
3112 <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>asString</code></td>
3113
3114
3115 <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;">
3116
3117
3118<span class="param-type">boolean</span>
3119
3120
3121
3122
3123 </td>
3124
3125
3126 <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;">
3127
3128 &lt;optional><br>
3129
3130
3131
3132
3133
3134 </td>
3135
3136
3137
3138 <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;">
3139
3140 false
3141
3142 </td>
3143
3144
3145 <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 set to true, returns the version as a string.</p></td>
3146 </tr>
3147
3148
3149 </tbody>
3150</table>
3151
3152
3153
3154
3155<dl class="details">
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3186 <dd class="tag-source">
3187 <ul class="dummy">
3188 <li>
3189 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
3190 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-387">line 387</a>
3191 </li>
3192 </ul>
3193 </dd>
3194
3195
3196
3197
3198
3199
3200
3201</dl>
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215 <h5>Returns:</h5>
3216
3217
3218
3219
3220<dl>
3221 <dt>
3222 Type
3223 </dt>
3224 <dd>
3225
3226<span class="param-type">array</span>
3227|
3228
3229<span class="param-type">string</span>
3230
3231
3232
3233 </dd>
3234</dl>
3235
3236
3237
3238
3239
3240</dd>
3241
3242
3243
3244<hr>
3245<dt>
3246 <h4 class="name" id=".getTitle"><span class="type-signature">&lt;static> </span>getTitle<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
3247
3248
3249</dt>
3250<dd>
3251
3252
3253 <div class="description">
3254 <p>Returns the current <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/title">document title</a>.</p>
3255 </div>
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266<dl class="details">
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3297 <dd class="tag-source">
3298 <ul class="dummy">
3299 <li>
3300 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
3301 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-868">line 868</a>
3302 </li>
3303 </ul>
3304 </dd>
3305
3306
3307
3308
3309
3310
3311
3312</dl>
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326 <h5>Returns:</h5>
3327
3328
3329
3330
3331<dl>
3332 <dt>
3333 Type
3334 </dt>
3335 <dd>
3336
3337<span class="param-type">string</span>
3338
3339
3340
3341 </dd>
3342</dl>
3343
3344
3345
3346
3347
3348</dd>
3349
3350
3351
3352<hr>
3353<dt>
3354 <h4 class="name" id=".getVersion"><span class="type-signature">&lt;static> </span>getVersion<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
3355
3356
3357</dt>
3358<dd>
3359
3360
3361 <div class="description">
3362 <p>Returns the current web client version (if possible) as a string. It uses <a href="https://quirksmode.org/js/detect.html">BrowserDetect</a> (<a href="https://gist.github.com/mitchellhislop/2018348">source code rescued</a>) internally.</p>
3363 </div>
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374<dl class="details">
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3405 <dd class="tag-source">
3406 <ul class="dummy">
3407 <li>
3408 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
3409 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-123">line 123</a>
3410 </li>
3411 </ul>
3412 </dd>
3413
3414
3415
3416
3417
3418
3419
3420</dl>
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434 <h5>Returns:</h5>
3435
3436
3437
3438
3439<dl>
3440 <dt>
3441 Type
3442 </dt>
3443 <dd>
3444
3445<span class="param-type">string</span>
3446
3447
3448
3449 </dd>
3450</dl>
3451
3452
3453
3454
3455
3456</dd>
3457
3458
3459
3460<hr>
3461<dt>
3462 <h4 class="name" id=".getVersionMain"><span class="type-signature">&lt;static> </span>getVersionMain<span class="signature">()</span><span class="type-signature"> &rarr; {integer}</span></h4>
3463
3464
3465</dt>
3466<dd>
3467
3468
3469 <div class="description">
3470 <p>Returns the current web client main version (first number), if possible, as an integer. It uses <a href="https://quirksmode.org/js/detect.html">BrowserDetect</a> (<a href="https://gist.github.com/mitchellhislop/2018348">source code rescued</a>) internally.</p>
3471 </div>
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482<dl class="details">
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3513 <dd class="tag-source">
3514 <ul class="dummy">
3515 <li>
3516 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
3517 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-139">line 139</a>
3518 </li>
3519 </ul>
3520 </dd>
3521
3522
3523
3524
3525
3526
3527
3528</dl>
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542 <h5>Returns:</h5>
3543
3544
3545
3546
3547<dl>
3548 <dt>
3549 Type
3550 </dt>
3551 <dd>
3552
3553<span class="param-type">integer</span>
3554
3555
3556
3557 </dd>
3558</dl>
3559
3560
3561
3562
3563
3564</dd>
3565
3566
3567
3568<hr>
3569<dt>
3570 <h4 class="name" id=".getWindow"><span class="type-signature">&lt;static> </span>getWindow<span class="signature">( [mindIframes])</span><span class="type-signature"> &rarr; {Object}</span></h4>
3571
3572
3573</dt>
3574<dd>
3575
3576
3577 <div class="description">
3578 <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window">window</a> object (having in mind whether the script is running in one <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more, if we want).</p>
3579 </div>
3580
3581
3582
3583
3584
3585
3586
3587
3588 <h5>Parameters:</h5>
3589
3590
3591<table class="params table table-striped">
3592 <thead>
3593 <tr>
3594
3595 <th style="width:12%; min-width:110px;">Name</th>
3596
3597
3598 <th style="width:12%; min-width:110px;">Type</th>
3599
3600
3601 <th style="width:12%; min-width:110px;">Argument</th>
3602
3603
3604
3605 <th style="width:12%; min-width:110px;">Default</th>
3606
3607
3608 <th class="last" style="min-width:310px;">Description</th>
3609 </tr>
3610 </thead>
3611
3612 <tbody>
3613
3614
3615 <tr>
3616
3617 <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>mindIframes</code></td>
3618
3619
3620 <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;">
3621
3622
3623<span class="param-type">boolean</span>
3624
3625
3626
3627
3628 </td>
3629
3630
3631 <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;">
3632
3633 &lt;optional><br>
3634
3635
3636
3637
3638
3639 </td>
3640
3641
3642
3643 <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;">
3644
3645 <a href="CB_Configuration.CrossBase.html#.MIND_IFRAMES"><code>CB_Configuration.CrossBase.MIND_IFRAMES</code></a>
3646
3647 </td>
3648
3649
3650 <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 set to true, it will try to get and return the topmost <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window">window</a> object. Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p></td>
3651 </tr>
3652
3653
3654 </tbody>
3655</table>
3656
3657
3658
3659
3660<dl class="details">
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3691 <dd class="tag-source">
3692 <ul class="dummy">
3693 <li>
3694 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
3695 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-223">line 223</a>
3696 </li>
3697 </ul>
3698 </dd>
3699
3700
3701
3702
3703
3704
3705
3706</dl>
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720 <h5>Returns:</h5>
3721
3722
3723
3724
3725<dl>
3726 <dt>
3727 Type
3728 </dt>
3729 <dd>
3730
3731<span class="param-type">Object</span>
3732
3733
3734
3735 </dd>
3736</dl>
3737
3738
3739
3740
3741
3742</dd>
3743
3744
3745
3746<hr>
3747<dt>
3748 <h4 class="name" id=".getWindowBase"><span class="type-signature">&lt;static> </span>getWindowBase<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
3749
3750
3751</dt>
3752<dd>
3753
3754
3755 <div class="description">
3756 <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window">window</a> object of the first parent (the topmost one). Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p>
3757 </div>
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768<dl class="details">
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3799 <dd class="tag-source">
3800 <ul class="dummy">
3801 <li>
3802 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
3803 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-186">line 186</a>
3804 </li>
3805 </ul>
3806 </dd>
3807
3808
3809
3810
3811
3812
3813
3814</dl>
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828 <h5>Returns:</h5>
3829
3830
3831
3832
3833<dl>
3834 <dt>
3835 Type
3836 </dt>
3837 <dd>
3838
3839<span class="param-type">Object</span>
3840
3841
3842
3843 </dd>
3844</dl>
3845
3846
3847
3848
3849
3850</dd>
3851
3852
3853
3854<hr>
3855<dt>
3856 <h4 class="name" id=".getWindowParents"><span class="type-signature">&lt;static> </span>getWindowParents<span class="signature">()</span><span class="type-signature"> &rarr; {array}</span></h4>
3857
3858
3859</dt>
3860<dd>
3861
3862
3863 <div class="description">
3864 <p>Returns all the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window">window</a> objects, parents and last son (main one) in an array (with the topmost parent in the highest index). Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p>
3865 </div>
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876<dl class="details">
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3907 <dd class="tag-source">
3908 <ul class="dummy">
3909 <li>
3910 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
3911 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-151">line 151</a>
3912 </li>
3913 </ul>
3914 </dd>
3915
3916
3917
3918
3919
3920
3921
3922</dl>
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936 <h5>Returns:</h5>
3937
3938
3939
3940
3941<dl>
3942 <dt>
3943 Type
3944 </dt>
3945 <dd>
3946
3947<span class="param-type">array</span>
3948
3949
3950
3951 </dd>
3952</dl>
3953
3954
3955
3956
3957
3958</dd>
3959
3960
3961
3962<hr>
3963<dt>
3964 <h4 class="name" id=".isRunningLocally"><span class="type-signature">&lt;static> </span>isRunningLocally<span class="signature">( [mindIframes])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3965
3966
3967</dt>
3968<dd>
3969
3970
3971 <div class="description">
3972 <p>Tells whether the script is running locally (using &quot;file:&quot; protocol) or not.</p>
3973 </div>
3974
3975
3976
3977
3978
3979
3980
3981
3982 <h5>Parameters:</h5>
3983
3984
3985<table class="params table table-striped">
3986 <thead>
3987 <tr>
3988
3989 <th style="width:12%; min-width:110px;">Name</th>
3990
3991
3992 <th style="width:12%; min-width:110px;">Type</th>
3993
3994
3995 <th style="width:12%; min-width:110px;">Argument</th>
3996
3997
3998
3999 <th style="width:12%; min-width:110px;">Default</th>
4000
4001
4002 <th class="last" style="min-width:310px;">Description</th>
4003 </tr>
4004 </thead>
4005
4006 <tbody>
4007
4008
4009 <tr>
4010
4011 <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>mindIframes</code></td>
4012
4013
4014 <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;">
4015
4016
4017<span class="param-type">boolean</span>
4018
4019
4020
4021
4022 </td>
4023
4024
4025 <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;">
4026
4027 &lt;optional><br>
4028
4029
4030
4031
4032
4033 </td>
4034
4035
4036
4037 <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;">
4038
4039 <a href="CB_Configuration.CrossBase.html#.MIND_IFRAMES"><code>CB_Configuration.CrossBase.MIND_IFRAMES</code></a>
4040
4041 </td>
4042
4043
4044 <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 set to true, it will try to check the protocol of the topmost <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window">window</a> object. Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p></td>
4045 </tr>
4046
4047
4048 </tbody>
4049</table>
4050
4051
4052
4053
4054<dl class="details">
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4085 <dd class="tag-source">
4086 <ul class="dummy">
4087 <li>
4088 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
4089 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-481">line 481</a>
4090 </li>
4091 </ul>
4092 </dd>
4093
4094
4095
4096
4097
4098
4099
4100</dl>
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114 <h5>Returns:</h5>
4115
4116
4117
4118
4119<dl>
4120 <dt>
4121 Type
4122 </dt>
4123 <dd>
4124
4125<span class="param-type">boolean</span>
4126
4127
4128
4129 </dd>
4130</dl>
4131
4132
4133
4134
4135
4136</dd>
4137
4138
4139
4140<hr>
4141<dt>
4142 <h4 class="name" id=".isRunningOnElectron"><span class="type-signature">&lt;static> </span>isRunningOnElectron<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
4143
4144
4145</dt>
4146<dd>
4147
4148
4149 <div class="description">
4150 <p>Tells whether the script is running on <a href="https://electronjs.org/">Electron (Electron.js)</a> or not.</p>
4151 </div>
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162<dl class="details">
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4193 <dd class="tag-source">
4194 <ul class="dummy">
4195 <li>
4196 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
4197 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-537">line 537</a>
4198 </li>
4199 </ul>
4200 </dd>
4201
4202
4203
4204
4205
4206
4207
4208</dl>
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222 <h5>Returns:</h5>
4223
4224
4225
4226
4227<dl>
4228 <dt>
4229 Type
4230 </dt>
4231 <dd>
4232
4233<span class="param-type">boolean</span>
4234
4235
4236
4237 </dd>
4238</dl>
4239
4240
4241
4242
4243
4244</dd>
4245
4246
4247
4248<hr>
4249<dt>
4250 <h4 class="name" id=".isRunningOnNWjs"><span class="type-signature">&lt;static> </span>isRunningOnNWjs<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
4251
4252
4253</dt>
4254<dd>
4255
4256
4257 <div class="description">
4258 <p>Tells whether the script is running on <a href="https://nwjs.io/">NW.js (formerly node-webkit)</a> or not.</p>
4259 </div>
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270<dl class="details">
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4301 <dd class="tag-source">
4302 <ul class="dummy">
4303 <li>
4304 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
4305 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-518">line 518</a>
4306 </li>
4307 </ul>
4308 </dd>
4309
4310
4311
4312
4313
4314
4315
4316</dl>
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330 <h5>Returns:</h5>
4331
4332
4333
4334
4335<dl>
4336 <dt>
4337 Type
4338 </dt>
4339 <dd>
4340
4341<span class="param-type">boolean</span>
4342
4343
4344
4345 </dd>
4346</dl>
4347
4348
4349
4350
4351
4352</dd>
4353
4354
4355
4356<hr>
4357<dt>
4358 <h4 class="name" id=".onLanguageChanges"><span class="type-signature">&lt;static> </span>onLanguageChanges<span class="signature">(eventFunction [, keepOldFunction] [, useCapture])</span><span class="type-signature"></span></h4>
4359
4360
4361</dt>
4362<dd>
4363
4364
4365 <div class="description">
4366 <p>Sets a function to execute when the <a href="https://developer.mozilla.org/en-US/docs/Web/Events/languagechange">languagechange</a> event is fired (only for some web clients) or removes it.</p>
4367 </div>
4368
4369
4370
4371
4372
4373
4374
4375
4376 <h5>Parameters:</h5>
4377
4378
4379<table class="params table table-striped">
4380 <thead>
4381 <tr>
4382
4383 <th style="width:12%; min-width:110px;">Name</th>
4384
4385
4386 <th style="width:12%; min-width:110px;">Type</th>
4387
4388
4389 <th style="width:12%; min-width:110px;">Argument</th>
4390
4391
4392
4393 <th style="width:12%; min-width:110px;">Default</th>
4394
4395
4396 <th class="last" style="min-width:310px;">Description</th>
4397 </tr>
4398 </thead>
4399
4400 <tbody>
4401
4402
4403 <tr>
4404
4405 <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>eventFunction</code></td>
4406
4407
4408 <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;">
4409
4410
4411<span class="param-type">function</span>
4412|
4413
4414<span class="param-type">null</span>
4415
4416
4417
4418
4419 </td>
4420
4421
4422 <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;">
4423
4424
4425
4426
4427
4428 </td>
4429
4430
4431
4432 <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;">
4433
4434 </td>
4435
4436
4437 <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>Function that represents the event listener that will be called when the event is fired. If a null value is used, the event will be removed.</p></td>
4438 </tr>
4439
4440
4441
4442 <tr>
4443
4444 <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>keepOldFunction</code></td>
4445
4446
4447 <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;">
4448
4449
4450<span class="param-type">boolean</span>
4451
4452
4453
4454
4455 </td>
4456
4457
4458 <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;">
4459
4460 &lt;optional><br>
4461
4462
4463
4464
4465
4466 </td>
4467
4468
4469
4470 <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;">
4471
4472 true
4473
4474 </td>
4475
4476
4477 <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 to also keep the previous listeners or remove them otherwise.</p></td>
4478 </tr>
4479
4480
4481
4482 <tr>
4483
4484 <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>useCapture</code></td>
4485
4486
4487 <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;">
4488
4489
4490<span class="param-type">boolean</span>
4491
4492
4493
4494
4495 </td>
4496
4497
4498 <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;">
4499
4500 &lt;optional><br>
4501
4502
4503
4504
4505
4506 </td>
4507
4508
4509
4510 <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;">
4511
4512 false
4513
4514 </td>
4515
4516
4517 <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 the event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
4518 </tr>
4519
4520
4521 </tbody>
4522</table>
4523
4524
4525
4526
4527<dl class="details">
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4558 <dd class="tag-source">
4559 <ul class="dummy">
4560 <li>
4561 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
4562 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-91">line 91</a>
4563 </li>
4564 </ul>
4565 </dd>
4566
4567
4568
4569
4570
4571
4572
4573</dl>
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589</dd>
4590
4591
4592
4593<hr>
4594<dt>
4595 <h4 class="name" id=".redirectTo"><span class="type-signature">&lt;static> </span>redirectTo<span class="signature">(address [, getData] [, mindIframes])</span><span class="type-signature"></span></h4>
4596
4597
4598</dt>
4599<dd>
4600
4601
4602 <div class="description">
4603 <p>Redirects the current client to the desired location (having in mind whether the script is running in one <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more, if we want).</p>
4604 </div>
4605
4606
4607
4608
4609
4610
4611
4612
4613 <h5>Parameters:</h5>
4614
4615
4616<table class="params table table-striped">
4617 <thead>
4618 <tr>
4619
4620 <th style="width:12%; min-width:110px;">Name</th>
4621
4622
4623 <th style="width:12%; min-width:110px;">Type</th>
4624
4625
4626 <th style="width:12%; min-width:110px;">Argument</th>
4627
4628
4629
4630 <th style="width:12%; min-width:110px;">Default</th>
4631
4632
4633 <th class="last" style="min-width:310px;">Description</th>
4634 </tr>
4635 </thead>
4636
4637 <tbody>
4638
4639
4640 <tr>
4641
4642 <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>address</code></td>
4643
4644
4645 <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;">
4646
4647
4648<span class="param-type">string</span>
4649
4650
4651
4652
4653 </td>
4654
4655
4656 <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;">
4657
4658
4659
4660
4661
4662 </td>
4663
4664
4665
4666 <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;">
4667
4668 </td>
4669
4670
4671 <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 address where we want to go.</p></td>
4672 </tr>
4673
4674
4675
4676 <tr>
4677
4678 <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>getData</code></td>
4679
4680
4681 <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;">
4682
4683
4684<span class="param-type">string</span>
4685
4686
4687
4688
4689 </td>
4690
4691
4692 <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;">
4693
4694 &lt;optional><br>
4695
4696
4697
4698
4699
4700 </td>
4701
4702
4703
4704 <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;">
4705
4706 </td>
4707
4708
4709 <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>Any URL (GET) variables we want to send (as for example &quot;data1=value1&amp;data2=value2&quot;).</p></td>
4710 </tr>
4711
4712
4713
4714 <tr>
4715
4716 <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>mindIframes</code></td>
4717
4718
4719 <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;">
4720
4721
4722<span class="param-type">boolean</span>
4723
4724
4725
4726
4727 </td>
4728
4729
4730 <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;">
4731
4732 &lt;optional><br>
4733
4734
4735
4736
4737
4738 </td>
4739
4740
4741
4742 <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;">
4743
4744 <a href="CB_Configuration.CrossBase.html#.MIND_IFRAMES"><code>CB_Configuration.CrossBase.MIND_IFRAMES</code></a>
4745
4746 </td>
4747
4748
4749 <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 set to true, it will try to redirect the topmost <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window">window</a> object. Useful in case the script is running in an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe">iframe</a> or more.</p></td>
4750 </tr>
4751
4752
4753 </tbody>
4754</table>
4755
4756
4757
4758
4759<dl class="details">
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4790 <dd class="tag-source">
4791 <ul class="dummy">
4792 <li>
4793 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
4794 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-721">line 721</a>
4795 </li>
4796 </ul>
4797 </dd>
4798
4799
4800
4801
4802
4803
4804
4805</dl>
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821</dd>
4822
4823
4824
4825<hr>
4826<dt>
4827 <h4 class="name" id=".setTitle"><span class="type-signature">&lt;static> </span>setTitle<span class="signature">(newTitle)</span><span class="type-signature"> &rarr; {string}</span></h4>
4828
4829
4830</dt>
4831<dd>
4832
4833
4834 <div class="description">
4835 <p>Tries to change the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/title">document title</a> and returns it.</p>
4836 </div>
4837
4838
4839
4840
4841
4842
4843
4844
4845 <h5>Parameters:</h5>
4846
4847
4848<table class="params table table-striped">
4849 <thead>
4850 <tr>
4851
4852 <th style="width:12%; min-width:110px;">Name</th>
4853
4854
4855 <th style="width:12%; min-width:110px;">Type</th>
4856
4857
4858
4859
4860
4861 <th class="last" style="min-width:310px;">Description</th>
4862 </tr>
4863 </thead>
4864
4865 <tbody>
4866
4867
4868 <tr>
4869
4870 <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>newTitle</code></td>
4871
4872
4873 <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;">
4874
4875
4876<span class="param-type">newTitle</span>
4877
4878
4879
4880
4881 </td>
4882
4883
4884
4885
4886
4887 <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 desired new title.</p></td>
4888 </tr>
4889
4890
4891 </tbody>
4892</table>
4893
4894
4895
4896
4897<dl class="details">
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4928 <dd class="tag-source">
4929 <ul class="dummy">
4930 <li>
4931 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
4932 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-848">line 848</a>
4933 </li>
4934 </ul>
4935 </dd>
4936
4937
4938
4939
4940
4941
4942
4943</dl>
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957 <h5>Returns:</h5>
4958
4959
4960
4961
4962<dl>
4963 <dt>
4964 Type
4965 </dt>
4966 <dd>
4967
4968<span class="param-type">string</span>
4969
4970
4971
4972 </dd>
4973</dl>
4974
4975
4976
4977
4978
4979</dd>
4980
4981
4982
4983<hr>
4984<dt>
4985 <h4 class="name" id=".supportsCanvas"><span class="type-signature">&lt;static> </span>supportsCanvas<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
4986
4987
4988</dt>
4989<dd>
4990
4991
4992 <div class="description">
4993 <p>Tells whether the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/canvas">canvas</a> element is supported natively or not.</p>
4994 </div>
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005<dl class="details">
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5036 <dd class="tag-source">
5037 <ul class="dummy">
5038 <li>
5039 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
5040 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-280">line 280</a>
5041 </li>
5042 </ul>
5043 </dd>
5044
5045
5046
5047
5048
5049
5050
5051</dl>
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065 <h5>Returns:</h5>
5066
5067
5068
5069
5070<dl>
5071 <dt>
5072 Type
5073 </dt>
5074 <dd>
5075
5076<span class="param-type">boolean</span>
5077
5078
5079
5080 </dd>
5081</dl>
5082
5083
5084
5085
5086
5087</dd>
5088
5089
5090
5091<hr>
5092<dt>
5093 <h4 class="name" id=".supportsCSS3Transform"><span class="type-signature">&lt;static> </span>supportsCSS3Transform<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
5094
5095
5096</dt>
5097<dd>
5098
5099
5100 <div class="description">
5101 <p>Tells whether <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/CSS3">CSS3</a> <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/transform">transform</a> is supported natively or not.</p>
5102 </div>
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113<dl class="details">
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5144 <dd class="tag-source">
5145 <ul class="dummy">
5146 <li>
5147 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
5148 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-292">line 292</a>
5149 </li>
5150 </ul>
5151 </dd>
5152
5153
5154
5155
5156
5157
5158
5159</dl>
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173 <h5>Returns:</h5>
5174
5175
5176
5177
5178<dl>
5179 <dt>
5180 Type
5181 </dt>
5182 <dd>
5183
5184<span class="param-type">boolean</span>
5185
5186
5187
5188 </dd>
5189</dl>
5190
5191
5192
5193
5194
5195</dd>
5196
5197
5198
5199<hr>
5200<dt>
5201 <h4 class="name" id=".supportsFlash"><span class="type-signature">&lt;static> </span>supportsFlash<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
5202
5203
5204</dt>
5205<dd>
5206
5207
5208 <div class="description">
5209 <p>Function that tells whether <a href="https://en.wikipedia.org/wiki/Adobe_Flash_Player">Adobe Flash (formerly Macromedia Flash)</a> plugin is available or not.</p>
5210 </div>
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221<dl class="details">
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5252 <dd class="tag-source">
5253 <ul class="dummy">
5254 <li>
5255 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
5256 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-403">line 403</a>
5257 </li>
5258 </ul>
5259 </dd>
5260
5261
5262
5263
5264
5265
5266
5267</dl>
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281 <h5>Returns:</h5>
5282
5283
5284
5285
5286<dl>
5287 <dt>
5288 Type
5289 </dt>
5290 <dd>
5291
5292<span class="param-type">boolean</span>
5293
5294
5295
5296 </dd>
5297</dl>
5298
5299
5300
5301
5302
5303</dd>
5304
5305
5306
5307<hr>
5308<dt>
5309 <h4 class="name" id=".supportsNodeJS"><span class="type-signature">&lt;static> </span>supportsNodeJS<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
5310
5311
5312</dt>
5313<dd>
5314
5315
5316 <div class="description">
5317 <p>Function that tells whether <a href="https://en.wikipedia.org/wiki/Node.js">Node.js</a> is available (checks the availability of <a href="https://nodejs.org/api/process.html#process_process_versions">process.versions.node</a>) or not.</p>
5318 </div>
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329<dl class="details">
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5360 <dd class="tag-source">
5361 <ul class="dummy">
5362 <li>
5363 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
5364 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-334">line 334</a>
5365 </li>
5366 </ul>
5367 </dd>
5368
5369
5370
5371
5372
5373
5374
5375</dl>
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389 <h5>Returns:</h5>
5390
5391
5392
5393
5394<dl>
5395 <dt>
5396 Type
5397 </dt>
5398 <dd>
5399
5400<span class="param-type">boolean</span>
5401
5402
5403
5404 </dd>
5405</dl>
5406
5407
5408
5409
5410
5411</dd>
5412
5413
5414
5415<hr>
5416<dt>
5417 <h4 class="name" id=".supportsPHP"><span class="type-signature">&lt;static> </span>supportsPHP<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
5418
5419
5420</dt>
5421<dd>
5422
5423
5424 <div class="description">
5425 <p>Function that tells whether <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> is available or not.</p>
5426 </div>
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437<dl class="details">
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5468 <dd class="tag-source">
5469 <ul class="dummy">
5470 <li>
5471 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
5472 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-309">line 309</a>
5473 </li>
5474 </ul>
5475 </dd>
5476
5477
5478
5479
5480
5481
5482
5483</dl>
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497 <h5>Returns:</h5>
5498
5499
5500
5501
5502<dl>
5503 <dt>
5504 Type
5505 </dt>
5506 <dd>
5507
5508<span class="param-type">boolean</span>
5509
5510
5511
5512 </dd>
5513</dl>
5514
5515
5516
5517
5518
5519</dd>
5520
5521
5522
5523<hr>
5524<dt>
5525 <h4 class="name" id=".supportsSilverlight"><span class="type-signature">&lt;static> </span>supportsSilverlight<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
5526
5527
5528</dt>
5529<dd>
5530
5531
5532 <div class="description">
5533 <p>Function that tells whether <a href="https://en.wikipedia.org/wiki/Microsoft_Silverlight">Microsoft Silverlight</a> plugin is available or not.</p>
5534 </div>
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545<dl class="details">
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5576 <dd class="tag-source">
5577 <ul class="dummy">
5578 <li>
5579 <a href="CrossBase_general_CB_Client.js.html">CrossBase/general/CB_Client.js</a>,
5580 <a href="CrossBase_general_CB_Client.js.html#sunlight-1-line-361">line 361</a>
5581 </li>
5582 </ul>
5583 </dd>
5584
5585
5586
5587
5588
5589
5590
5591</dl>
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605 <h5>Returns:</h5>
5606
5607
5608
5609
5610<dl>
5611 <dt>
5612 Type
5613 </dt>
5614 <dd>
5615
5616<span class="param-type">boolean</span>
5617
5618
5619
5620 </dd>
5621</dl>
5622
5623
5624
5625
5626
5627</dd>
5628
5629 </dl>
5630
5631
5632
5633
5634
5635</article>
5636
5637</section>
5638
5639
5640
5641
5642 </div>
5643 </div>
5644
5645 <div class="clearfix"></div>
5646
5647
5648 <div class="col-md-3">
5649 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
5650 </div>
5651
5652
5653</div>
5654</div>
5655
5656
5657 <div class="modal fade" id="searchResults">
5658 <div class="modal-dialog">
5659 <div class="modal-content">
5660 <div class="modal-header">
5661 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
5662 <h4 class="modal-title">Search results</h4>
5663 </div>
5664 <div class="modal-body"></div>
5665 <div class="modal-footer">
5666 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
5667 </div>
5668 </div><!-- /.modal-content -->
5669 </div><!-- /.modal-dialog -->
5670 </div>
5671
5672
5673<footer>
5674
5675
5676 <span class="copyright">
5677 <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>
5678 </span>
5679
5680<span class="jsdoc-message">
5681 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
5682
5683 on Mon Feb 3rd 2020
5684
5685 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
5686</span>
5687</footer>
5688
5689<script src="scripts/docstrap.lib.js"></script>
5690<script src="scripts/toc.js"></script>
5691
5692 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
5693
5694
5695<script>
5696$( function () {
5697 $( "[id*='$']" ).each( function () {
5698 var $this = $( this );
5699
5700 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
5701 } );
5702
5703 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
5704 var $this = $( this );
5705
5706 var example = $this.find( "code" );
5707 exampleText = example.html();
5708 var lang = /{@lang (.*?)}/.exec( exampleText );
5709 if ( lang && lang[1] ) {
5710 exampleText = exampleText.replace( lang[0], "" );
5711 example.html( exampleText );
5712 lang = lang[1];
5713 } else {
5714 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
5715 lang = langClassMatch ? langClassMatch[1] : "javascript";
5716 }
5717
5718 if ( lang ) {
5719
5720 $this
5721 .addClass( "sunlight-highlight-" + lang )
5722 .addClass( "linenums" )
5723 .html( example.html() );
5724
5725 }
5726 } );
5727
5728 Sunlight.highlightAll( {
5729 lineNumbers : true,
5730 showMenu : true,
5731 enableDoclinks : true
5732 } );
5733
5734 $.catchAnchorLinks( {
5735 navbarOffset: 10
5736 } );
5737 $( "#toc" ).toc( {
5738 anchorName : function ( i, heading, prefix ) {
5739 return $( heading ).attr( "id" ) || ( prefix + i );
5740 },
5741 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
5742 showAndHide : false,
5743 smoothScrolling: true
5744 } );
5745
5746 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
5747 $( '.dropdown-toggle' ).dropdown();
5748
5749 $( "table" ).each( function () {
5750 var $this = $( this );
5751 $this.addClass('table');
5752 } );
5753
5754} );
5755</script>
5756
5757
5758
5759<!--Navigation and Symbol Display-->
5760
5761<script>
5762 $( function () {
5763 $( '#main' ).localScroll( {
5764 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
5765 } );
5766 $( "dt.name" ).each( function () {
5767 var $this = $( this ).find("h4");
5768 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
5769 var dt = $(this);
5770 var children = dt.next( "dd" );
5771
5772 dt.prepend( icon ).css( {cursor : "pointer"} );
5773 dt.addClass( "member-collapsed" ).addClass( "member" );
5774
5775
5776 children.hide();
5777
5778 dt.children().on( "click", function () {
5779 children = dt.next( "dd" );
5780 children.slideToggle( "fast", function () {
5781
5782 if ( children.is( ":visible" ) ) {
5783 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
5784 dt.addClass( "member-open" ).animate( "member-collapsed" );
5785 } else {
5786 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
5787 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
5788 }
5789 } );
5790 } );
5791
5792 } );
5793 } );
5794</script>
5795
5796
5797<!--Google Analytics-->
5798
5799
5800
5801 <script type="text/javascript">
5802 $(document).ready(function() {
5803 SearcherDisplay.init();
5804 });
5805 </script>
5806
5807
5808</body>
5809</html>
\No newline at end of file