UNPKG

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