UNPKG

crossbrowdy/documentation/CB_Net.html

Version:
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_Net</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_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><li><a href="CB_baseSymbols.html">CB_baseSymbols</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_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_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_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_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</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_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</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_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_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>
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_Net</h1>
84	
85<section>
86
87<header>
88    
89        <h2>
90        CB_Net
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 things related to the net. It will return itself if it is tried to be instantiated.</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_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
140				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-8">line 8</a>
141			</li>
142		</ul>
143	</dd>
144	
145
146	
147
148	
149
150	
151</dl>
152
153
154        
155    
156    </div>
157
158    
159
160    
161
162    
163
164    
165
166    
167        <h3 class="subsection-title">Namespaces</h3>
168
169        <dl>
170            <dt><a href="namespaces.html#CB_Net.Fetch"><a href="CB_Net.Fetch.html">Fetch</a></a></dt>
171            <dd></dd>
172        
173            <dt><a href="namespaces.html#CB_Net.REST"><a href="CB_Net.REST.html">REST</a></a></dt>
174            <dd></dd>
175        
176            <dt><a href="namespaces.html#CB_Net.Sockets"><a href="CB_Net.Sockets.html">Sockets</a></a></dt>
177            <dd></dd>
178        
179            <dt><a href="namespaces.html#CB_Net.XHR"><a href="CB_Net.XHR.html">XHR</a></a></dt>
180            <dd></dd>
181        </dl>
182    
183
184    
185
186    
187        <h3 class="subsection-title">Methods</h3>
188
189        <dl>
190            
191<hr>
192<dt>
193    <h4 class="name" id=".URIDecode"><span class="type-signature">&lt;static> </span>URIDecode<span class="signature">(URI)</span><span class="type-signature"> &rarr; {string}</span></h4>
194    
195    
196</dt>
197<dd>
198
199    
200    <div class="description">
201        <p>Encodes a given URI. Uses the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI">decodeURI</a> function internally if available or fallbacks to the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape">unescape</a> function otherwise.</p>
202    </div>
203    
204
205    
206
207    
208
209    
210    
211        <h5>Parameters:</h5>
212        
213
214<table class="params table table-striped">
215    <thead>
216    <tr>
217        
218        <th style="width:12%; min-width:110px;">Name</th>
219        
220
221        <th style="width:12%; min-width:110px;">Type</th>
222
223        
224
225        
226
227        <th class="last" style="min-width:310px;">Description</th>
228    </tr>
229    </thead>
230
231    <tbody>
232    
233
234        <tr>
235            
236                <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>URI</code></td>
237            
238
239            <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;">
240            
241                
242<span class="param-type">string</span>
243|
244
245<span class="param-type">number</span>
246
247
248
249            
250            </td>
251
252            
253
254            
255
256            <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 URI that we want to decode. Normally, it should be either a string or a number.</p></td>
257        </tr>
258
259    
260    </tbody>
261</table>
262
263    
264
265    
266<dl class="details">
267    
268
269	
270
271	
272
273	
274
275    
276
277    
278
279    
280
281    
282
283	
284
285	
286
287	
288
289	
290
291	
292
293
294
295	
296	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
297	<dd class="tag-source">
298		<ul class="dummy">
299			<li>
300				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
301				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-100">line 100</a>
302			</li>
303		</ul>
304	</dd>
305	
306
307	
308
309	
310
311	
312	<dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
313	<dd class="tag-todo">
314		<ul>
315			<li>Think about using another thing since <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape">unescape</a> maybe is not a good fallback. Probably a polyfill to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI">decodeURI</a> function.</li>
316			</ul>
317	</dd>
318	
319</dl>
320
321
322    
323
324    
325
326    
327
328    
329
330    
331
332    
333    <h5>Returns:</h5>
334    
335            
336
337
338<dl>
339    <dt>
340        Type
341    </dt>
342    <dd>
343        
344<span class="param-type">string</span>
345
346
347
348    </dd>
349</dl>
350
351
352        
353
354    
355</dd>
356
357        
358            
359<hr>
360<dt>
361    <h4 class="name" id=".URIEncode"><span class="type-signature">&lt;static> </span>URIEncode<span class="signature">(URI)</span><span class="type-signature"> &rarr; {string}</span></h4>
362    
363    
364</dt>
365<dd>
366
367    
368    <div class="description">
369        <p>Encodes a given URI. Uses the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI">encodeURI</a> function internally if available or fallbacks to the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape">escape</a> function otherwise.</p>
370    </div>
371    
372
373    
374
375    
376
377    
378    
379        <h5>Parameters:</h5>
380        
381
382<table class="params table table-striped">
383    <thead>
384    <tr>
385        
386        <th style="width:12%; min-width:110px;">Name</th>
387        
388
389        <th style="width:12%; min-width:110px;">Type</th>
390
391        
392
393        
394
395        <th class="last" style="min-width:310px;">Description</th>
396    </tr>
397    </thead>
398
399    <tbody>
400    
401
402        <tr>
403            
404                <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>URI</code></td>
405            
406
407            <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;">
408            
409                
410<span class="param-type">string</span>
411|
412
413<span class="param-type">number</span>
414
415
416
417            
418            </td>
419
420            
421
422            
423
424            <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 URI that we want to encode. Normally, it should be either a string or a number.</p></td>
425        </tr>
426
427    
428    </tbody>
429</table>
430
431    
432
433    
434<dl class="details">
435    
436
437	
438
439	
440
441	
442
443    
444
445    
446
447    
448
449    
450
451	
452
453	
454
455	
456
457	
458
459	
460
461
462
463	
464	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
465	<dd class="tag-source">
466		<ul class="dummy">
467			<li>
468				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
469				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-81">line 81</a>
470			</li>
471		</ul>
472	</dd>
473	
474
475	
476
477	
478
479	
480	<dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
481	<dd class="tag-todo">
482		<ul>
483			<li>Think about using another thing since <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape">escape</a> maybe is not a good fallback. Probably a polyfill to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI">encodeURI</a> function.</li>
484			</ul>
485	</dd>
486	
487</dl>
488
489
490    
491
492    
493
494    
495
496    
497
498    
499
500    
501    <h5>Returns:</h5>
502    
503            
504
505
506<dl>
507    <dt>
508        Type
509    </dt>
510    <dd>
511        
512<span class="param-type">string</span>
513
514
515
516    </dd>
517</dl>
518
519
520        
521
522    
523</dd>
524
525        
526            
527<hr>
528<dt>
529    <h4 class="name" id=".URIValueDecode"><span class="type-signature">&lt;static> </span>URIValueDecode<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
530    
531    
532</dt>
533<dd>
534
535    
536    <div class="description">
537        <p>Decodes a given URI value. Uses the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent">decodeURIComponent</a> function internally if available or fallbacks to the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape">unescape</a> function otherwise.</p>
538    </div>
539    
540
541    
542
543    
544
545    
546    
547        <h5>Parameters:</h5>
548        
549
550<table class="params table table-striped">
551    <thead>
552    <tr>
553        
554        <th style="width:12%; min-width:110px;">Name</th>
555        
556
557        <th style="width:12%; min-width:110px;">Type</th>
558
559        
560
561        
562
563        <th class="last" style="min-width:310px;">Description</th>
564    </tr>
565    </thead>
566
567    <tbody>
568    
569
570        <tr>
571            
572                <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>value</code></td>
573            
574
575            <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;">
576            
577                
578<span class="param-type">string</span>
579|
580
581<span class="param-type">number</span>
582
583
584
585            
586            </td>
587
588            
589
590            
591
592            <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 value that we want to decode. Normally, it should be either a string or a number.</p></td>
593        </tr>
594
595    
596    </tbody>
597</table>
598
599    
600
601    
602<dl class="details">
603    
604
605	
606
607	
608
609	
610
611    
612
613    
614
615    
616
617    
618
619	
620
621	
622
623	
624
625	
626
627	
628
629
630
631	
632	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
633	<dd class="tag-source">
634		<ul class="dummy">
635			<li>
636				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
637				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-62">line 62</a>
638			</li>
639		</ul>
640	</dd>
641	
642
643	
644
645	
646
647	
648	<dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
649	<dd class="tag-todo">
650		<ul>
651			<li>Think about using another thing since <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape">unescape</a> maybe is not a good fallback. Probably a polyfill to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent">decodeURIComponent</a> function.</li>
652			</ul>
653	</dd>
654	
655</dl>
656
657
658    
659
660    
661
662    
663
664    
665
666    
667
668    
669    <h5>Returns:</h5>
670    
671            
672
673
674<dl>
675    <dt>
676        Type
677    </dt>
678    <dd>
679        
680<span class="param-type">string</span>
681
682
683
684    </dd>
685</dl>
686
687
688        
689
690    
691</dd>
692
693        
694            
695<hr>
696<dt>
697    <h4 class="name" id=".URIValueEncode"><span class="type-signature">&lt;static> </span>URIValueEncode<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
698    
699    
700</dt>
701<dd>
702
703    
704    <div class="description">
705        <p>Encodes a given URI value. Uses the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent">encodeURIComponent</a> function internally if available or fallbacks to the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape">escape</a> function otherwise.</p>
706    </div>
707    
708
709    
710
711    
712
713    
714    
715        <h5>Parameters:</h5>
716        
717
718<table class="params table table-striped">
719    <thead>
720    <tr>
721        
722        <th style="width:12%; min-width:110px;">Name</th>
723        
724
725        <th style="width:12%; min-width:110px;">Type</th>
726
727        
728
729        
730
731        <th class="last" style="min-width:310px;">Description</th>
732    </tr>
733    </thead>
734
735    <tbody>
736    
737
738        <tr>
739            
740                <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>value</code></td>
741            
742
743            <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;">
744            
745                
746<span class="param-type">string</span>
747|
748
749<span class="param-type">number</span>
750
751
752
753            
754            </td>
755
756            
757
758            
759
760            <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 value that we want to encode. Normally, it should be either a string or a number.</p></td>
761        </tr>
762
763    
764    </tbody>
765</table>
766
767    
768
769    
770<dl class="details">
771    
772
773	
774
775	
776
777	
778
779    
780
781    
782
783    
784
785    
786
787	
788
789	
790
791	
792
793	
794
795	
796
797
798
799	
800	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
801	<dd class="tag-source">
802		<ul class="dummy">
803			<li>
804				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
805				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-43">line 43</a>
806			</li>
807		</ul>
808	</dd>
809	
810
811	
812
813	
814
815	
816	<dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
817	<dd class="tag-todo">
818		<ul>
819			<li>Think about using another thing since <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape">escape</a> maybe is not a good fallback. Probably a polyfill to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent">encodeURIComponent</a> function.</li>
820			</ul>
821	</dd>
822	
823</dl>
824
825
826    
827
828    
829
830    
831
832    
833
834    
835
836    
837    <h5>Returns:</h5>
838    
839            
840
841
842<dl>
843    <dt>
844        Type
845    </dt>
846    <dd>
847        
848<span class="param-type">string</span>
849
850
851
852    </dd>
853</dl>
854
855
856        
857
858    
859</dd>
860
861        
862            
863<hr>
864<dt>
865    <h4 class="name" id=".URLDecode"><span class="type-signature">&lt;static> </span>URLDecode<span class="signature">()</span><span class="type-signature"></span></h4>
866    
867    
868</dt>
869<dd>
870
871    
872    <div class="description">
873        <p>Alias for <a href="CB_Net.html#.URIDecode"><code>CB_Net.URIDecode</code></a>.</p>
874    </div>
875    
876
877    
878
879    
880
881    
882    
883
884    
885<dl class="details">
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	
915	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
916	<dd class="tag-source">
917		<ul class="dummy">
918			<li>
919				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
920				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-88">line 88</a>
921			</li>
922		</ul>
923	</dd>
924	
925
926	
927
928	
929	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
930	<dd class="tag-see">
931		<ul>
932			<li><a href="CB_Net.html#.URIDecode"><code>CB_Net.URIDecode</code></a></li>
933			</ul>
934	</dd>
935	
936
937	
938</dl>
939
940
941    
942
943    
944
945    
946
947    
948
949    
950
951    
952
953    
954</dd>
955
956        
957            
958<hr>
959<dt>
960    <h4 class="name" id=".URLEncode"><span class="type-signature">&lt;static> </span>URLEncode<span class="signature">()</span><span class="type-signature"></span></h4>
961    
962    
963</dt>
964<dd>
965
966    
967    <div class="description">
968        <p>Alias for <a href="CB_Net.html#.URIEncode"><code>CB_Net.URIEncode</code></a>.</p>
969    </div>
970    
971
972    
973
974    
975
976    
977    
978
979    
980<dl class="details">
981    
982
983	
984
985	
986
987	
988
989    
990
991    
992
993    
994
995    
996
997	
998
999	
1000
1001	
1002
1003	
1004
1005	
1006
1007
1008
1009	
1010	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1011	<dd class="tag-source">
1012		<ul class="dummy">
1013			<li>
1014				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
1015				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-69">line 69</a>
1016			</li>
1017		</ul>
1018	</dd>
1019	
1020
1021	
1022
1023	
1024	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1025	<dd class="tag-see">
1026		<ul>
1027			<li><a href="CB_Net.html#.URIEncode"><code>CB_Net.URIEncode</code></a></li>
1028			</ul>
1029	</dd>
1030	
1031
1032	
1033</dl>
1034
1035
1036    
1037
1038    
1039
1040    
1041
1042    
1043
1044    
1045
1046    
1047
1048    
1049</dd>
1050
1051        
1052            
1053<hr>
1054<dt>
1055    <h4 class="name" id=".URLValueDecode"><span class="type-signature">&lt;static> </span>URLValueDecode<span class="signature">()</span><span class="type-signature"></span></h4>
1056    
1057    
1058</dt>
1059<dd>
1060
1061    
1062    <div class="description">
1063        <p>Alias for <a href="CB_Net.html#.URIValueDecode"><code>CB_Net.URIValueDecode</code></a>.</p>
1064    </div>
1065    
1066
1067    
1068
1069    
1070
1071    
1072    
1073
1074    
1075<dl class="details">
1076    
1077
1078	
1079
1080	
1081
1082	
1083
1084    
1085
1086    
1087
1088    
1089
1090    
1091
1092	
1093
1094	
1095
1096	
1097
1098	
1099
1100	
1101
1102
1103
1104	
1105	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1106	<dd class="tag-source">
1107		<ul class="dummy">
1108			<li>
1109				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
1110				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-50">line 50</a>
1111			</li>
1112		</ul>
1113	</dd>
1114	
1115
1116	
1117
1118	
1119	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1120	<dd class="tag-see">
1121		<ul>
1122			<li><a href="CB_Net.html#.URIValueDecode"><code>CB_Net.URIValueDecode</code></a></li>
1123			</ul>
1124	</dd>
1125	
1126
1127	
1128</dl>
1129
1130
1131    
1132
1133    
1134
1135    
1136
1137    
1138
1139    
1140
1141    
1142
1143    
1144</dd>
1145
1146        
1147            
1148<hr>
1149<dt>
1150    <h4 class="name" id=".URLValueEncode"><span class="type-signature">&lt;static> </span>URLValueEncode<span class="signature">()</span><span class="type-signature"></span></h4>
1151    
1152    
1153</dt>
1154<dd>
1155
1156    
1157    <div class="description">
1158        <p>Alias for <a href="CB_Net.html#.URIValueEncode"><code>CB_Net.URIValueEncode</code></a>.</p>
1159    </div>
1160    
1161
1162    
1163
1164    
1165
1166    
1167    
1168
1169    
1170<dl class="details">
1171    
1172
1173	
1174
1175	
1176
1177	
1178
1179    
1180
1181    
1182
1183    
1184
1185    
1186
1187	
1188
1189	
1190
1191	
1192
1193	
1194
1195	
1196
1197
1198
1199	
1200	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1201	<dd class="tag-source">
1202		<ul class="dummy">
1203			<li>
1204				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
1205				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-31">line 31</a>
1206			</li>
1207		</ul>
1208	</dd>
1209	
1210
1211	
1212
1213	
1214	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1215	<dd class="tag-see">
1216		<ul>
1217			<li><a href="CB_Net.html#.URIValueEncode"><code>CB_Net.URIValueEncode</code></a></li>
1218			</ul>
1219	</dd>
1220	
1221
1222	
1223</dl>
1224
1225
1226    
1227
1228    
1229
1230    
1231
1232    
1233
1234    
1235
1236    
1237
1238    
1239</dd>
1240
1241        
1242            
1243<hr>
1244<dt>
1245    <h4 class="name" id=".combineURIParameters"><span class="type-signature">&lt;static> </span>combineURIParameters<span class="signature">()</span><span class="type-signature"></span></h4>
1246    
1247    
1248</dt>
1249<dd>
1250
1251    
1252    <div class="description">
1253        <p>Alias for <a href="global.html#CB_combineURIParameters"><code>CB_combineURIParameters</code></a>.</p>
1254    </div>
1255    
1256
1257    
1258
1259    
1260
1261    
1262    
1263
1264    
1265<dl class="details">
1266    
1267
1268	
1269
1270	
1271
1272	
1273
1274    
1275
1276    
1277
1278    
1279
1280    
1281
1282	
1283
1284	
1285
1286	
1287
1288	
1289
1290	
1291
1292
1293
1294	
1295	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1296	<dd class="tag-source">
1297		<ul class="dummy">
1298			<li>
1299				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
1300				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-322">line 322</a>
1301			</li>
1302		</ul>
1303	</dd>
1304	
1305
1306	
1307
1308	
1309	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1310	<dd class="tag-see">
1311		<ul>
1312			<li><a href="global.html#CB_combineURIParameters"><code>CB_combineURIParameters</code></a></li>
1313			</ul>
1314	</dd>
1315	
1316
1317	
1318</dl>
1319
1320
1321    
1322
1323    
1324
1325    
1326
1327    
1328
1329    
1330
1331    
1332
1333    
1334</dd>
1335
1336        
1337            
1338<hr>
1339<dt>
1340    <h4 class="name" id=".combineURLParameters"><span class="type-signature">&lt;static> </span>combineURLParameters<span class="signature">()</span><span class="type-signature"></span></h4>
1341    
1342    
1343</dt>
1344<dd>
1345
1346    
1347    <div class="description">
1348        <p>Alias for <a href="CB_Net.html#.combineURIParameters"><code>CB_Net.combineURIParameters</code></a>.</p>
1349    </div>
1350    
1351
1352    
1353
1354    
1355
1356    
1357    
1358
1359    
1360<dl class="details">
1361    
1362
1363	
1364
1365	
1366
1367	
1368
1369    
1370
1371    
1372
1373    
1374
1375    
1376
1377	
1378
1379	
1380
1381	
1382
1383	
1384
1385	
1386
1387
1388
1389	
1390	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1391	<dd class="tag-source">
1392		<ul class="dummy">
1393			<li>
1394				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
1395				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-317">line 317</a>
1396			</li>
1397		</ul>
1398	</dd>
1399	
1400
1401	
1402
1403	
1404	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1405	<dd class="tag-see">
1406		<ul>
1407			<li><a href="CB_Net.html#.combineURIParameters"><code>CB_Net.combineURIParameters</code></a></li>
1408			</ul>
1409	</dd>
1410	
1411
1412	
1413</dl>
1414
1415
1416    
1417
1418    
1419
1420    
1421
1422    
1423
1424    
1425
1426    
1427
1428    
1429</dd>
1430
1431        
1432            
1433<hr>
1434<dt>
1435    <h4 class="name" id=".getHashParameters"><span class="type-signature">&lt;static> </span>getHashParameters<span class="signature">( [URI] [, exclude] [, includeOnly] [, includeIfNotExists] [, trim])</span><span class="type-signature"> &rarr; {string}</span></h4>
1436    
1437    
1438</dt>
1439<dd>
1440
1441    
1442    <div class="description">
1443        <p>Gets all the hash parameters (names and their values) from a given URI or from the current URL.<br>
1444<br /><br>
1445For example, if the URI provided is &quot;http://whatever.com/index.html?parameter1=value1&amp;parameter2=value2#hash_parameter1=hash_value1&amp;hash_parameter2=hash_value2&quot;, it will return<br>
1446&quot;hash_parameter1=hash_value1&amp;hash_parameter2=hash_value2&quot; (using the default options).</p>
1447    </div>
1448    
1449
1450    
1451
1452    
1453
1454    
1455    
1456        <h5>Parameters:</h5>
1457        
1458
1459<table class="params table table-striped">
1460    <thead>
1461    <tr>
1462        
1463        <th style="width:12%; min-width:110px;">Name</th>
1464        
1465
1466        <th style="width:12%; min-width:110px;">Type</th>
1467
1468        
1469        <th style="width:12%; min-width:110px;">Argument</th>
1470        
1471
1472        
1473        <th style="width:12%; min-width:110px;">Default</th>
1474        
1475
1476        <th class="last" style="min-width:310px;">Description</th>
1477    </tr>
1478    </thead>
1479
1480    <tbody>
1481    
1482
1483        <tr>
1484            
1485                <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>URI</code></td>
1486            
1487
1488            <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;">
1489            
1490                
1491<span class="param-type">string</span>
1492
1493
1494
1495            
1496            </td>
1497
1498            
1499                <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;">
1500                
1501                    &lt;optional><br>
1502                
1503
1504                
1505
1506                
1507                </td>
1508            
1509
1510            
1511                <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;">
1512                
1513                    <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
1514                
1515                </td>
1516            
1517
1518            <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 URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
1519        </tr>
1520
1521    
1522
1523        <tr>
1524            
1525                <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>exclude</code></td>
1526            
1527
1528            <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;">
1529            
1530                
1531<span class="param-type">array</span>
1532
1533
1534
1535            
1536            </td>
1537
1538            
1539                <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;">
1540                
1541                    &lt;optional><br>
1542                
1543
1544                
1545
1546                
1547                </td>
1548            
1549
1550            
1551                <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;">
1552                
1553                </td>
1554            
1555
1556            <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>A numeric array containing the name of the parameters that we want to exclude in the returned string. It will exclude them even if they are contained in the given &quot;includeOnly&quot; parameter (if any).</p></td>
1557        </tr>
1558
1559    
1560
1561        <tr>
1562            
1563                <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>includeOnly</code></td>
1564            
1565
1566            <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;">
1567            
1568                
1569<span class="param-type">array</span>
1570
1571
1572
1573            
1574            </td>
1575
1576            
1577                <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;">
1578                
1579                    &lt;optional><br>
1580                
1581
1582                
1583
1584                
1585                </td>
1586            
1587
1588            
1589                <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;">
1590                
1591                </td>
1592            
1593
1594            <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>A numeric array containing the name of the parameters that we want to include in the returned string. If provided, it will only include these ones to the returned string (unless they are included in the &quot;exclude&quot; parameter).</p></td>
1595        </tr>
1596
1597    
1598
1599        <tr>
1600            
1601                <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>includeIfNotExists</code></td>
1602            
1603
1604            <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;">
1605            
1606                
1607<span class="param-type">boolean</span>
1608
1609
1610
1611            
1612            </td>
1613
1614            
1615                <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;">
1616                
1617                    &lt;optional><br>
1618                
1619
1620                
1621
1622                
1623                </td>
1624            
1625
1626            
1627                <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;">
1628                
1629                    false
1630                
1631                </td>
1632            
1633
1634            <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 and an array is given as the &quot;includeOnly&quot; parameter, it will add the parameters in the &quot;includeOnly&quot; array (with empty values) in the returned string even when they did not exist in the original URI provided.</p></td>
1635        </tr>
1636
1637    
1638
1639        <tr>
1640            
1641                <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>trim</code></td>
1642            
1643
1644            <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;">
1645            
1646                
1647<span class="param-type">boolean</span>
1648
1649
1650
1651            
1652            </td>
1653
1654            
1655                <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;">
1656                
1657                    &lt;optional><br>
1658                
1659
1660                
1661
1662                
1663                </td>
1664            
1665
1666            
1667                <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;">
1668                
1669                    true
1670                
1671                </td>
1672            
1673
1674            <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>It will use this option when it calls the <a href="CB_Net.html#.getURIParameters"><code>CB_Net.getURIParameters</code></a> function internally.</p></td>
1675        </tr>
1676
1677    
1678    </tbody>
1679</table>
1680
1681    
1682
1683    
1684<dl class="details">
1685    
1686
1687	
1688
1689	
1690
1691	
1692
1693    
1694
1695    
1696
1697    
1698
1699    
1700
1701	
1702
1703	
1704
1705	
1706
1707	
1708
1709	
1710
1711
1712
1713	
1714	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1715	<dd class="tag-source">
1716		<ul class="dummy">
1717			<li>
1718				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
1719				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-216">line 216</a>
1720			</li>
1721		</ul>
1722	</dd>
1723	
1724
1725	
1726
1727	
1728
1729	
1730</dl>
1731
1732
1733    
1734
1735    
1736
1737    
1738
1739    
1740
1741    
1742
1743    
1744    <h5>Returns:</h5>
1745    
1746            
1747<div class="param-desc">
1748    <p>An empty string will be returned if no parameters can be found.</p>
1749</div>
1750
1751
1752
1753<dl>
1754    <dt>
1755        Type
1756    </dt>
1757    <dd>
1758        
1759<span class="param-type">string</span>
1760
1761
1762
1763    </dd>
1764</dl>
1765
1766
1767        
1768
1769    
1770</dd>
1771
1772        
1773            
1774<hr>
1775<dt>
1776    <h4 class="name" id=".getHashValue"><span class="type-signature">&lt;static> </span>getHashValue<span class="signature">(index [, trim] [, URI])</span><span class="type-signature"> &rarr; {string}</span></h4>
1777    
1778    
1779</dt>
1780<dd>
1781
1782    
1783    <div class="description">
1784        <p>Gets the value of a specific hash (string after &quot;#&quot;) parameter from the current URL or a desired URI.<br>
1785<br /><br>
1786For example, if the URI provided is &quot;http://whatever.com/index.html?parameter1=value1&amp;parameter2=value2#hash_parameter1=hash_value1&amp;hash_parameter2=hash_value2&quot; and the index given is &quot;hash_parameter1&quot;,<br>
1787it will return &quot;hash_value1&quot; (using the default options).</p>
1788    </div>
1789    
1790
1791    
1792
1793    
1794
1795    
1796    
1797        <h5>Parameters:</h5>
1798        
1799
1800<table class="params table table-striped">
1801    <thead>
1802    <tr>
1803        
1804        <th style="width:12%; min-width:110px;">Name</th>
1805        
1806
1807        <th style="width:12%; min-width:110px;">Type</th>
1808
1809        
1810        <th style="width:12%; min-width:110px;">Argument</th>
1811        
1812
1813        
1814        <th style="width:12%; min-width:110px;">Default</th>
1815        
1816
1817        <th class="last" style="min-width:310px;">Description</th>
1818    </tr>
1819    </thead>
1820
1821    <tbody>
1822    
1823
1824        <tr>
1825            
1826                <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>index</code></td>
1827            
1828
1829            <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;">
1830            
1831                
1832<span class="param-type">string</span>
1833
1834
1835
1836            
1837            </td>
1838
1839            
1840                <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;">
1841                
1842
1843                
1844
1845                
1846                </td>
1847            
1848
1849            
1850                <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;">
1851                
1852                </td>
1853            
1854
1855            <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 name of the parameter whose value we want to get.</p></td>
1856        </tr>
1857
1858    
1859
1860        <tr>
1861            
1862                <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>trim</code></td>
1863            
1864
1865            <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;">
1866            
1867                
1868<span class="param-type">boolean</span>
1869
1870
1871
1872            
1873            </td>
1874
1875            
1876                <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;">
1877                
1878                    &lt;optional><br>
1879                
1880
1881                
1882
1883                
1884                </td>
1885            
1886
1887            
1888                <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;">
1889                
1890                    true
1891                
1892                </td>
1893            
1894
1895            <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>It will trim the value (using <a href="CB_Net.html#.getParameter"><code>CB_Net.getParameter</code></a> internally) before returning it.</p></td>
1896        </tr>
1897
1898    
1899
1900        <tr>
1901            
1902                <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>URI</code></td>
1903            
1904
1905            <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;">
1906            
1907                
1908<span class="param-type">string</span>
1909
1910
1911
1912            
1913            </td>
1914
1915            
1916                <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;">
1917                
1918                    &lt;optional><br>
1919                
1920
1921                
1922
1923                
1924                </td>
1925            
1926
1927            
1928                <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;">
1929                
1930                    <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
1931                
1932                </td>
1933            
1934
1935            <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 URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
1936        </tr>
1937
1938    
1939    </tbody>
1940</table>
1941
1942    
1943
1944    
1945<dl class="details">
1946    
1947
1948	
1949
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	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1976	<dd class="tag-source">
1977		<ul class="dummy">
1978			<li>
1979				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
1980				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-311">line 311</a>
1981			</li>
1982		</ul>
1983	</dd>
1984	
1985
1986	
1987
1988	
1989
1990	
1991</dl>
1992
1993
1994    
1995
1996    
1997
1998    
1999
2000    
2001
2002    
2003
2004    
2005    <h5>Returns:</h5>
2006    
2007            
2008<div class="param-desc">
2009    <p>An empty string will be returned if the value of the given parameter cannot be found.</p>
2010</div>
2011
2012
2013
2014<dl>
2015    <dt>
2016        Type
2017    </dt>
2018    <dd>
2019        
2020<span class="param-type">string</span>
2021
2022
2023
2024    </dd>
2025</dl>
2026
2027
2028        
2029
2030    
2031</dd>
2032
2033        
2034            
2035<hr>
2036<dt>
2037    <h4 class="name" id=".getParameter"><span class="type-signature">&lt;static> </span>getParameter<span class="signature">(index [, trim] [, URI] [, firstDelimiter] [, lastDelimiter] [, concatenator] [, nameValueSeparator])</span><span class="type-signature"> &rarr; {string}</span></h4>
2038    
2039    
2040</dt>
2041<dd>
2042
2043    
2044    <div class="description">
2045        <p>Gets the value of a specific URI parameter (query or hash), respecting GET/URL rules by default, from the current URL or a desired one (with the given delimiters).<br>
2046<br /><br>
2047For example, if the URI provided is &quot;http://whatever.com/index.html?parameter1=value1&amp;parameter2=value2#hash_parameter1=hash_value1&amp;hash_parameter2=hash_value2&quot; and the index given is &quot;parameter1&quot;, it will return &quot;value1&quot; (using the default options).</p>
2048    </div>
2049    
2050
2051    
2052
2053    
2054
2055    
2056    
2057        <h5>Parameters:</h5>
2058        
2059
2060<table class="params table table-striped">
2061    <thead>
2062    <tr>
2063        
2064        <th style="width:12%; min-width:110px;">Name</th>
2065        
2066
2067        <th style="width:12%; min-width:110px;">Type</th>
2068
2069        
2070        <th style="width:12%; min-width:110px;">Argument</th>
2071        
2072
2073        
2074        <th style="width:12%; min-width:110px;">Default</th>
2075        
2076
2077        <th class="last" style="min-width:310px;">Description</th>
2078    </tr>
2079    </thead>
2080
2081    <tbody>
2082    
2083
2084        <tr>
2085            
2086                <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>index</code></td>
2087            
2088
2089            <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;">
2090            
2091                
2092<span class="param-type">string</span>
2093
2094
2095
2096            
2097            </td>
2098
2099            
2100                <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;">
2101                
2102
2103                
2104
2105                
2106                </td>
2107            
2108
2109            
2110                <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;">
2111                
2112                </td>
2113            
2114
2115            <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 name of the parameter whose value we want to get.</p></td>
2116        </tr>
2117
2118    
2119
2120        <tr>
2121            
2122                <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>trim</code></td>
2123            
2124
2125            <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;">
2126            
2127                
2128<span class="param-type">boolean</span>
2129
2130
2131
2132            
2133            </td>
2134
2135            
2136                <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;">
2137                
2138                    &lt;optional><br>
2139                
2140
2141                
2142
2143                
2144                </td>
2145            
2146
2147            
2148                <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;">
2149                
2150                    true
2151                
2152                </td>
2153            
2154
2155            <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>It will trim the value (using <a href="global.html#CB_trim"><code>CB_trim</code></a> internally) before returning it.</p></td>
2156        </tr>
2157
2158    
2159
2160        <tr>
2161            
2162                <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>URI</code></td>
2163            
2164
2165            <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;">
2166            
2167                
2168<span class="param-type">string</span>
2169
2170
2171
2172            
2173            </td>
2174
2175            
2176                <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;">
2177                
2178                    &lt;optional><br>
2179                
2180
2181                
2182
2183                
2184                </td>
2185            
2186
2187            
2188                <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;">
2189                
2190                    <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
2191                
2192                </td>
2193            
2194
2195            <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 URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
2196        </tr>
2197
2198    
2199
2200        <tr>
2201            
2202                <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>firstDelimiter</code></td>
2203            
2204
2205            <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;">
2206            
2207                
2208<span class="param-type">string</span>
2209
2210
2211
2212            
2213            </td>
2214
2215            
2216                <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;">
2217                
2218                    &lt;optional><br>
2219                
2220
2221                
2222
2223                
2224                </td>
2225            
2226
2227            
2228                <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;">
2229                
2230                    '?'
2231                
2232                </td>
2233            
2234
2235            <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 string that indicates where the parameters start. If it is not provided, it will be &quot;?&quot; as default. If not provided and &quot;lastDelimiter&quot; is not provided either, it will be &quot;?&quot; and &quot;lastDelimiter&quot; will be &quot;#&quot;.</p></td>
2236        </tr>
2237
2238    
2239
2240        <tr>
2241            
2242                <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>lastDelimiter</code></td>
2243            
2244
2245            <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;">
2246            
2247                
2248<span class="param-type">string</span>
2249
2250
2251
2252            
2253            </td>
2254
2255            
2256                <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;">
2257                
2258                    &lt;optional><br>
2259                
2260
2261                
2262
2263                
2264                </td>
2265            
2266
2267            
2268                <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;">
2269                
2270                    undefined|'#'
2271                
2272                </td>
2273            
2274
2275            <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 string that indicates where the parameters end. If not provided and &quot;firstDelimiter&quot; is provided, it will stop at the end of the given URI. If it is not provided and &quot;firstDelimiter&quot; is not provided either, &quot;firstDelimiter&quot; will be &quot;?&quot; and &quot;lastDelimiter&quot; will be &quot;#&quot;.</p></td>
2276        </tr>
2277
2278    
2279
2280        <tr>
2281            
2282                <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>concatenator</code></td>
2283            
2284
2285            <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;">
2286            
2287                
2288<span class="param-type">string</span>
2289
2290
2291
2292            
2293            </td>
2294
2295            
2296                <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;">
2297                
2298                    &lt;optional><br>
2299                
2300
2301                
2302
2303                
2304                </td>
2305            
2306
2307            
2308                <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;">
2309                
2310                    '&amp;'
2311                
2312                </td>
2313            
2314
2315            <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 string that joints the different parameters.</p></td>
2316        </tr>
2317
2318    
2319
2320        <tr>
2321            
2322                <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>nameValueSeparator</code></td>
2323            
2324
2325            <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;">
2326            
2327                
2328<span class="param-type">string</span>
2329
2330
2331
2332            
2333            </td>
2334
2335            
2336                <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;">
2337                
2338                    &lt;optional><br>
2339                
2340
2341                
2342
2343                
2344                </td>
2345            
2346
2347            
2348                <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;">
2349                
2350                    '='
2351                
2352                </td>
2353            
2354
2355            <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 string that is the separator for the parameters and their values.</p></td>
2356        </tr>
2357
2358    
2359    </tbody>
2360</table>
2361
2362    
2363
2364    
2365<dl class="details">
2366    
2367
2368	
2369
2370	
2371
2372	
2373
2374    
2375
2376    
2377
2378    
2379
2380    
2381
2382	
2383
2384	
2385
2386	
2387
2388	
2389
2390	
2391
2392
2393
2394	
2395	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2396	<dd class="tag-source">
2397		<ul class="dummy">
2398			<li>
2399				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
2400				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-236">line 236</a>
2401			</li>
2402		</ul>
2403	</dd>
2404	
2405
2406	
2407
2408	
2409
2410	
2411</dl>
2412
2413
2414    
2415
2416    
2417
2418    
2419
2420    
2421
2422    
2423
2424    
2425    <h5>Returns:</h5>
2426    
2427            
2428<div class="param-desc">
2429    <p>An empty string will be returned if the value of the given parameter cannot be found.</p>
2430</div>
2431
2432
2433
2434<dl>
2435    <dt>
2436        Type
2437    </dt>
2438    <dd>
2439        
2440<span class="param-type">string</span>
2441
2442
2443
2444    </dd>
2445</dl>
2446
2447
2448        
2449
2450    
2451</dd>
2452
2453        
2454            
2455<hr>
2456<dt>
2457    <h4 class="name" id=".getURIParameters"><span class="type-signature">&lt;static> </span>getURIParameters<span class="signature">( [URI] [, exclude] [, includeOnly] [, includeIfNotExists] [, trim] [, firstDelimiter] [, lastDelimiter] [, concatenator] [, nameValueSeparator])</span><span class="type-signature"> &rarr; {string}</span></h4>
2458    
2459    
2460</dt>
2461<dd>
2462
2463    
2464    <div class="description">
2465        <p>Gets all the &quot;GET&quot; (query) parameters (names and their values) from a given URI or from the current URL.<br>
2466<br /><br>
2467For example, if the URI provided is &quot;http://whatever.com/index.html?parameter1=value1&amp;parameter2=value2#hash_parameter1=hash_value1&amp;hash_parameter2=hash_value2&quot;, it will return &quot;parameter1=value1&amp;parameter2=value2&quot; (using the default options).</p>
2468    </div>
2469    
2470
2471    
2472
2473    
2474
2475    
2476    
2477        <h5>Parameters:</h5>
2478        
2479
2480<table class="params table table-striped">
2481    <thead>
2482    <tr>
2483        
2484        <th style="width:12%; min-width:110px;">Name</th>
2485        
2486
2487        <th style="width:12%; min-width:110px;">Type</th>
2488
2489        
2490        <th style="width:12%; min-width:110px;">Argument</th>
2491        
2492
2493        
2494        <th style="width:12%; min-width:110px;">Default</th>
2495        
2496
2497        <th class="last" style="min-width:310px;">Description</th>
2498    </tr>
2499    </thead>
2500
2501    <tbody>
2502    
2503
2504        <tr>
2505            
2506                <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>URI</code></td>
2507            
2508
2509            <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;">
2510            
2511                
2512<span class="param-type">string</span>
2513
2514
2515
2516            
2517            </td>
2518
2519            
2520                <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;">
2521                
2522                    &lt;optional><br>
2523                
2524
2525                
2526
2527                
2528                </td>
2529            
2530
2531            
2532                <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;">
2533                
2534                    <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
2535                
2536                </td>
2537            
2538
2539            <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 URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
2540        </tr>
2541
2542    
2543
2544        <tr>
2545            
2546                <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>exclude</code></td>
2547            
2548
2549            <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;">
2550            
2551                
2552<span class="param-type">array</span>
2553
2554
2555
2556            
2557            </td>
2558
2559            
2560                <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;">
2561                
2562                    &lt;optional><br>
2563                
2564
2565                
2566
2567                
2568                </td>
2569            
2570
2571            
2572                <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;">
2573                
2574                </td>
2575            
2576
2577            <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>A numeric array containing the name of the parameters that we want to exclude in the returned string. It will exclude them even if they are contained in the given &quot;includeOnly&quot; parameter (if any).</p></td>
2578        </tr>
2579
2580    
2581
2582        <tr>
2583            
2584                <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>includeOnly</code></td>
2585            
2586
2587            <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;">
2588            
2589                
2590<span class="param-type">array</span>
2591
2592
2593
2594            
2595            </td>
2596
2597            
2598                <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;">
2599                
2600                    &lt;optional><br>
2601                
2602
2603                
2604
2605                
2606                </td>
2607            
2608
2609            
2610                <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;">
2611                
2612                </td>
2613            
2614
2615            <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>A numeric array containing the name of the parameters that we want to include in the returned string. If provided, it will only include these ones to the returned string (unless they are included in the &quot;exclude&quot; parameter).</p></td>
2616        </tr>
2617
2618    
2619
2620        <tr>
2621            
2622                <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>includeIfNotExists</code></td>
2623            
2624
2625            <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;">
2626            
2627                
2628<span class="param-type">boolean</span>
2629
2630
2631
2632            
2633            </td>
2634
2635            
2636                <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;">
2637                
2638                    &lt;optional><br>
2639                
2640
2641                
2642
2643                
2644                </td>
2645            
2646
2647            
2648                <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;">
2649                
2650                    false
2651                
2652                </td>
2653            
2654
2655            <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 and an array is given as the &quot;includeOnly&quot; parameter, it will add the parameters in the &quot;includeOnly&quot; array (with empty values) in the returned string even when they did not exist in the original URI provided.</p></td>
2656        </tr>
2657
2658    
2659
2660        <tr>
2661            
2662                <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>trim</code></td>
2663            
2664
2665            <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;">
2666            
2667                
2668<span class="param-type">boolean</span>
2669
2670
2671
2672            
2673            </td>
2674
2675            
2676                <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;">
2677                
2678                    &lt;optional><br>
2679                
2680
2681                
2682
2683                
2684                </td>
2685            
2686
2687            
2688                <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;">
2689                
2690                    true
2691                
2692                </td>
2693            
2694
2695            <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to trim the spaces around the values or not.</p></td>
2696        </tr>
2697
2698    
2699
2700        <tr>
2701            
2702                <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>firstDelimiter</code></td>
2703            
2704
2705            <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;">
2706            
2707                
2708<span class="param-type">string</span>
2709
2710
2711
2712            
2713            </td>
2714
2715            
2716                <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;">
2717                
2718                    &lt;optional><br>
2719                
2720
2721                
2722
2723                
2724                </td>
2725            
2726
2727            
2728                <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;">
2729                
2730                    '?'
2731                
2732                </td>
2733            
2734
2735            <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 string that indicates where the parameters start. If it is not provided, it will be &quot;?&quot; as default. If not provided and &quot;lastDelimiter&quot; is not provided either, it will be &quot;?&quot; and &quot;lastDelimiter&quot; will be &quot;#&quot;.</p></td>
2736        </tr>
2737
2738    
2739
2740        <tr>
2741            
2742                <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>lastDelimiter</code></td>
2743            
2744
2745            <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;">
2746            
2747                
2748<span class="param-type">string</span>
2749
2750
2751
2752            
2753            </td>
2754
2755            
2756                <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;">
2757                
2758                    &lt;optional><br>
2759                
2760
2761                
2762
2763                
2764                </td>
2765            
2766
2767            
2768                <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;">
2769                
2770                    undefined|'#'
2771                
2772                </td>
2773            
2774
2775            <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 string that indicates where the parameters end. If not provided and &quot;firstDelimiter&quot; is provided, it will stop at the end of the given URI. If it is not provided and &quot;firstDelimiter&quot; is not provided either, &quot;firstDelimiter&quot; will be &quot;?&quot; and &quot;lastDelimiter&quot; will be &quot;#&quot;.</p></td>
2776        </tr>
2777
2778    
2779
2780        <tr>
2781            
2782                <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>concatenator</code></td>
2783            
2784
2785            <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;">
2786            
2787                
2788<span class="param-type">string</span>
2789
2790
2791
2792            
2793            </td>
2794
2795            
2796                <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;">
2797                
2798                    &lt;optional><br>
2799                
2800
2801                
2802
2803                
2804                </td>
2805            
2806
2807            
2808                <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;">
2809                
2810                    '&amp;'
2811                
2812                </td>
2813            
2814
2815            <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 string that joints the different parameters.</p></td>
2816        </tr>
2817
2818    
2819
2820        <tr>
2821            
2822                <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>nameValueSeparator</code></td>
2823            
2824
2825            <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;">
2826            
2827                
2828<span class="param-type">string</span>
2829
2830
2831
2832            
2833            </td>
2834
2835            
2836                <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;">
2837                
2838                    &lt;optional><br>
2839                
2840
2841                
2842
2843                
2844                </td>
2845            
2846
2847            
2848                <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;">
2849                
2850                    '='
2851                
2852                </td>
2853            
2854
2855            <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 string that is the separator for the parameters and their values.</p></td>
2856        </tr>
2857
2858    
2859    </tbody>
2860</table>
2861
2862    
2863
2864    
2865<dl class="details">
2866    
2867
2868	
2869
2870	
2871
2872	
2873
2874    
2875
2876    
2877
2878    
2879
2880    
2881
2882	
2883
2884	
2885
2886	
2887
2888	
2889
2890	
2891
2892
2893
2894	
2895	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2896	<dd class="tag-source">
2897		<ul class="dummy">
2898			<li>
2899				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
2900				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-123">line 123</a>
2901			</li>
2902		</ul>
2903	</dd>
2904	
2905
2906	
2907
2908	
2909
2910	
2911</dl>
2912
2913
2914    
2915
2916    
2917
2918    
2919
2920    
2921
2922    
2923
2924    
2925    <h5>Returns:</h5>
2926    
2927            
2928<div class="param-desc">
2929    <p>An empty string will be returned if no parameters can be found.</p>
2930</div>
2931
2932
2933
2934<dl>
2935    <dt>
2936        Type
2937    </dt>
2938    <dd>
2939        
2940<span class="param-type">string</span>
2941
2942
2943
2944    </dd>
2945</dl>
2946
2947
2948        
2949
2950    
2951</dd>
2952
2953        
2954            
2955<hr>
2956<dt>
2957    <h4 class="name" id=".getURIValue"><span class="type-signature">&lt;static> </span>getURIValue<span class="signature">(index [, trim] [, URI])</span><span class="type-signature"> &rarr; {string}</span></h4>
2958    
2959    
2960</dt>
2961<dd>
2962
2963    
2964    <div class="description">
2965        <p>Gets the value of a specific URI &quot;GET&quot; parameter (query) from the current URL or a desired URI.<br>
2966<br /><br>
2967For example, if the URI provided is &quot;http://whatever.com/index.html?parameter1=value1&amp;parameter2=value2#hash_parameter1=hash_value1&amp;hash_parameter2=hash_value2&quot; and the index given is &quot;parameter1&quot;, it will return &quot;value1&quot; (using the default options).</p>
2968    </div>
2969    
2970
2971    
2972
2973    
2974
2975    
2976    
2977        <h5>Parameters:</h5>
2978        
2979
2980<table class="params table table-striped">
2981    <thead>
2982    <tr>
2983        
2984        <th style="width:12%; min-width:110px;">Name</th>
2985        
2986
2987        <th style="width:12%; min-width:110px;">Type</th>
2988
2989        
2990        <th style="width:12%; min-width:110px;">Argument</th>
2991        
2992
2993        
2994        <th style="width:12%; min-width:110px;">Default</th>
2995        
2996
2997        <th class="last" style="min-width:310px;">Description</th>
2998    </tr>
2999    </thead>
3000
3001    <tbody>
3002    
3003
3004        <tr>
3005            
3006                <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>index</code></td>
3007            
3008
3009            <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;">
3010            
3011                
3012<span class="param-type">string</span>
3013
3014
3015
3016            
3017            </td>
3018
3019            
3020                <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;">
3021                
3022
3023                
3024
3025                
3026                </td>
3027            
3028
3029            
3030                <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;">
3031                
3032                </td>
3033            
3034
3035            <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 name of the parameter whose value we want to get.</p></td>
3036        </tr>
3037
3038    
3039
3040        <tr>
3041            
3042                <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>trim</code></td>
3043            
3044
3045            <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;">
3046            
3047                
3048<span class="param-type">boolean</span>
3049
3050
3051
3052            
3053            </td>
3054
3055            
3056                <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;">
3057                
3058                    &lt;optional><br>
3059                
3060
3061                
3062
3063                
3064                </td>
3065            
3066
3067            
3068                <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;">
3069                
3070                    true
3071                
3072                </td>
3073            
3074
3075            <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>It will trim the value (using <a href="CB_Net.html#.getParameter"><code>CB_Net.getParameter</code></a> internally) before returning it.</p></td>
3076        </tr>
3077
3078    
3079
3080        <tr>
3081            
3082                <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>URI</code></td>
3083            
3084
3085            <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;">
3086            
3087                
3088<span class="param-type">string</span>
3089
3090
3091
3092            
3093            </td>
3094
3095            
3096                <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;">
3097                
3098                    &lt;optional><br>
3099                
3100
3101                
3102
3103                
3104                </td>
3105            
3106
3107            
3108                <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;">
3109                
3110                    <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
3111                
3112                </td>
3113            
3114
3115            <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 URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
3116        </tr>
3117
3118    
3119    </tbody>
3120</table>
3121
3122    
3123
3124    
3125<dl class="details">
3126    
3127
3128	
3129
3130	
3131
3132	
3133
3134    
3135
3136    
3137
3138    
3139
3140    
3141
3142	
3143
3144	
3145
3146	
3147
3148	
3149
3150	
3151
3152
3153
3154	
3155	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3156	<dd class="tag-source">
3157		<ul class="dummy">
3158			<li>
3159				<a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
3160				 <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-294">line 294</a>
3161			</li>
3162		</ul>
3163	</dd>
3164	
3165
3166	
3167
3168	
3169
3170	
3171</dl>
3172
3173
3174    
3175
3176    
3177
3178    
3179
3180    
3181
3182    
3183
3184    
3185    <h5>Returns:</h5>
3186    
3187            
3188<div class="param-desc">
3189    <p>An empty string will be returned if the value of the given parameter cannot be found.</p>
3190</div>
3191
3192
3193
3194<dl>
3195    <dt>
3196        Type
3197    </dt>
3198    <dd>
3199        
3200<span class="param-type">string</span>
3201
3202
3203
3204    </dd>
3205</dl>
3206
3207
3208        
3209
3210    
3211</dd>
3212
3213        </dl>
3214    
3215
3216    
3217
3218    
3219</article>
3220
3221</section>
3222
3223
3224
3225
3226		</div>
3227	</div>
3228
3229	<div class="clearfix"></div>
3230
3231	
3232		<div class="col-md-3">
3233			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
3234		</div>
3235	
3236
3237</div>
3238</div>
3239
3240
3241    <div class="modal fade" id="searchResults">
3242      <div class="modal-dialog">
3243        <div class="modal-content">
3244          <div class="modal-header">
3245            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
3246            <h4 class="modal-title">Search results</h4>
3247          </div>
3248          <div class="modal-body"></div>
3249          <div class="modal-footer">
3250            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
3251          </div>
3252        </div><!-- /.modal-content -->
3253      </div><!-- /.modal-dialog -->
3254    </div>
3255
3256
3257<footer>
3258
3259
3260	<span class="copyright">
3261	<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>
3262	</span>
3263
3264<span class="jsdoc-message">
3265	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
3266	
3267		on Wed Mar 22nd 2023
3268	
3269	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
3270</span>
3271</footer>
3272
3273<script src="scripts/docstrap.lib.js"></script>
3274<script src="scripts/toc.js"></script>
3275
3276    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
3277
3278
3279<script>
3280$( function () {
3281	$( "[id*='$']" ).each( function () {
3282		var $this = $( this );
3283
3284		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
3285	} );
3286
3287	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
3288		var $this = $( this );
3289
3290		var example = $this.find( "code" );
3291		exampleText = example.html();
3292		var lang = /{@lang (.*?)}/.exec( exampleText );
3293		if ( lang && lang[1] ) {
3294			exampleText = exampleText.replace( lang[0], "" );
3295			example.html( exampleText );
3296			lang = lang[1];
3297		} else {
3298			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
3299			lang = langClassMatch ? langClassMatch[1] : "javascript";
3300		}
3301
3302		if ( lang ) {
3303
3304			$this
3305			.addClass( "sunlight-highlight-" + lang )
3306			.addClass( "linenums" )
3307			.html( example.html() );
3308
3309		}
3310	} );
3311
3312	Sunlight.highlightAll( {
3313		lineNumbers : true,
3314		showMenu : true,
3315		enableDoclinks : true
3316	} );
3317
3318	$.catchAnchorLinks( {
3319        navbarOffset: 10
3320	} );
3321	$( "#toc" ).toc( {
3322		anchorName  : function ( i, heading, prefix ) {
3323			return $( heading ).attr( "id" ) || ( prefix + i );
3324		},
3325		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
3326		showAndHide : false,
3327		smoothScrolling: true
3328	} );
3329
3330	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
3331	$( '.dropdown-toggle' ).dropdown();
3332
3333    $( "table" ).each( function () {
3334      var $this = $( this );
3335      $this.addClass('table');
3336    } );
3337
3338} );
3339</script>
3340
3341
3342
3343<!--Navigation and Symbol Display-->
3344
3345<script>
3346	$( function () {
3347		$( '#main' ).localScroll( {
3348			offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
3349		} );
3350		$( "dt.name" ).each( function () {
3351			var $this = $( this ).find("h4");
3352			var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
3353			var dt = $(this);
3354			var children = dt.next( "dd" );
3355
3356			dt.prepend( icon ).css( {cursor : "pointer"} );
3357			dt.addClass( "member-collapsed" ).addClass( "member" );
3358
3359
3360			children.hide();
3361
3362			dt.children().on( "click", function () {
3363				children = dt.next( "dd" );
3364				children.slideToggle( "fast", function () {
3365
3366					if ( children.is( ":visible" ) ) {
3367						icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
3368						dt.addClass( "member-open" ).animate( "member-collapsed" );
3369					} else {
3370						icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
3371						dt.addClass( "member-collapsed" ).removeClass( "member-open" );
3372					}
3373				} );
3374			} );
3375
3376		} );
3377	} );
3378</script>
3379
3380
3381<!--Google Analytics-->
3382
3383
3384
3385    <script type="text/javascript">
3386        $(document).ready(function() {
3387            SearcherDisplay.init();
3388        });
3389    </script>
3390
3391
3392</body>
3393</html>
\No newline at end of file