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: XHR</title>
|
8 |
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
13 |
|
14 | <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
|
15 |
|
16 | </head>
|
17 |
|
18 | <body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
19 |
|
20 | <div class="navbar navbar-default navbar-fixed-top ">
|
21 | <div class="container">
|
22 | <div class="navbar-header">
|
23 | <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
|
24 | <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
25 | <span class="icon-bar"></span>
|
26 | <span class="icon-bar"></span>
|
27 | <span class="icon-bar"></span>
|
28 | </button>
|
29 | </div>
|
30 | <div class="navbar-collapse collapse" id="topNavigation">
|
31 | <ul class="nav navbar-nav">
|
32 |
|
33 | <li class="dropdown">
|
34 | <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
|
35 | <ul class="dropdown-menu inline">
|
36 | <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li>
|
37 | </ul>
|
38 | </li>
|
39 |
|
40 | <li class="dropdown">
|
41 | <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
|
42 | <ul class="dropdown-menu inline">
|
43 | <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
|
44 | </ul>
|
45 | </li>
|
46 |
|
47 | <li class="dropdown">
|
48 | <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
|
49 | <ul class="dropdown-menu inline">
|
50 | <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li>
|
51 | </ul>
|
52 | </li>
|
53 |
|
54 | </ul>
|
55 |
|
56 | <div class="col-sm-3 col-md-3">
|
57 | <form class="navbar-form" role="search">
|
58 | <div class="input-group">
|
59 | <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
60 | <div class="input-group-btn">
|
61 | <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
62 | </div>
|
63 | </div>
|
64 | </form>
|
65 | </div>
|
66 |
|
67 | </div>
|
68 |
|
69 | </div>
|
70 | </div>
|
71 |
|
72 |
|
73 | <div class="container" id="toc-content" style="width:100%;">
|
74 | <div class="row" style="width:100%;">
|
75 |
|
76 |
|
77 | <div class="col-md-8" style="width:85%;">
|
78 |
|
79 | <div id="main">
|
80 |
|
81 |
|
82 |
|
83 | <h1 class="page-title">Namespace: XHR</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 | XHR
|
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://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XMLHttpRequest</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR</a>, <a href="https://en.wikipedia.org/wiki/Ajax_(programming)">AJAX</a>) 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_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
142 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-15">line 15</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 providing an easy way to abort XHR (AJAX) calls.</li>
|
157 | </ul>
|
158 | </dd>
|
159 |
|
160 | </dl>
|
161 |
|
162 |
|
163 |
|
164 |
|
165 | </div>
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 |
|
179 |
|
180 | <h3 class="subsection-title">Methods</h3>
|
181 |
|
182 | <dl>
|
183 |
|
184 | <hr>
|
185 | <dt>
|
186 | <h4 class="name" id=".call"><span class="type-signature"><static> </span>call<span class="signature">(URL [, method] [, data] [, headers] [, responseType] [, mimeType] [, callbackFunction] [, callbackFunctionOK] [, callbackFunctionError] [, allowedSuccessStatuses] [, asynchronous] [, XHR])</span><span class="type-signature"> → {Object|null}</span></h4>
|
187 |
|
188 |
|
189 | </dt>
|
190 | <dd>
|
191 |
|
192 |
|
193 | <div class="description">
|
194 | <p>Performs an <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>) call.</p>
|
195 | </div>
|
196 |
|
197 |
|
198 |
|
199 |
|
200 |
|
201 |
|
202 |
|
203 |
|
204 | <h5>Parameters:</h5>
|
205 |
|
206 |
|
207 | <table class="params table table-striped">
|
208 | <thead>
|
209 | <tr>
|
210 |
|
211 | <th style="width:12%; min-width:110px;">Name</th>
|
212 |
|
213 |
|
214 | <th style="width:12%; min-width:110px;">Type</th>
|
215 |
|
216 |
|
217 | <th style="width:12%; min-width:110px;">Argument</th>
|
218 |
|
219 |
|
220 |
|
221 | <th style="width:12%; min-width:110px;">Default</th>
|
222 |
|
223 |
|
224 | <th class="last" style="min-width:310px;">Description</th>
|
225 | </tr>
|
226 | </thead>
|
227 |
|
228 | <tbody>
|
229 |
|
230 |
|
231 | <tr>
|
232 |
|
233 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>URL</code></td>
|
234 |
|
235 |
|
236 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
237 |
|
238 |
|
239 | <span class="param-type">string</span>
|
240 |
|
241 |
|
242 |
|
243 |
|
244 | </td>
|
245 |
|
246 |
|
247 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 | </td>
|
254 |
|
255 |
|
256 |
|
257 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
258 |
|
259 | </td>
|
260 |
|
261 |
|
262 | <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 URL that we want to call. It can also contain URL (GET) parameters.</p></td>
|
263 | </tr>
|
264 |
|
265 |
|
266 |
|
267 | <tr>
|
268 |
|
269 | <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>method</code></td>
|
270 |
|
271 |
|
272 | <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;">
|
273 |
|
274 |
|
275 | <span class="param-type">string</span>
|
276 |
|
277 |
|
278 |
|
279 |
|
280 | </td>
|
281 |
|
282 |
|
283 | <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;">
|
284 |
|
285 | <optional><br>
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
|
291 | </td>
|
292 |
|
293 |
|
294 |
|
295 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
296 |
|
297 | 'POST'
|
298 |
|
299 | </td>
|
300 |
|
301 |
|
302 | <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/HTTP/Methods">HTTP method</a> that will be used to perform the call (GET, POST, PUT, DELETE, etc.).</p></td>
|
303 | </tr>
|
304 |
|
305 |
|
306 |
|
307 | <tr>
|
308 |
|
309 | <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>data</code></td>
|
310 |
|
311 |
|
312 | <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;">
|
313 |
|
314 |
|
315 | <span class="param-type">string</span>
|
316 | |
|
317 |
|
318 | <span class="param-type">Object</span>
|
319 |
|
320 |
|
321 |
|
322 |
|
323 | </td>
|
324 |
|
325 |
|
326 | <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;">
|
327 |
|
328 | <optional><br>
|
329 |
|
330 |
|
331 |
|
332 |
|
333 |
|
334 | </td>
|
335 |
|
336 |
|
337 |
|
338 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
339 |
|
340 | </td>
|
341 |
|
342 |
|
343 | <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 data that we want to send. If a string is given and "GET" method is being used, it will assume they are GET (URL) parameters and will be attached at the end of the URL given. If something which is not a string is given, it will assume it is a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object and will try to convert it into a string (using the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">JSON.stringify</a> function internally) before sending it.</p></td>
|
344 | </tr>
|
345 |
|
346 |
|
347 |
|
348 | <tr>
|
349 |
|
350 | <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>headers</code></td>
|
351 |
|
352 |
|
353 | <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;">
|
354 |
|
355 |
|
356 | <span class="param-type"><a href="CB_Net.XHR.html#.HEADERS">CB_Net.XHR.HEADERS</a></span>
|
357 |
|
358 |
|
359 |
|
360 |
|
361 | </td>
|
362 |
|
363 |
|
364 | <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;">
|
365 |
|
366 | <optional><br>
|
367 |
|
368 |
|
369 |
|
370 |
|
371 |
|
372 | </td>
|
373 |
|
374 |
|
375 |
|
376 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
377 |
|
378 | </td>
|
379 |
|
380 |
|
381 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Object containing the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP header</a> names and their values that we want to send (used internally by the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader">setRequestHeader</a> method of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a>).</p></td>
|
382 | </tr>
|
383 |
|
384 |
|
385 |
|
386 | <tr>
|
387 |
|
388 | <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>responseType</code></td>
|
389 |
|
390 |
|
391 | <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;">
|
392 |
|
393 |
|
394 | <span class="param-type">string</span>
|
395 |
|
396 |
|
397 |
|
398 |
|
399 | </td>
|
400 |
|
401 |
|
402 | <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;">
|
403 |
|
404 | <optional><br>
|
405 |
|
406 |
|
407 |
|
408 |
|
409 |
|
410 | </td>
|
411 |
|
412 |
|
413 |
|
414 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
415 |
|
416 | </td>
|
417 |
|
418 |
|
419 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If provided, it will be used for the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType">responseType</a> property of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> (if available).</p></td>
|
420 | </tr>
|
421 |
|
422 |
|
423 |
|
424 | <tr>
|
425 |
|
426 | <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>mimeType</code></td>
|
427 |
|
428 |
|
429 | <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;">
|
430 |
|
431 |
|
432 | <span class="param-type">string</span>
|
433 |
|
434 |
|
435 |
|
436 |
|
437 | </td>
|
438 |
|
439 |
|
440 | <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;">
|
441 |
|
442 | <optional><br>
|
443 |
|
444 |
|
445 |
|
446 |
|
447 |
|
448 | </td>
|
449 |
|
450 |
|
451 |
|
452 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
453 |
|
454 | </td>
|
455 |
|
456 |
|
457 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types">MIME type</a> that will be used to override the default one returned by the server. Only used when the client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType">overrideMimeType</a> method of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a>.</p></td>
|
458 | </tr>
|
459 |
|
460 |
|
461 |
|
462 | <tr>
|
463 |
|
464 | <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>callbackFunction</code></td>
|
465 |
|
466 |
|
467 | <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;">
|
468 |
|
469 |
|
470 | <span class="param-type">function</span>
|
471 |
|
472 |
|
473 |
|
474 |
|
475 | </td>
|
476 |
|
477 |
|
478 | <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;">
|
479 |
|
480 | <optional><br>
|
481 |
|
482 |
|
483 |
|
484 |
|
485 |
|
486 | </td>
|
487 |
|
488 |
|
489 |
|
490 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
491 |
|
492 | </td>
|
493 |
|
494 |
|
495 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Function that will be used for the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/onreadystatechange">onreadystatechange</a> property of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a>. The unique parameter that it will receive is the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> used by the request. If provided, the "callbackFunctionOK" and "callbackFunctionError" parameters will not be used even they were also provided.</p></td>
|
496 | </tr>
|
497 |
|
498 |
|
499 |
|
500 | <tr>
|
501 |
|
502 | <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>callbackFunctionOK</code></td>
|
503 |
|
504 |
|
505 | <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;">
|
506 |
|
507 |
|
508 | <span class="param-type">function</span>
|
509 |
|
510 |
|
511 |
|
512 |
|
513 | </td>
|
514 |
|
515 |
|
516 | <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;">
|
517 |
|
518 | <optional><br>
|
519 |
|
520 |
|
521 |
|
522 |
|
523 |
|
524 | </td>
|
525 |
|
526 |
|
527 |
|
528 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
529 |
|
530 | </td>
|
531 |
|
532 |
|
533 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Function that will be called by an internally-created function used in the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/onreadystatechange">onreadystatechange</a> property of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/readyState">readyState</a> property is 4 and the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status">status</a> property is included in the "allowedSuccessStatuses" desired. The first parameter it will receive is the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> used by the request and the second one will be the "callbackFunctionError" function provided (if any). It will not be used if the parameter "callbackFunction" is provided.</p></td>
|
534 | </tr>
|
535 |
|
536 |
|
537 |
|
538 | <tr>
|
539 |
|
540 | <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>callbackFunctionError</code></td>
|
541 |
|
542 |
|
543 | <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;">
|
544 |
|
545 |
|
546 | <span class="param-type">function</span>
|
547 |
|
548 |
|
549 |
|
550 |
|
551 | </td>
|
552 |
|
553 |
|
554 | <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;">
|
555 |
|
556 | <optional><br>
|
557 |
|
558 |
|
559 |
|
560 |
|
561 |
|
562 | </td>
|
563 |
|
564 |
|
565 |
|
566 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
567 |
|
568 | </td>
|
569 |
|
570 |
|
571 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Function that will be called by an internally-created function used in the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/onreadystatechange">onreadystatechange</a> property of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/readyState">readyState</a> property is 4 and the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status">status</a> property is not included in the "allowedSuccessStatuses" desired. The first parameter it will receive is the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> used by the request and the second one will be the "callbackFunctionOk" function provided (if any). It will not be used if the parameter "callbackFunction" is provided.</p></td>
|
572 | </tr>
|
573 |
|
574 |
|
575 |
|
576 | <tr>
|
577 |
|
578 | <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>allowedSuccessStatuses</code></td>
|
579 |
|
580 |
|
581 | <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;">
|
582 |
|
583 |
|
584 | <span class="param-type">integer</span>
|
585 | |
|
586 |
|
587 | <span class="param-type">array</span>
|
588 |
|
589 |
|
590 |
|
591 |
|
592 | </td>
|
593 |
|
594 |
|
595 | <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;">
|
596 |
|
597 | <optional><br>
|
598 |
|
599 |
|
600 |
|
601 |
|
602 |
|
603 | </td>
|
604 |
|
605 |
|
606 |
|
607 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
608 |
|
609 | 200
|
610 |
|
611 | </td>
|
612 |
|
613 |
|
614 | <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>An integer or a numeric array with a list of integers with the status or statuses that will be considered as a success call by the "callbackFunctionOK" function (only when it is used) when the response comes.</p></td>
|
615 | </tr>
|
616 |
|
617 |
|
618 |
|
619 | <tr>
|
620 |
|
621 | <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>asynchronous</code></td>
|
622 |
|
623 |
|
624 | <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;">
|
625 |
|
626 |
|
627 | <span class="param-type">boolean</span>
|
628 |
|
629 |
|
630 |
|
631 |
|
632 | </td>
|
633 |
|
634 |
|
635 | <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;">
|
636 |
|
637 | <optional><br>
|
638 |
|
639 |
|
640 |
|
641 |
|
642 |
|
643 | </td>
|
644 |
|
645 |
|
646 |
|
647 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
648 |
|
649 | true
|
650 |
|
651 | </td>
|
652 |
|
653 |
|
654 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether to make a request asynchronously or not. It will be used for the third parameter of the method <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/open">open</a> of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a>.</p></td>
|
655 | </tr>
|
656 |
|
657 |
|
658 |
|
659 | <tr>
|
660 |
|
661 | <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>
|
662 |
|
663 |
|
664 | <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;">
|
665 |
|
666 |
|
667 | <span class="param-type">Object</span>
|
668 |
|
669 |
|
670 |
|
671 |
|
672 | </td>
|
673 |
|
674 |
|
675 | <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;">
|
676 |
|
677 | <optional><br>
|
678 |
|
679 |
|
680 |
|
681 |
|
682 |
|
683 | </td>
|
684 |
|
685 |
|
686 |
|
687 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
688 |
|
689 | </td>
|
690 |
|
691 |
|
692 | <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 object</a> that we want to use for the call. If not provided, it will try to create a new one internally.</p></td>
|
693 | </tr>
|
694 |
|
695 |
|
696 | </tbody>
|
697 | </table>
|
698 |
|
699 |
|
700 |
|
701 |
|
702 | <dl class="details">
|
703 |
|
704 |
|
705 |
|
706 |
|
707 |
|
708 |
|
709 |
|
710 |
|
711 |
|
712 |
|
713 |
|
714 |
|
715 |
|
716 |
|
717 |
|
718 |
|
719 |
|
720 |
|
721 |
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 |
|
729 |
|
730 |
|
731 |
|
732 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
733 | <dd class="tag-source">
|
734 | <ul class="dummy">
|
735 | <li>
|
736 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
737 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-120">line 120</a>
|
738 | </li>
|
739 | </ul>
|
740 | </dd>
|
741 |
|
742 |
|
743 |
|
744 |
|
745 |
|
746 |
|
747 |
|
748 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
749 | <dd class="tag-todo">
|
750 | <ul>
|
751 | <li>Think about providing a way to choose whether we want the "data" provided to be added to the URL when the "GET" method is used or not.</li>
|
752 |
|
753 | <li>Describe better what kind of <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> will the different callbacks receive, as in some cases (as when using <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a>) they can contain some special properties with <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a>, etc.</li>
|
754 | </ul>
|
755 | </dd>
|
756 |
|
757 | </dl>
|
758 |
|
759 |
|
760 |
|
761 |
|
762 |
|
763 |
|
764 |
|
765 |
|
766 |
|
767 |
|
768 |
|
769 |
|
770 |
|
771 | <h5>Returns:</h5>
|
772 |
|
773 |
|
774 | <div class="param-desc">
|
775 | <p>Returns null if the URL provided was empty or the <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>) object provided is not a valid object or it could not be created a new one internally. Otherwise, it returns the <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>) object used to try to perform the call (even that maybe it failed or will fail later).</p>
|
776 | </div>
|
777 |
|
778 |
|
779 |
|
780 | <dl>
|
781 | <dt>
|
782 | Type
|
783 | </dt>
|
784 | <dd>
|
785 |
|
786 | <span class="param-type">Object</span>
|
787 | |
|
788 |
|
789 | <span class="param-type">null</span>
|
790 |
|
791 |
|
792 |
|
793 | </dd>
|
794 | </dl>
|
795 |
|
796 |
|
797 |
|
798 |
|
799 |
|
800 | </dd>
|
801 |
|
802 |
|
803 |
|
804 | <hr>
|
805 | <dt>
|
806 | <h4 class="name" id=".callBinary"><span class="type-signature"><static> </span>callBinary<span class="signature">(URL [, data] [, headers] [, blobOrArrayBuffer] [, callbackFunction] [, callbackFunctionOK] [, callbackFunctionError] [, allowedSuccessStatuses] [, XHR])</span><span class="type-signature"> → {Object|null}</span></h4>
|
807 |
|
808 |
|
809 | </dt>
|
810 | <dd>
|
811 |
|
812 |
|
813 | <div class="description">
|
814 | <p>Performs a standard <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR</a> request for a binary file. Uses the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function internally with "GET" method, using "text/plain; charset=x-user-defined" for the "mimeType" parameter and asynchronously.</p>
|
815 | </div>
|
816 |
|
817 |
|
818 |
|
819 |
|
820 |
|
821 |
|
822 |
|
823 |
|
824 | <h5>Parameters:</h5>
|
825 |
|
826 |
|
827 | <table class="params table table-striped">
|
828 | <thead>
|
829 | <tr>
|
830 |
|
831 | <th style="width:12%; min-width:110px;">Name</th>
|
832 |
|
833 |
|
834 | <th style="width:12%; min-width:110px;">Type</th>
|
835 |
|
836 |
|
837 | <th style="width:12%; min-width:110px;">Argument</th>
|
838 |
|
839 |
|
840 |
|
841 | <th style="width:12%; min-width:110px;">Default</th>
|
842 |
|
843 |
|
844 | <th class="last" style="min-width:310px;">Description</th>
|
845 | </tr>
|
846 | </thead>
|
847 |
|
848 | <tbody>
|
849 |
|
850 |
|
851 | <tr>
|
852 |
|
853 | <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>URL</code></td>
|
854 |
|
855 |
|
856 | <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;">
|
857 |
|
858 |
|
859 | <span class="param-type">string</span>
|
860 |
|
861 |
|
862 |
|
863 |
|
864 | </td>
|
865 |
|
866 |
|
867 | <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;">
|
868 |
|
869 |
|
870 |
|
871 |
|
872 |
|
873 | </td>
|
874 |
|
875 |
|
876 |
|
877 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
878 |
|
879 | </td>
|
880 |
|
881 |
|
882 | <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 "URL" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
883 | </tr>
|
884 |
|
885 |
|
886 |
|
887 | <tr>
|
888 |
|
889 | <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>data</code></td>
|
890 |
|
891 |
|
892 | <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;">
|
893 |
|
894 |
|
895 | <span class="param-type">string</span>
|
896 | |
|
897 |
|
898 | <span class="param-type">Object</span>
|
899 |
|
900 |
|
901 |
|
902 |
|
903 | </td>
|
904 |
|
905 |
|
906 | <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;">
|
907 |
|
908 | <optional><br>
|
909 |
|
910 |
|
911 |
|
912 |
|
913 |
|
914 | </td>
|
915 |
|
916 |
|
917 |
|
918 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
919 |
|
920 | </td>
|
921 |
|
922 |
|
923 | <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 "data" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
924 | </tr>
|
925 |
|
926 |
|
927 |
|
928 | <tr>
|
929 |
|
930 | <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>headers</code></td>
|
931 |
|
932 |
|
933 | <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;">
|
934 |
|
935 |
|
936 | <span class="param-type"><a href="CB_Net.XHR.html#.HEADERS">CB_Net.XHR.HEADERS</a></span>
|
937 |
|
938 |
|
939 |
|
940 |
|
941 | </td>
|
942 |
|
943 |
|
944 | <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;">
|
945 |
|
946 | <optional><br>
|
947 |
|
948 |
|
949 |
|
950 |
|
951 |
|
952 | </td>
|
953 |
|
954 |
|
955 |
|
956 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
957 |
|
958 | { "Content-Type" : "text/plain; charset=x-user-defined", "Cache-Control" : "no-cache", "Pragma" : "no-cache" }
|
959 |
|
960 | </td>
|
961 |
|
962 |
|
963 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Object containing the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP header</a> names and their values that we want to send. If not provided, it will use the default one. An empty object ({}) can be used if we do not want to send any <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> at all. Used for the "headers" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
964 | </tr>
|
965 |
|
966 |
|
967 |
|
968 | <tr>
|
969 |
|
970 | <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>blobOrArrayBuffer</code></td>
|
971 |
|
972 |
|
973 | <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;">
|
974 |
|
975 |
|
976 | <span class="param-type">'arraybuffer'</span>
|
977 | |
|
978 |
|
979 | <span class="param-type">'blob'</span>
|
980 | |
|
981 |
|
982 | <span class="param-type">''</span>
|
983 |
|
984 |
|
985 |
|
986 |
|
987 | </td>
|
988 |
|
989 |
|
990 | <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;">
|
991 |
|
992 | <optional><br>
|
993 |
|
994 |
|
995 |
|
996 |
|
997 |
|
998 | </td>
|
999 |
|
1000 |
|
1001 |
|
1002 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1003 |
|
1004 | 'arraybuffer'
|
1005 |
|
1006 | </td>
|
1007 |
|
1008 |
|
1009 | <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 <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType">responseType</a> parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally. If an empty string is provided, the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType">responseType</a> parameter will not be modified.</p></td>
|
1010 | </tr>
|
1011 |
|
1012 |
|
1013 |
|
1014 | <tr>
|
1015 |
|
1016 | <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>callbackFunction</code></td>
|
1017 |
|
1018 |
|
1019 | <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;">
|
1020 |
|
1021 |
|
1022 | <span class="param-type">function</span>
|
1023 |
|
1024 |
|
1025 |
|
1026 |
|
1027 | </td>
|
1028 |
|
1029 |
|
1030 | <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;">
|
1031 |
|
1032 | <optional><br>
|
1033 |
|
1034 |
|
1035 |
|
1036 |
|
1037 |
|
1038 | </td>
|
1039 |
|
1040 |
|
1041 |
|
1042 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1043 |
|
1044 | </td>
|
1045 |
|
1046 |
|
1047 | <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 "callbackFunction" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1048 | </tr>
|
1049 |
|
1050 |
|
1051 |
|
1052 | <tr>
|
1053 |
|
1054 | <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>callbackFunctionOK</code></td>
|
1055 |
|
1056 |
|
1057 | <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;">
|
1058 |
|
1059 |
|
1060 | <span class="param-type">function</span>
|
1061 |
|
1062 |
|
1063 |
|
1064 |
|
1065 | </td>
|
1066 |
|
1067 |
|
1068 | <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;">
|
1069 |
|
1070 | <optional><br>
|
1071 |
|
1072 |
|
1073 |
|
1074 |
|
1075 |
|
1076 | </td>
|
1077 |
|
1078 |
|
1079 |
|
1080 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1081 |
|
1082 | </td>
|
1083 |
|
1084 |
|
1085 | <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 "callbackFunctionOK" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1086 | </tr>
|
1087 |
|
1088 |
|
1089 |
|
1090 | <tr>
|
1091 |
|
1092 | <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>callbackFunctionError</code></td>
|
1093 |
|
1094 |
|
1095 | <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;">
|
1096 |
|
1097 |
|
1098 | <span class="param-type">function</span>
|
1099 |
|
1100 |
|
1101 |
|
1102 |
|
1103 | </td>
|
1104 |
|
1105 |
|
1106 | <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;">
|
1107 |
|
1108 | <optional><br>
|
1109 |
|
1110 |
|
1111 |
|
1112 |
|
1113 |
|
1114 | </td>
|
1115 |
|
1116 |
|
1117 |
|
1118 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1119 |
|
1120 | </td>
|
1121 |
|
1122 |
|
1123 | <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 "callbackFunctionError" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1124 | </tr>
|
1125 |
|
1126 |
|
1127 |
|
1128 | <tr>
|
1129 |
|
1130 | <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>allowedSuccessStatuses</code></td>
|
1131 |
|
1132 |
|
1133 | <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;">
|
1134 |
|
1135 |
|
1136 | <span class="param-type">integer</span>
|
1137 | |
|
1138 |
|
1139 | <span class="param-type">array</span>
|
1140 |
|
1141 |
|
1142 |
|
1143 |
|
1144 | </td>
|
1145 |
|
1146 |
|
1147 | <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;">
|
1148 |
|
1149 | <optional><br>
|
1150 |
|
1151 |
|
1152 |
|
1153 |
|
1154 |
|
1155 | </td>
|
1156 |
|
1157 |
|
1158 |
|
1159 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1160 |
|
1161 | 200
|
1162 |
|
1163 | </td>
|
1164 |
|
1165 |
|
1166 | <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 "allowedSuccessStatuses" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1167 | </tr>
|
1168 |
|
1169 |
|
1170 |
|
1171 | <tr>
|
1172 |
|
1173 | <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>
|
1174 |
|
1175 |
|
1176 | <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;">
|
1177 |
|
1178 |
|
1179 | <span class="param-type">Object</span>
|
1180 |
|
1181 |
|
1182 |
|
1183 |
|
1184 | </td>
|
1185 |
|
1186 |
|
1187 | <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;">
|
1188 |
|
1189 | <optional><br>
|
1190 |
|
1191 |
|
1192 |
|
1193 |
|
1194 |
|
1195 | </td>
|
1196 |
|
1197 |
|
1198 |
|
1199 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1200 |
|
1201 | </td>
|
1202 |
|
1203 |
|
1204 | <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 "XHR" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1205 | </tr>
|
1206 |
|
1207 |
|
1208 | </tbody>
|
1209 | </table>
|
1210 |
|
1211 |
|
1212 |
|
1213 |
|
1214 | <dl class="details">
|
1215 |
|
1216 |
|
1217 |
|
1218 |
|
1219 |
|
1220 |
|
1221 |
|
1222 |
|
1223 |
|
1224 |
|
1225 |
|
1226 |
|
1227 |
|
1228 |
|
1229 |
|
1230 |
|
1231 |
|
1232 |
|
1233 |
|
1234 |
|
1235 |
|
1236 |
|
1237 |
|
1238 |
|
1239 |
|
1240 |
|
1241 |
|
1242 |
|
1243 |
|
1244 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1245 | <dd class="tag-source">
|
1246 | <ul class="dummy">
|
1247 | <li>
|
1248 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
1249 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-341">line 341</a>
|
1250 | </li>
|
1251 | </ul>
|
1252 | </dd>
|
1253 |
|
1254 |
|
1255 |
|
1256 |
|
1257 |
|
1258 |
|
1259 |
|
1260 | </dl>
|
1261 |
|
1262 |
|
1263 |
|
1264 |
|
1265 |
|
1266 |
|
1267 |
|
1268 |
|
1269 |
|
1270 |
|
1271 |
|
1272 |
|
1273 |
|
1274 | <h5>Returns:</h5>
|
1275 |
|
1276 |
|
1277 | <div class="param-desc">
|
1278 | <p>Returns the same that the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function returns (called internally).</p>
|
1279 | </div>
|
1280 |
|
1281 |
|
1282 |
|
1283 | <dl>
|
1284 | <dt>
|
1285 | Type
|
1286 | </dt>
|
1287 | <dd>
|
1288 |
|
1289 | <span class="param-type">Object</span>
|
1290 | |
|
1291 |
|
1292 | <span class="param-type">null</span>
|
1293 |
|
1294 |
|
1295 |
|
1296 | </dd>
|
1297 | </dl>
|
1298 |
|
1299 |
|
1300 |
|
1301 |
|
1302 |
|
1303 | </dd>
|
1304 |
|
1305 |
|
1306 |
|
1307 | <hr>
|
1308 | <dt>
|
1309 | <h4 class="name" id=".callForm"><span class="type-signature"><static> </span>callForm<span class="signature">(URL [, data] [, headers] [, responseType] [, charset] [, callbackFunction] [, callbackFunctionOK] [, callbackFunctionError] [, allowedSuccessStatuses] [, XHR])</span><span class="type-signature"> → {Object|null}</span></h4>
|
1310 |
|
1311 |
|
1312 | </dt>
|
1313 | <dd>
|
1314 |
|
1315 |
|
1316 | <div class="description">
|
1317 | <p>Performs a standard <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR</a> request to send form data by POST (no files). Uses the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function internally with "POST" method, asynchronously and "mimeType" parameter not provided.</p>
|
1318 | </div>
|
1319 |
|
1320 |
|
1321 |
|
1322 |
|
1323 |
|
1324 |
|
1325 |
|
1326 |
|
1327 | <h5>Parameters:</h5>
|
1328 |
|
1329 |
|
1330 | <table class="params table table-striped">
|
1331 | <thead>
|
1332 | <tr>
|
1333 |
|
1334 | <th style="width:12%; min-width:110px;">Name</th>
|
1335 |
|
1336 |
|
1337 | <th style="width:12%; min-width:110px;">Type</th>
|
1338 |
|
1339 |
|
1340 | <th style="width:12%; min-width:110px;">Argument</th>
|
1341 |
|
1342 |
|
1343 |
|
1344 | <th style="width:12%; min-width:110px;">Default</th>
|
1345 |
|
1346 |
|
1347 | <th class="last" style="min-width:310px;">Description</th>
|
1348 | </tr>
|
1349 | </thead>
|
1350 |
|
1351 | <tbody>
|
1352 |
|
1353 |
|
1354 | <tr>
|
1355 |
|
1356 | <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>URL</code></td>
|
1357 |
|
1358 |
|
1359 | <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;">
|
1360 |
|
1361 |
|
1362 | <span class="param-type">string</span>
|
1363 |
|
1364 |
|
1365 |
|
1366 |
|
1367 | </td>
|
1368 |
|
1369 |
|
1370 | <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;">
|
1371 |
|
1372 |
|
1373 |
|
1374 |
|
1375 |
|
1376 | </td>
|
1377 |
|
1378 |
|
1379 |
|
1380 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1381 |
|
1382 | </td>
|
1383 |
|
1384 |
|
1385 | <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 "URL" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1386 | </tr>
|
1387 |
|
1388 |
|
1389 |
|
1390 | <tr>
|
1391 |
|
1392 | <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>data</code></td>
|
1393 |
|
1394 |
|
1395 | <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;">
|
1396 |
|
1397 |
|
1398 | <span class="param-type">string</span>
|
1399 | |
|
1400 |
|
1401 | <span class="param-type">Object</span>
|
1402 |
|
1403 |
|
1404 |
|
1405 |
|
1406 | </td>
|
1407 |
|
1408 |
|
1409 | <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;">
|
1410 |
|
1411 | <optional><br>
|
1412 |
|
1413 |
|
1414 |
|
1415 |
|
1416 |
|
1417 | </td>
|
1418 |
|
1419 |
|
1420 |
|
1421 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1422 |
|
1423 | </td>
|
1424 |
|
1425 |
|
1426 | <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 "data" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1427 | </tr>
|
1428 |
|
1429 |
|
1430 |
|
1431 | <tr>
|
1432 |
|
1433 | <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>headers</code></td>
|
1434 |
|
1435 |
|
1436 | <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;">
|
1437 |
|
1438 |
|
1439 | <span class="param-type"><a href="CB_Net.XHR.html#.HEADERS">CB_Net.XHR.HEADERS</a></span>
|
1440 |
|
1441 |
|
1442 |
|
1443 |
|
1444 | </td>
|
1445 |
|
1446 |
|
1447 | <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;">
|
1448 |
|
1449 | <optional><br>
|
1450 |
|
1451 |
|
1452 |
|
1453 |
|
1454 |
|
1455 | </td>
|
1456 |
|
1457 |
|
1458 |
|
1459 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1460 |
|
1461 | { "Content-Type" : "application/x-www-form-urlencoded; charset=" + charset, "Cache-Control" : "no-cache", "Pragma" : "no-cache" }
|
1462 |
|
1463 | </td>
|
1464 |
|
1465 |
|
1466 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Object containing the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP header</a> names and their values that we want to send. If not provided, it will use the default one that will include the charset defined by the "charset" parameter. An empty object ({}) can be used if we do not want to send any <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> at all. Used for the "headers" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1467 | </tr>
|
1468 |
|
1469 |
|
1470 |
|
1471 | <tr>
|
1472 |
|
1473 | <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>responseType</code></td>
|
1474 |
|
1475 |
|
1476 | <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;">
|
1477 |
|
1478 |
|
1479 | <span class="param-type">string</span>
|
1480 |
|
1481 |
|
1482 |
|
1483 |
|
1484 | </td>
|
1485 |
|
1486 |
|
1487 | <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;">
|
1488 |
|
1489 | <optional><br>
|
1490 |
|
1491 |
|
1492 |
|
1493 |
|
1494 |
|
1495 | </td>
|
1496 |
|
1497 |
|
1498 |
|
1499 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1500 |
|
1501 | </td>
|
1502 |
|
1503 |
|
1504 | <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 <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType">responseType</a> parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1505 | </tr>
|
1506 |
|
1507 |
|
1508 |
|
1509 | <tr>
|
1510 |
|
1511 | <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>charset</code></td>
|
1512 |
|
1513 |
|
1514 | <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;">
|
1515 |
|
1516 |
|
1517 | <span class="param-type">string</span>
|
1518 |
|
1519 |
|
1520 |
|
1521 |
|
1522 | </td>
|
1523 |
|
1524 |
|
1525 | <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;">
|
1526 |
|
1527 | <optional><br>
|
1528 |
|
1529 |
|
1530 |
|
1531 |
|
1532 |
|
1533 | </td>
|
1534 |
|
1535 |
|
1536 |
|
1537 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1538 |
|
1539 | 'UTF-8'
|
1540 |
|
1541 | </td>
|
1542 |
|
1543 |
|
1544 | <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 charset for the "Content-Type" <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP header</a> that will be sent by default only when no "headers" parameter is provided.</p></td>
|
1545 | </tr>
|
1546 |
|
1547 |
|
1548 |
|
1549 | <tr>
|
1550 |
|
1551 | <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>callbackFunction</code></td>
|
1552 |
|
1553 |
|
1554 | <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;">
|
1555 |
|
1556 |
|
1557 | <span class="param-type">function</span>
|
1558 |
|
1559 |
|
1560 |
|
1561 |
|
1562 | </td>
|
1563 |
|
1564 |
|
1565 | <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;">
|
1566 |
|
1567 | <optional><br>
|
1568 |
|
1569 |
|
1570 |
|
1571 |
|
1572 |
|
1573 | </td>
|
1574 |
|
1575 |
|
1576 |
|
1577 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1578 |
|
1579 | </td>
|
1580 |
|
1581 |
|
1582 | <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 "callbackFunction" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1583 | </tr>
|
1584 |
|
1585 |
|
1586 |
|
1587 | <tr>
|
1588 |
|
1589 | <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>callbackFunctionOK</code></td>
|
1590 |
|
1591 |
|
1592 | <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;">
|
1593 |
|
1594 |
|
1595 | <span class="param-type">function</span>
|
1596 |
|
1597 |
|
1598 |
|
1599 |
|
1600 | </td>
|
1601 |
|
1602 |
|
1603 | <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;">
|
1604 |
|
1605 | <optional><br>
|
1606 |
|
1607 |
|
1608 |
|
1609 |
|
1610 |
|
1611 | </td>
|
1612 |
|
1613 |
|
1614 |
|
1615 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1616 |
|
1617 | </td>
|
1618 |
|
1619 |
|
1620 | <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 "callbackFunctionOK" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1621 | </tr>
|
1622 |
|
1623 |
|
1624 |
|
1625 | <tr>
|
1626 |
|
1627 | <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>callbackFunctionError</code></td>
|
1628 |
|
1629 |
|
1630 | <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;">
|
1631 |
|
1632 |
|
1633 | <span class="param-type">function</span>
|
1634 |
|
1635 |
|
1636 |
|
1637 |
|
1638 | </td>
|
1639 |
|
1640 |
|
1641 | <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;">
|
1642 |
|
1643 | <optional><br>
|
1644 |
|
1645 |
|
1646 |
|
1647 |
|
1648 |
|
1649 | </td>
|
1650 |
|
1651 |
|
1652 |
|
1653 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1654 |
|
1655 | </td>
|
1656 |
|
1657 |
|
1658 | <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 "callbackFunctionError" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1659 | </tr>
|
1660 |
|
1661 |
|
1662 |
|
1663 | <tr>
|
1664 |
|
1665 | <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>allowedSuccessStatuses</code></td>
|
1666 |
|
1667 |
|
1668 | <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;">
|
1669 |
|
1670 |
|
1671 | <span class="param-type">integer</span>
|
1672 | |
|
1673 |
|
1674 | <span class="param-type">array</span>
|
1675 |
|
1676 |
|
1677 |
|
1678 |
|
1679 | </td>
|
1680 |
|
1681 |
|
1682 | <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;">
|
1683 |
|
1684 | <optional><br>
|
1685 |
|
1686 |
|
1687 |
|
1688 |
|
1689 |
|
1690 | </td>
|
1691 |
|
1692 |
|
1693 |
|
1694 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1695 |
|
1696 | 200
|
1697 |
|
1698 | </td>
|
1699 |
|
1700 |
|
1701 | <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 "allowedSuccessStatuses" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1702 | </tr>
|
1703 |
|
1704 |
|
1705 |
|
1706 | <tr>
|
1707 |
|
1708 | <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>
|
1709 |
|
1710 |
|
1711 | <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;">
|
1712 |
|
1713 |
|
1714 | <span class="param-type">Object</span>
|
1715 |
|
1716 |
|
1717 |
|
1718 |
|
1719 | </td>
|
1720 |
|
1721 |
|
1722 | <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;">
|
1723 |
|
1724 | <optional><br>
|
1725 |
|
1726 |
|
1727 |
|
1728 |
|
1729 |
|
1730 | </td>
|
1731 |
|
1732 |
|
1733 |
|
1734 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1735 |
|
1736 | </td>
|
1737 |
|
1738 |
|
1739 | <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 "XHR" parameter of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function when it is called internally.</p></td>
|
1740 | </tr>
|
1741 |
|
1742 |
|
1743 | </tbody>
|
1744 | </table>
|
1745 |
|
1746 |
|
1747 |
|
1748 |
|
1749 | <dl class="details">
|
1750 |
|
1751 |
|
1752 |
|
1753 |
|
1754 |
|
1755 |
|
1756 |
|
1757 |
|
1758 |
|
1759 |
|
1760 |
|
1761 |
|
1762 |
|
1763 |
|
1764 |
|
1765 |
|
1766 |
|
1767 |
|
1768 |
|
1769 |
|
1770 |
|
1771 |
|
1772 |
|
1773 |
|
1774 |
|
1775 |
|
1776 |
|
1777 |
|
1778 |
|
1779 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1780 | <dd class="tag-source">
|
1781 | <ul class="dummy">
|
1782 | <li>
|
1783 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
1784 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-293">line 293</a>
|
1785 | </li>
|
1786 | </ul>
|
1787 | </dd>
|
1788 |
|
1789 |
|
1790 |
|
1791 |
|
1792 |
|
1793 |
|
1794 |
|
1795 | </dl>
|
1796 |
|
1797 |
|
1798 |
|
1799 |
|
1800 |
|
1801 |
|
1802 |
|
1803 |
|
1804 |
|
1805 |
|
1806 |
|
1807 |
|
1808 |
|
1809 | <h5>Returns:</h5>
|
1810 |
|
1811 |
|
1812 | <div class="param-desc">
|
1813 | <p>Returns the same that the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function returns (called internally).</p>
|
1814 | </div>
|
1815 |
|
1816 |
|
1817 |
|
1818 | <dl>
|
1819 | <dt>
|
1820 | Type
|
1821 | </dt>
|
1822 | <dd>
|
1823 |
|
1824 | <span class="param-type">Object</span>
|
1825 | |
|
1826 |
|
1827 | <span class="param-type">null</span>
|
1828 |
|
1829 |
|
1830 |
|
1831 | </dd>
|
1832 | </dl>
|
1833 |
|
1834 |
|
1835 |
|
1836 |
|
1837 |
|
1838 | </dd>
|
1839 |
|
1840 |
|
1841 |
|
1842 | <hr>
|
1843 | <dt>
|
1844 | <h4 class="name" id=".callProxy"><span class="type-signature"><static> </span>callProxy<span class="signature">(URL [, method] [, data] [, headers] [, responseType] [, forceJSON] [, getHeaders] [, headersForceOneDimension] [, headersForceOneDimensionValues] [, transparentStatus] [, transparentHeaders] [, callbackFunction] [, callbackFunctionOK] [, callbackFunctionError] [, allowedSuccessStatuses] [, XHR])</span><span class="type-signature"> → {Object|null}</span></h4>
|
1845 |
|
1846 |
|
1847 | </dt>
|
1848 | <dd>
|
1849 |
|
1850 |
|
1851 | <div class="description">
|
1852 | <p>Performs an <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>) call through the proxy (made with <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> language and using <a href="https://en.wikipedia.org/wiki/CURL">cURL</a>, so it will need a server which supports that) to avoid <a href="https://en.wikipedia.org/wiki/Cross-origin_resource_sharing">cross-domain request</a> limitations of <a href="https://en.wikipedia.org/wiki/Ajax_(programming)">AJAX</a>. Uses the <a href="CB_Net.XHR.html#.callForm"><code>CB_Net.XHR.callForm</code></a> function (with "headers" and "charset" parameters not provided) internally to call the proxy.<br>
|
1853 | <br /><br>
|
1854 | NOTE: Edit the "CB_proxy.config.php" 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>
|
1855 | Have in mind that, for safety reasons, the default proxy only allows to request the URLs defined in the "$allowedURLs" array in the "CB_proxy.config.php" file. Just edit it to allow other URLs.</p>
|
1856 | </div>
|
1857 |
|
1858 |
|
1859 |
|
1860 |
|
1861 |
|
1862 |
|
1863 |
|
1864 |
|
1865 | <h5>Parameters:</h5>
|
1866 |
|
1867 |
|
1868 | <table class="params table table-striped">
|
1869 | <thead>
|
1870 | <tr>
|
1871 |
|
1872 | <th style="width:12%; min-width:110px;">Name</th>
|
1873 |
|
1874 |
|
1875 | <th style="width:12%; min-width:110px;">Type</th>
|
1876 |
|
1877 |
|
1878 | <th style="width:12%; min-width:110px;">Argument</th>
|
1879 |
|
1880 |
|
1881 |
|
1882 | <th style="width:12%; min-width:110px;">Default</th>
|
1883 |
|
1884 |
|
1885 | <th class="last" style="min-width:310px;">Description</th>
|
1886 | </tr>
|
1887 | </thead>
|
1888 |
|
1889 | <tbody>
|
1890 |
|
1891 |
|
1892 | <tr>
|
1893 |
|
1894 | <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>URL</code></td>
|
1895 |
|
1896 |
|
1897 | <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;">
|
1898 |
|
1899 |
|
1900 | <span class="param-type">string</span>
|
1901 |
|
1902 |
|
1903 |
|
1904 |
|
1905 | </td>
|
1906 |
|
1907 |
|
1908 | <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;">
|
1909 |
|
1910 |
|
1911 |
|
1912 |
|
1913 |
|
1914 | </td>
|
1915 |
|
1916 |
|
1917 |
|
1918 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1919 |
|
1920 | </td>
|
1921 |
|
1922 |
|
1923 | <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 URL that we want the proxy to call for us. It can also contain URL (GET) parameters.</p></td>
|
1924 | </tr>
|
1925 |
|
1926 |
|
1927 |
|
1928 | <tr>
|
1929 |
|
1930 | <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>method</code></td>
|
1931 |
|
1932 |
|
1933 | <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;">
|
1934 |
|
1935 |
|
1936 | <span class="param-type">string</span>
|
1937 |
|
1938 |
|
1939 |
|
1940 |
|
1941 | </td>
|
1942 |
|
1943 |
|
1944 | <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;">
|
1945 |
|
1946 | <optional><br>
|
1947 |
|
1948 |
|
1949 |
|
1950 |
|
1951 |
|
1952 | </td>
|
1953 |
|
1954 |
|
1955 |
|
1956 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1957 |
|
1958 | 'POST'
|
1959 |
|
1960 | </td>
|
1961 |
|
1962 |
|
1963 | <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/HTTP/Methods">HTTP method</a> (GET, POST, PUT, DELETE, etc.) that we want the proxy to use for us when performing the call.</p></td>
|
1964 | </tr>
|
1965 |
|
1966 |
|
1967 |
|
1968 | <tr>
|
1969 |
|
1970 | <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>data</code></td>
|
1971 |
|
1972 |
|
1973 | <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;">
|
1974 |
|
1975 |
|
1976 | <span class="param-type">string</span>
|
1977 | |
|
1978 |
|
1979 | <span class="param-type">Object</span>
|
1980 |
|
1981 |
|
1982 |
|
1983 |
|
1984 | </td>
|
1985 |
|
1986 |
|
1987 | <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;">
|
1988 |
|
1989 | <optional><br>
|
1990 |
|
1991 |
|
1992 |
|
1993 |
|
1994 |
|
1995 | </td>
|
1996 |
|
1997 |
|
1998 |
|
1999 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2000 |
|
2001 | </td>
|
2002 |
|
2003 |
|
2004 | <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 data that we want to send through the proxy to the final server. If something which is not a string is given, it will assume it is a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object and will try to convert it into a string (using the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">JSON.stringify</a> function internally) before sending it.</p></td>
|
2005 | </tr>
|
2006 |
|
2007 |
|
2008 |
|
2009 | <tr>
|
2010 |
|
2011 | <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>headers</code></td>
|
2012 |
|
2013 |
|
2014 | <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;">
|
2015 |
|
2016 |
|
2017 | <span class="param-type"><a href="CB_Net.XHR.html#.HEADERS">CB_Net.XHR.HEADERS</a></span>
|
2018 |
|
2019 |
|
2020 |
|
2021 |
|
2022 | </td>
|
2023 |
|
2024 |
|
2025 | <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;">
|
2026 |
|
2027 | <optional><br>
|
2028 |
|
2029 |
|
2030 |
|
2031 |
|
2032 |
|
2033 | </td>
|
2034 |
|
2035 |
|
2036 |
|
2037 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2038 |
|
2039 | </td>
|
2040 |
|
2041 |
|
2042 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Object (<a href="https://en.wikipedia.org/wiki/JSON">JSON</a> format) containing the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP header</a> names and their values that we want the proxy to send to the final server. Even if not provided, the proxy could end sending some <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> depending on the <a href="https://en.wikipedia.org/wiki/CURL">cURL</a> configuration used.</p></td>
|
2043 | </tr>
|
2044 |
|
2045 |
|
2046 |
|
2047 | <tr>
|
2048 |
|
2049 | <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>responseType</code></td>
|
2050 |
|
2051 |
|
2052 | <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;">
|
2053 |
|
2054 |
|
2055 | <span class="param-type">string</span>
|
2056 |
|
2057 |
|
2058 |
|
2059 |
|
2060 | </td>
|
2061 |
|
2062 |
|
2063 | <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;">
|
2064 |
|
2065 | <optional><br>
|
2066 |
|
2067 |
|
2068 |
|
2069 |
|
2070 |
|
2071 | </td>
|
2072 |
|
2073 |
|
2074 |
|
2075 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2076 |
|
2077 | </td>
|
2078 |
|
2079 |
|
2080 | <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 <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType">responseType</a> parameter of the <a href="CB_Net.XHR.html#.callForm"><code>CB_Net.XHR.callForm</code></a> function when it is called internally.</p></td>
|
2081 | </tr>
|
2082 |
|
2083 |
|
2084 |
|
2085 | <tr>
|
2086 |
|
2087 | <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>forceJSON</code></td>
|
2088 |
|
2089 |
|
2090 | <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;">
|
2091 |
|
2092 |
|
2093 | <span class="param-type">boolean</span>
|
2094 |
|
2095 |
|
2096 |
|
2097 |
|
2098 | </td>
|
2099 |
|
2100 |
|
2101 | <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;">
|
2102 |
|
2103 | <optional><br>
|
2104 |
|
2105 |
|
2106 |
|
2107 |
|
2108 |
|
2109 | </td>
|
2110 |
|
2111 |
|
2112 |
|
2113 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2114 |
|
2115 | false
|
2116 |
|
2117 | </td>
|
2118 |
|
2119 |
|
2120 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, the response from the proxy will be a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status">status</a> property containing the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status">HTTP status</a> of the reply, the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/response">response</a> property with the response content itself and the "headers" property (only when "getHeaders" parameters is set to true) with the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> of the reply, all belonging to the response from the final server.</p></td>
|
2121 | </tr>
|
2122 |
|
2123 |
|
2124 |
|
2125 | <tr>
|
2126 |
|
2127 | <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>getHeaders</code></td>
|
2128 |
|
2129 |
|
2130 | <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;">
|
2131 |
|
2132 |
|
2133 | <span class="param-type">boolean</span>
|
2134 |
|
2135 |
|
2136 |
|
2137 |
|
2138 | </td>
|
2139 |
|
2140 |
|
2141 | <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;">
|
2142 |
|
2143 | <optional><br>
|
2144 |
|
2145 |
|
2146 |
|
2147 |
|
2148 |
|
2149 | </td>
|
2150 |
|
2151 |
|
2152 |
|
2153 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2154 |
|
2155 | false
|
2156 |
|
2157 | </td>
|
2158 |
|
2159 |
|
2160 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, the proxy will answer including the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> from the final server. The <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> will be included in the final response string at the beginning (before the response content) if the "forceJSON" parameter is not set to true or in the "headers" property of the <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object that belongs to the response otherwise.</p></td>
|
2161 | </tr>
|
2162 |
|
2163 |
|
2164 |
|
2165 | <tr>
|
2166 |
|
2167 | <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>headersForceOneDimension</code></td>
|
2168 |
|
2169 |
|
2170 | <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;">
|
2171 |
|
2172 |
|
2173 | <span class="param-type">boolean</span>
|
2174 |
|
2175 |
|
2176 |
|
2177 |
|
2178 | </td>
|
2179 |
|
2180 |
|
2181 | <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;">
|
2182 |
|
2183 | <optional><br>
|
2184 |
|
2185 |
|
2186 |
|
2187 |
|
2188 |
|
2189 | </td>
|
2190 |
|
2191 |
|
2192 |
|
2193 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2194 |
|
2195 | false
|
2196 |
|
2197 | </td>
|
2198 |
|
2199 |
|
2200 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, the proxy will consider that the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> of the response from the final server are not multidimensional which means that the final server would never reply the same <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP header</a> repeated multiple times (with different values, normally) in different chunks separated by double new lines ("\r\n\r\n"). Default value (false) is recommended. Needs "getHeaders" set to true.</p></td>
|
2201 | </tr>
|
2202 |
|
2203 |
|
2204 |
|
2205 | <tr>
|
2206 |
|
2207 | <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>headersForceOneDimensionValues</code></td>
|
2208 |
|
2209 |
|
2210 | <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;">
|
2211 |
|
2212 |
|
2213 | <span class="param-type">boolean</span>
|
2214 |
|
2215 |
|
2216 |
|
2217 |
|
2218 | </td>
|
2219 |
|
2220 |
|
2221 | <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;">
|
2222 |
|
2223 | <optional><br>
|
2224 |
|
2225 |
|
2226 |
|
2227 |
|
2228 |
|
2229 | </td>
|
2230 |
|
2231 |
|
2232 |
|
2233 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2234 |
|
2235 | false
|
2236 |
|
2237 | </td>
|
2238 |
|
2239 |
|
2240 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, the proxy will only consider one value per <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP header</a> from the response from the final server. Default value (false) is recommended. Needs "getHeaders" set to true.</p></td>
|
2241 | </tr>
|
2242 |
|
2243 |
|
2244 |
|
2245 | <tr>
|
2246 |
|
2247 | <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>transparentStatus</code></td>
|
2248 |
|
2249 |
|
2250 | <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;">
|
2251 |
|
2252 |
|
2253 | <span class="param-type">boolean</span>
|
2254 |
|
2255 |
|
2256 |
|
2257 |
|
2258 | </td>
|
2259 |
|
2260 |
|
2261 | <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;">
|
2262 |
|
2263 | <optional><br>
|
2264 |
|
2265 |
|
2266 |
|
2267 |
|
2268 |
|
2269 | </td>
|
2270 |
|
2271 |
|
2272 |
|
2273 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2274 |
|
2275 | false
|
2276 |
|
2277 | </td>
|
2278 |
|
2279 |
|
2280 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, the proxy will reply us with the same status as the final server in its HTTP response.</p></td>
|
2281 | </tr>
|
2282 |
|
2283 |
|
2284 |
|
2285 | <tr>
|
2286 |
|
2287 | <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>transparentHeaders</code></td>
|
2288 |
|
2289 |
|
2290 | <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;">
|
2291 |
|
2292 |
|
2293 | <span class="param-type">boolean</span>
|
2294 |
|
2295 |
|
2296 |
|
2297 |
|
2298 | </td>
|
2299 |
|
2300 |
|
2301 | <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;">
|
2302 |
|
2303 | <optional><br>
|
2304 |
|
2305 |
|
2306 |
|
2307 |
|
2308 |
|
2309 | </td>
|
2310 |
|
2311 |
|
2312 |
|
2313 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2314 |
|
2315 | false
|
2316 |
|
2317 | </td>
|
2318 |
|
2319 |
|
2320 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, the proxy will reply us with the same <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> as the final server in its HTTP response.</p></td>
|
2321 | </tr>
|
2322 |
|
2323 |
|
2324 |
|
2325 | <tr>
|
2326 |
|
2327 | <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>callbackFunction</code></td>
|
2328 |
|
2329 |
|
2330 | <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;">
|
2331 |
|
2332 |
|
2333 | <span class="param-type">function</span>
|
2334 |
|
2335 |
|
2336 |
|
2337 |
|
2338 | </td>
|
2339 |
|
2340 |
|
2341 | <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;">
|
2342 |
|
2343 | <optional><br>
|
2344 |
|
2345 |
|
2346 |
|
2347 |
|
2348 |
|
2349 | </td>
|
2350 |
|
2351 |
|
2352 |
|
2353 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2354 |
|
2355 | </td>
|
2356 |
|
2357 |
|
2358 | <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 "callbackFunction" parameter of the <a href="CB_Net.XHR.html#.callForm"><code>CB_Net.XHR.callForm</code></a> function when it is called internally.</p></td>
|
2359 | </tr>
|
2360 |
|
2361 |
|
2362 |
|
2363 | <tr>
|
2364 |
|
2365 | <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>callbackFunctionOK</code></td>
|
2366 |
|
2367 |
|
2368 | <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;">
|
2369 |
|
2370 |
|
2371 | <span class="param-type">function</span>
|
2372 |
|
2373 |
|
2374 |
|
2375 |
|
2376 | </td>
|
2377 |
|
2378 |
|
2379 | <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;">
|
2380 |
|
2381 | <optional><br>
|
2382 |
|
2383 |
|
2384 |
|
2385 |
|
2386 |
|
2387 | </td>
|
2388 |
|
2389 |
|
2390 |
|
2391 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2392 |
|
2393 | </td>
|
2394 |
|
2395 |
|
2396 | <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 "callbackFunctionOK" parameter of the <a href="CB_Net.XHR.html#.callForm"><code>CB_Net.XHR.callForm</code></a> function when it is called internally.</p></td>
|
2397 | </tr>
|
2398 |
|
2399 |
|
2400 |
|
2401 | <tr>
|
2402 |
|
2403 | <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>callbackFunctionError</code></td>
|
2404 |
|
2405 |
|
2406 | <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;">
|
2407 |
|
2408 |
|
2409 | <span class="param-type">function</span>
|
2410 |
|
2411 |
|
2412 |
|
2413 |
|
2414 | </td>
|
2415 |
|
2416 |
|
2417 | <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;">
|
2418 |
|
2419 | <optional><br>
|
2420 |
|
2421 |
|
2422 |
|
2423 |
|
2424 |
|
2425 | </td>
|
2426 |
|
2427 |
|
2428 |
|
2429 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2430 |
|
2431 | </td>
|
2432 |
|
2433 |
|
2434 | <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 "callbackFunctionError" parameter of the <a href="CB_Net.XHR.html#.callForm"><code>CB_Net.XHR.callForm</code></a> function when it is called internally.</p></td>
|
2435 | </tr>
|
2436 |
|
2437 |
|
2438 |
|
2439 | <tr>
|
2440 |
|
2441 | <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>allowedSuccessStatuses</code></td>
|
2442 |
|
2443 |
|
2444 | <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;">
|
2445 |
|
2446 |
|
2447 | <span class="param-type">integer</span>
|
2448 | |
|
2449 |
|
2450 | <span class="param-type">array</span>
|
2451 |
|
2452 |
|
2453 |
|
2454 |
|
2455 | </td>
|
2456 |
|
2457 |
|
2458 | <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;">
|
2459 |
|
2460 | <optional><br>
|
2461 |
|
2462 |
|
2463 |
|
2464 |
|
2465 |
|
2466 | </td>
|
2467 |
|
2468 |
|
2469 |
|
2470 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2471 |
|
2472 | 200
|
2473 |
|
2474 | </td>
|
2475 |
|
2476 |
|
2477 | <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 "allowedSuccessStatuses" parameter of the <a href="CB_Net.XHR.html#.callForm"><code>CB_Net.XHR.callForm</code></a> function when it is called internally.</p></td>
|
2478 | </tr>
|
2479 |
|
2480 |
|
2481 |
|
2482 | <tr>
|
2483 |
|
2484 | <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>
|
2485 |
|
2486 |
|
2487 | <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;">
|
2488 |
|
2489 |
|
2490 | <span class="param-type">Object</span>
|
2491 |
|
2492 |
|
2493 |
|
2494 |
|
2495 | </td>
|
2496 |
|
2497 |
|
2498 | <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;">
|
2499 |
|
2500 | <optional><br>
|
2501 |
|
2502 |
|
2503 |
|
2504 |
|
2505 |
|
2506 | </td>
|
2507 |
|
2508 |
|
2509 |
|
2510 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2511 |
|
2512 | </td>
|
2513 |
|
2514 |
|
2515 | <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 "XHR" parameter of the <a href="CB_Net.XHR.html#.callForm"><code>CB_Net.XHR.callForm</code></a> function when it is called internally.</p></td>
|
2516 | </tr>
|
2517 |
|
2518 |
|
2519 | </tbody>
|
2520 | </table>
|
2521 |
|
2522 |
|
2523 |
|
2524 |
|
2525 | <dl class="details">
|
2526 |
|
2527 |
|
2528 |
|
2529 |
|
2530 |
|
2531 |
|
2532 |
|
2533 |
|
2534 |
|
2535 |
|
2536 |
|
2537 |
|
2538 |
|
2539 |
|
2540 |
|
2541 |
|
2542 |
|
2543 |
|
2544 |
|
2545 |
|
2546 |
|
2547 |
|
2548 |
|
2549 |
|
2550 |
|
2551 |
|
2552 |
|
2553 |
|
2554 |
|
2555 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2556 | <dd class="tag-source">
|
2557 | <ul class="dummy">
|
2558 | <li>
|
2559 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
2560 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-403">line 403</a>
|
2561 | </li>
|
2562 | </ul>
|
2563 | </dd>
|
2564 |
|
2565 |
|
2566 |
|
2567 |
|
2568 |
|
2569 |
|
2570 |
|
2571 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
2572 | <dd class="tag-todo">
|
2573 | <ul>
|
2574 | <li>Document PHP proxy more.</li>
|
2575 | </ul>
|
2576 | </dd>
|
2577 |
|
2578 | </dl>
|
2579 |
|
2580 |
|
2581 |
|
2582 |
|
2583 |
|
2584 |
|
2585 |
|
2586 |
|
2587 |
|
2588 |
|
2589 |
|
2590 |
|
2591 |
|
2592 | <h5>Returns:</h5>
|
2593 |
|
2594 |
|
2595 | <div class="param-desc">
|
2596 | <p>Returns the same that the <a href="CB_Net.XHR.html#.callForm"><code>CB_Net.XHR.callForm</code></a> function returns (called internally).</p>
|
2597 | </div>
|
2598 |
|
2599 |
|
2600 |
|
2601 | <dl>
|
2602 | <dt>
|
2603 | Type
|
2604 | </dt>
|
2605 | <dd>
|
2606 |
|
2607 | <span class="param-type">Object</span>
|
2608 | |
|
2609 |
|
2610 | <span class="param-type">null</span>
|
2611 |
|
2612 |
|
2613 |
|
2614 | </dd>
|
2615 | </dl>
|
2616 |
|
2617 |
|
2618 |
|
2619 |
|
2620 |
|
2621 | </dd>
|
2622 |
|
2623 |
|
2624 |
|
2625 | <hr>
|
2626 | <dt>
|
2627 | <h4 class="name" id=".callREST"><span class="type-signature"><static> </span>callREST<span class="signature">( [serverURL] [, route] [, dataURL] [, method] [, data] [, headers] [, responseType] [, avoidProxy] [, forceJSON] [, getHeaders] [, headersForceOneDimension] [, headersForceOneDimensionValues] [, transparentStatus] [, transparentHeaders] [, callbackFunctionOK] [, callbackFunctionError] [, allowedSuccessStatuses] [, XHR])</span><span class="type-signature"> → {Object|null}</span></h4>
|
2628 |
|
2629 |
|
2630 | </dt>
|
2631 | <dd>
|
2632 |
|
2633 |
|
2634 | <div class="description">
|
2635 | <p>Performs a <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> call to a <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> server. Uses the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function (without "callbackFunction" parameter provided) internally if we do not want to avoid the proxy or uses the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (asynchronously, with "mimeType" and "callbackFunction" parameters not provided) otherwise.</p>
|
2636 | </div>
|
2637 |
|
2638 |
|
2639 |
|
2640 |
|
2641 |
|
2642 |
|
2643 |
|
2644 |
|
2645 | <h5>Parameters:</h5>
|
2646 |
|
2647 |
|
2648 | <table class="params table table-striped">
|
2649 | <thead>
|
2650 | <tr>
|
2651 |
|
2652 | <th style="width:12%; min-width:110px;">Name</th>
|
2653 |
|
2654 |
|
2655 | <th style="width:12%; min-width:110px;">Type</th>
|
2656 |
|
2657 |
|
2658 | <th style="width:12%; min-width:110px;">Argument</th>
|
2659 |
|
2660 |
|
2661 |
|
2662 | <th style="width:12%; min-width:110px;">Default</th>
|
2663 |
|
2664 |
|
2665 | <th class="last" style="min-width:310px;">Description</th>
|
2666 | </tr>
|
2667 | </thead>
|
2668 |
|
2669 | <tbody>
|
2670 |
|
2671 |
|
2672 | <tr>
|
2673 |
|
2674 | <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>
|
2675 |
|
2676 |
|
2677 | <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;">
|
2678 |
|
2679 |
|
2680 | <span class="param-type">string</span>
|
2681 |
|
2682 |
|
2683 |
|
2684 |
|
2685 | </td>
|
2686 |
|
2687 |
|
2688 | <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;">
|
2689 |
|
2690 | <optional><br>
|
2691 |
|
2692 |
|
2693 |
|
2694 |
|
2695 |
|
2696 | </td>
|
2697 |
|
2698 |
|
2699 |
|
2700 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2701 |
|
2702 | <a href="CB_Net.REST.html#.SERVER_URL_DEFAULT"><code>CB_Net.REST.SERVER_URL_DEFAULT</code></a>
|
2703 |
|
2704 | </td>
|
2705 |
|
2706 |
|
2707 | <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 URL of the <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> server that we want to call. It should not contain URL (GET) parameters. It can also contain the <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> path (route), although it is recommended to set it in the "route" parameter.</p></td>
|
2708 | </tr>
|
2709 |
|
2710 |
|
2711 |
|
2712 | <tr>
|
2713 |
|
2714 | <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>route</code></td>
|
2715 |
|
2716 |
|
2717 | <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;">
|
2718 |
|
2719 |
|
2720 | <span class="param-type">string</span>
|
2721 |
|
2722 |
|
2723 |
|
2724 |
|
2725 | </td>
|
2726 |
|
2727 |
|
2728 | <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;">
|
2729 |
|
2730 | <optional><br>
|
2731 |
|
2732 |
|
2733 |
|
2734 |
|
2735 |
|
2736 | </td>
|
2737 |
|
2738 |
|
2739 |
|
2740 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2741 |
|
2742 | </td>
|
2743 |
|
2744 |
|
2745 | <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://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> path (route) we want to request. It can also contain URL (GET) parameters, although it is recommended to set them in the "dataURL" parameter.</p></td>
|
2746 | </tr>
|
2747 |
|
2748 |
|
2749 |
|
2750 | <tr>
|
2751 |
|
2752 | <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>dataURL</code></td>
|
2753 |
|
2754 |
|
2755 | <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;">
|
2756 |
|
2757 |
|
2758 | <span class="param-type">string</span>
|
2759 |
|
2760 |
|
2761 |
|
2762 |
|
2763 | </td>
|
2764 |
|
2765 |
|
2766 | <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;">
|
2767 |
|
2768 | <optional><br>
|
2769 |
|
2770 |
|
2771 |
|
2772 |
|
2773 |
|
2774 | </td>
|
2775 |
|
2776 |
|
2777 |
|
2778 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2779 |
|
2780 | </td>
|
2781 |
|
2782 |
|
2783 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The URL (GET) data that we want to send.</p></td>
|
2784 | </tr>
|
2785 |
|
2786 |
|
2787 |
|
2788 | <tr>
|
2789 |
|
2790 | <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>method</code></td>
|
2791 |
|
2792 |
|
2793 | <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;">
|
2794 |
|
2795 |
|
2796 | <span class="param-type">string</span>
|
2797 |
|
2798 |
|
2799 |
|
2800 |
|
2801 | </td>
|
2802 |
|
2803 |
|
2804 | <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;">
|
2805 |
|
2806 | <optional><br>
|
2807 |
|
2808 |
|
2809 |
|
2810 |
|
2811 |
|
2812 | </td>
|
2813 |
|
2814 |
|
2815 |
|
2816 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2817 |
|
2818 | 'POST'
|
2819 |
|
2820 | </td>
|
2821 |
|
2822 |
|
2823 | <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 "method" parameter for the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function or for the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (if no proxy is allowed) when it is called internally.</p></td>
|
2824 | </tr>
|
2825 |
|
2826 |
|
2827 |
|
2828 | <tr>
|
2829 |
|
2830 | <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>data</code></td>
|
2831 |
|
2832 |
|
2833 | <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;">
|
2834 |
|
2835 |
|
2836 | <span class="param-type">string</span>
|
2837 | |
|
2838 |
|
2839 | <span class="param-type">Object</span>
|
2840 |
|
2841 |
|
2842 |
|
2843 |
|
2844 | </td>
|
2845 |
|
2846 |
|
2847 | <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;">
|
2848 |
|
2849 | <optional><br>
|
2850 |
|
2851 |
|
2852 |
|
2853 |
|
2854 |
|
2855 | </td>
|
2856 |
|
2857 |
|
2858 |
|
2859 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2860 |
|
2861 | </td>
|
2862 |
|
2863 |
|
2864 | <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 "data" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function or of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (if no proxy is allowed) when it is called internally.</p></td>
|
2865 | </tr>
|
2866 |
|
2867 |
|
2868 |
|
2869 | <tr>
|
2870 |
|
2871 | <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>headers</code></td>
|
2872 |
|
2873 |
|
2874 | <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;">
|
2875 |
|
2876 |
|
2877 | <span class="param-type"><a href="CB_Net.XHR.html#.HEADERS">CB_Net.XHR.HEADERS</a></span>
|
2878 |
|
2879 |
|
2880 |
|
2881 |
|
2882 | </td>
|
2883 |
|
2884 |
|
2885 | <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;">
|
2886 |
|
2887 | <optional><br>
|
2888 |
|
2889 |
|
2890 |
|
2891 |
|
2892 |
|
2893 | </td>
|
2894 |
|
2895 |
|
2896 |
|
2897 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2898 |
|
2899 | undefined|{ "Content-Type" : "application/x-www-form-urlencoded; charset=UTF-8", "Cache-Control" : "no-cache", "Pragma" : "no-cache" }
|
2900 |
|
2901 | </td>
|
2902 |
|
2903 |
|
2904 | <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 "headers" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function or of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (if no proxy is allowed) when it is called internally. If not provided and the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function is used (if no proxy is allowed), the default value will be: { "Content-Type" : "application/x-www-form-urlencoded; charset=UTF-8", "Cache-Control" : "no-cache", "Pragma" : "no-cache" }</p></td>
|
2905 | </tr>
|
2906 |
|
2907 |
|
2908 |
|
2909 | <tr>
|
2910 |
|
2911 | <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>responseType</code></td>
|
2912 |
|
2913 |
|
2914 | <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;">
|
2915 |
|
2916 |
|
2917 | <span class="param-type">string</span>
|
2918 |
|
2919 |
|
2920 |
|
2921 |
|
2922 | </td>
|
2923 |
|
2924 |
|
2925 | <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;">
|
2926 |
|
2927 | <optional><br>
|
2928 |
|
2929 |
|
2930 |
|
2931 |
|
2932 |
|
2933 | </td>
|
2934 |
|
2935 |
|
2936 |
|
2937 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2938 |
|
2939 | </td>
|
2940 |
|
2941 |
|
2942 | <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 <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType">responseType</a> parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function or of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (if no proxy is allowed) when it is called internally.</p></td>
|
2943 | </tr>
|
2944 |
|
2945 |
|
2946 |
|
2947 | <tr>
|
2948 |
|
2949 | <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>
|
2950 |
|
2951 |
|
2952 | <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;">
|
2953 |
|
2954 |
|
2955 | <span class="param-type">boolean</span>
|
2956 |
|
2957 |
|
2958 |
|
2959 |
|
2960 | </td>
|
2961 |
|
2962 |
|
2963 | <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;">
|
2964 |
|
2965 | <optional><br>
|
2966 |
|
2967 |
|
2968 |
|
2969 |
|
2970 |
|
2971 | </td>
|
2972 |
|
2973 |
|
2974 |
|
2975 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2976 |
|
2977 | false
|
2978 |
|
2979 | </td>
|
2980 |
|
2981 |
|
2982 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, it will call the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> internally. Otherwise, it will use the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function internally.</p></td>
|
2983 | </tr>
|
2984 |
|
2985 |
|
2986 |
|
2987 | <tr>
|
2988 |
|
2989 | <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>forceJSON</code></td>
|
2990 |
|
2991 |
|
2992 | <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;">
|
2993 |
|
2994 |
|
2995 | <span class="param-type">boolean</span>
|
2996 |
|
2997 |
|
2998 |
|
2999 |
|
3000 | </td>
|
3001 |
|
3002 |
|
3003 | <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;">
|
3004 |
|
3005 | <optional><br>
|
3006 |
|
3007 |
|
3008 |
|
3009 |
|
3010 |
|
3011 | </td>
|
3012 |
|
3013 |
|
3014 |
|
3015 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3016 |
|
3017 | false
|
3018 |
|
3019 | </td>
|
3020 |
|
3021 |
|
3022 | <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 "forceJSON" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function (if the proxy is allowed) when it is called internally.</p></td>
|
3023 | </tr>
|
3024 |
|
3025 |
|
3026 |
|
3027 | <tr>
|
3028 |
|
3029 | <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>getHeaders</code></td>
|
3030 |
|
3031 |
|
3032 | <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;">
|
3033 |
|
3034 |
|
3035 | <span class="param-type">boolean</span>
|
3036 |
|
3037 |
|
3038 |
|
3039 |
|
3040 | </td>
|
3041 |
|
3042 |
|
3043 | <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;">
|
3044 |
|
3045 | <optional><br>
|
3046 |
|
3047 |
|
3048 |
|
3049 |
|
3050 |
|
3051 | </td>
|
3052 |
|
3053 |
|
3054 |
|
3055 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3056 |
|
3057 | false
|
3058 |
|
3059 | </td>
|
3060 |
|
3061 |
|
3062 | <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 "getHeaders" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function (if the proxy is allowed) when it is called internally.</p></td>
|
3063 | </tr>
|
3064 |
|
3065 |
|
3066 |
|
3067 | <tr>
|
3068 |
|
3069 | <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>headersForceOneDimension</code></td>
|
3070 |
|
3071 |
|
3072 | <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;">
|
3073 |
|
3074 |
|
3075 | <span class="param-type">boolean</span>
|
3076 |
|
3077 |
|
3078 |
|
3079 |
|
3080 | </td>
|
3081 |
|
3082 |
|
3083 | <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;">
|
3084 |
|
3085 | <optional><br>
|
3086 |
|
3087 |
|
3088 |
|
3089 |
|
3090 |
|
3091 | </td>
|
3092 |
|
3093 |
|
3094 |
|
3095 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3096 |
|
3097 | false
|
3098 |
|
3099 | </td>
|
3100 |
|
3101 |
|
3102 | <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 "headersForceOneDimension" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function (if the proxy is allowed) when it is called internally.</p></td>
|
3103 | </tr>
|
3104 |
|
3105 |
|
3106 |
|
3107 | <tr>
|
3108 |
|
3109 | <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>headersForceOneDimensionValues</code></td>
|
3110 |
|
3111 |
|
3112 | <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;">
|
3113 |
|
3114 |
|
3115 | <span class="param-type">boolean</span>
|
3116 |
|
3117 |
|
3118 |
|
3119 |
|
3120 | </td>
|
3121 |
|
3122 |
|
3123 | <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;">
|
3124 |
|
3125 | <optional><br>
|
3126 |
|
3127 |
|
3128 |
|
3129 |
|
3130 |
|
3131 | </td>
|
3132 |
|
3133 |
|
3134 |
|
3135 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3136 |
|
3137 | false
|
3138 |
|
3139 | </td>
|
3140 |
|
3141 |
|
3142 | <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 "headersForceOneDimensionValues" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function (if the proxy is allowed) when it is called internally.</p></td>
|
3143 | </tr>
|
3144 |
|
3145 |
|
3146 |
|
3147 | <tr>
|
3148 |
|
3149 | <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>transparentStatus</code></td>
|
3150 |
|
3151 |
|
3152 | <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;">
|
3153 |
|
3154 |
|
3155 | <span class="param-type">boolean</span>
|
3156 |
|
3157 |
|
3158 |
|
3159 |
|
3160 | </td>
|
3161 |
|
3162 |
|
3163 | <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;">
|
3164 |
|
3165 | <optional><br>
|
3166 |
|
3167 |
|
3168 |
|
3169 |
|
3170 |
|
3171 | </td>
|
3172 |
|
3173 |
|
3174 |
|
3175 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3176 |
|
3177 | false
|
3178 |
|
3179 | </td>
|
3180 |
|
3181 |
|
3182 | <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 "transparentStatus" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function (if the proxy is allowed) when it is called internally.</p></td>
|
3183 | </tr>
|
3184 |
|
3185 |
|
3186 |
|
3187 | <tr>
|
3188 |
|
3189 | <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>transparentHeaders</code></td>
|
3190 |
|
3191 |
|
3192 | <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;">
|
3193 |
|
3194 |
|
3195 | <span class="param-type">boolean</span>
|
3196 |
|
3197 |
|
3198 |
|
3199 |
|
3200 | </td>
|
3201 |
|
3202 |
|
3203 | <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;">
|
3204 |
|
3205 | <optional><br>
|
3206 |
|
3207 |
|
3208 |
|
3209 |
|
3210 |
|
3211 | </td>
|
3212 |
|
3213 |
|
3214 |
|
3215 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3216 |
|
3217 | false
|
3218 |
|
3219 | </td>
|
3220 |
|
3221 |
|
3222 | <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 "transparentHeaders" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function (if the proxy is allowed) when it is called internally.</p></td>
|
3223 | </tr>
|
3224 |
|
3225 |
|
3226 |
|
3227 | <tr>
|
3228 |
|
3229 | <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>callbackFunctionOK</code></td>
|
3230 |
|
3231 |
|
3232 | <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;">
|
3233 |
|
3234 |
|
3235 | <span class="param-type">function</span>
|
3236 |
|
3237 |
|
3238 |
|
3239 |
|
3240 | </td>
|
3241 |
|
3242 |
|
3243 | <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;">
|
3244 |
|
3245 | <optional><br>
|
3246 |
|
3247 |
|
3248 |
|
3249 |
|
3250 |
|
3251 | </td>
|
3252 |
|
3253 |
|
3254 |
|
3255 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3256 |
|
3257 | </td>
|
3258 |
|
3259 |
|
3260 | <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 "callbackFunctionOK" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function or of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (if no proxy is allowed) when it is called internally.</p></td>
|
3261 | </tr>
|
3262 |
|
3263 |
|
3264 |
|
3265 | <tr>
|
3266 |
|
3267 | <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>callbackFunctionError</code></td>
|
3268 |
|
3269 |
|
3270 | <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;">
|
3271 |
|
3272 |
|
3273 | <span class="param-type">function</span>
|
3274 |
|
3275 |
|
3276 |
|
3277 |
|
3278 | </td>
|
3279 |
|
3280 |
|
3281 | <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;">
|
3282 |
|
3283 | <optional><br>
|
3284 |
|
3285 |
|
3286 |
|
3287 |
|
3288 |
|
3289 | </td>
|
3290 |
|
3291 |
|
3292 |
|
3293 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3294 |
|
3295 | </td>
|
3296 |
|
3297 |
|
3298 | <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 "callbackFunctionError" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function or of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (if no proxy is allowed) when it is called internally.</p></td>
|
3299 | </tr>
|
3300 |
|
3301 |
|
3302 |
|
3303 | <tr>
|
3304 |
|
3305 | <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>allowedSuccessStatuses</code></td>
|
3306 |
|
3307 |
|
3308 | <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;">
|
3309 |
|
3310 |
|
3311 | <span class="param-type">integer</span>
|
3312 | |
|
3313 |
|
3314 | <span class="param-type">array</span>
|
3315 |
|
3316 |
|
3317 |
|
3318 |
|
3319 | </td>
|
3320 |
|
3321 |
|
3322 | <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;">
|
3323 |
|
3324 | <optional><br>
|
3325 |
|
3326 |
|
3327 |
|
3328 |
|
3329 |
|
3330 | </td>
|
3331 |
|
3332 |
|
3333 |
|
3334 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3335 |
|
3336 | 200
|
3337 |
|
3338 | </td>
|
3339 |
|
3340 |
|
3341 | <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 "allowedSuccessStatuses" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function or of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (if no proxy is allowed) when it is called internally.</p></td>
|
3342 | </tr>
|
3343 |
|
3344 |
|
3345 |
|
3346 | <tr>
|
3347 |
|
3348 | <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>
|
3349 |
|
3350 |
|
3351 | <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;">
|
3352 |
|
3353 |
|
3354 | <span class="param-type">Object</span>
|
3355 |
|
3356 |
|
3357 |
|
3358 |
|
3359 | </td>
|
3360 |
|
3361 |
|
3362 | <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;">
|
3363 |
|
3364 | <optional><br>
|
3365 |
|
3366 |
|
3367 |
|
3368 |
|
3369 |
|
3370 | </td>
|
3371 |
|
3372 |
|
3373 |
|
3374 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3375 |
|
3376 | </td>
|
3377 |
|
3378 |
|
3379 | <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 "XHR" parameter of the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function or of the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function (if no proxy is allowed) when it is called internally.</p></td>
|
3380 | </tr>
|
3381 |
|
3382 |
|
3383 | </tbody>
|
3384 | </table>
|
3385 |
|
3386 |
|
3387 |
|
3388 |
|
3389 | <dl class="details">
|
3390 |
|
3391 |
|
3392 |
|
3393 |
|
3394 |
|
3395 |
|
3396 |
|
3397 |
|
3398 |
|
3399 |
|
3400 |
|
3401 |
|
3402 |
|
3403 |
|
3404 |
|
3405 |
|
3406 |
|
3407 |
|
3408 |
|
3409 |
|
3410 |
|
3411 |
|
3412 |
|
3413 |
|
3414 |
|
3415 |
|
3416 |
|
3417 |
|
3418 |
|
3419 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3420 | <dd class="tag-source">
|
3421 | <ul class="dummy">
|
3422 | <li>
|
3423 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
3424 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-469">line 469</a>
|
3425 | </li>
|
3426 | </ul>
|
3427 | </dd>
|
3428 |
|
3429 |
|
3430 |
|
3431 |
|
3432 |
|
3433 |
|
3434 |
|
3435 | </dl>
|
3436 |
|
3437 |
|
3438 |
|
3439 |
|
3440 |
|
3441 |
|
3442 |
|
3443 |
|
3444 |
|
3445 |
|
3446 |
|
3447 |
|
3448 |
|
3449 | <h5>Returns:</h5>
|
3450 |
|
3451 |
|
3452 | <div class="param-desc">
|
3453 | <p>When using the proxy is allowed, returns the same that the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> function returns (called internally). Otherwise, it returns the same that the <a href="CB_Net.XHR.html#.call"><code>CB_Net.XHR.call</code></a> function returns (called internally).</p>
|
3454 | </div>
|
3455 |
|
3456 |
|
3457 |
|
3458 | <dl>
|
3459 | <dt>
|
3460 | Type
|
3461 | </dt>
|
3462 | <dd>
|
3463 |
|
3464 | <span class="param-type">Object</span>
|
3465 | |
|
3466 |
|
3467 | <span class="param-type">null</span>
|
3468 |
|
3469 |
|
3470 |
|
3471 | </dd>
|
3472 | </dl>
|
3473 |
|
3474 |
|
3475 |
|
3476 |
|
3477 |
|
3478 | </dd>
|
3479 |
|
3480 |
|
3481 |
|
3482 | <hr>
|
3483 | <dt>
|
3484 | <h4 class="name" id=".get"><span class="type-signature"><static> </span>get<span class="signature">()</span><span class="type-signature"> → {Object|null}</span></h4>
|
3485 |
|
3486 |
|
3487 | </dt>
|
3488 | <dd>
|
3489 |
|
3490 |
|
3491 | <div class="description">
|
3492 | <p>Returns a new <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>) object, if possible.</p>
|
3493 | </div>
|
3494 |
|
3495 |
|
3496 |
|
3497 |
|
3498 |
|
3499 |
|
3500 |
|
3501 |
|
3502 |
|
3503 |
|
3504 | <dl class="details">
|
3505 |
|
3506 |
|
3507 |
|
3508 |
|
3509 |
|
3510 |
|
3511 |
|
3512 |
|
3513 |
|
3514 |
|
3515 |
|
3516 |
|
3517 |
|
3518 |
|
3519 |
|
3520 |
|
3521 |
|
3522 |
|
3523 |
|
3524 |
|
3525 |
|
3526 |
|
3527 |
|
3528 |
|
3529 |
|
3530 |
|
3531 |
|
3532 |
|
3533 |
|
3534 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3535 | <dd class="tag-source">
|
3536 | <ul class="dummy">
|
3537 | <li>
|
3538 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
3539 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-60">line 60</a>
|
3540 | </li>
|
3541 | </ul>
|
3542 | </dd>
|
3543 |
|
3544 |
|
3545 |
|
3546 |
|
3547 |
|
3548 |
|
3549 |
|
3550 | </dl>
|
3551 |
|
3552 |
|
3553 |
|
3554 |
|
3555 |
|
3556 |
|
3557 |
|
3558 |
|
3559 |
|
3560 |
|
3561 |
|
3562 |
|
3563 |
|
3564 | <h5>Returns:</h5>
|
3565 |
|
3566 |
|
3567 | <div class="param-desc">
|
3568 | <p>Returns a new <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>) object if it has been possible to create it or null otherwise.</p>
|
3569 | </div>
|
3570 |
|
3571 |
|
3572 |
|
3573 | <dl>
|
3574 | <dt>
|
3575 | Type
|
3576 | </dt>
|
3577 | <dd>
|
3578 |
|
3579 | <span class="param-type">Object</span>
|
3580 | |
|
3581 |
|
3582 | <span class="param-type">null</span>
|
3583 |
|
3584 |
|
3585 |
|
3586 | </dd>
|
3587 | </dl>
|
3588 |
|
3589 |
|
3590 |
|
3591 |
|
3592 |
|
3593 | </dd>
|
3594 |
|
3595 |
|
3596 |
|
3597 | <hr>
|
3598 | <dt>
|
3599 | <h4 class="name" id=".getResponseContent"><span class="type-signature"><static> </span>getResponseContent<span class="signature">(response [, sanitize])</span><span class="type-signature"> → {string|null}</span></h4>
|
3600 |
|
3601 |
|
3602 | </dt>
|
3603 | <dd>
|
3604 |
|
3605 |
|
3606 | <div class="description">
|
3607 | <p>Returns the response content from an <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> (from its <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> property) or from the <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> response generated by the "getSslPage" function used by the <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> proxy (<a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/response">response</a> property). Useful to parse the response from the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> (or <a href="CB_Net.XHR.html#.callREST"><code>CB_Net.XHR.callREST</code></a> and related) function when it has been called with the "forceJSON" parameter set to true.</p>
|
3608 | </div>
|
3609 |
|
3610 |
|
3611 |
|
3612 |
|
3613 |
|
3614 |
|
3615 |
|
3616 |
|
3617 | <h5>Parameters:</h5>
|
3618 |
|
3619 |
|
3620 | <table class="params table table-striped">
|
3621 | <thead>
|
3622 | <tr>
|
3623 |
|
3624 | <th style="width:12%; min-width:110px;">Name</th>
|
3625 |
|
3626 |
|
3627 | <th style="width:12%; min-width:110px;">Type</th>
|
3628 |
|
3629 |
|
3630 | <th style="width:12%; min-width:110px;">Argument</th>
|
3631 |
|
3632 |
|
3633 |
|
3634 | <th style="width:12%; min-width:110px;">Default</th>
|
3635 |
|
3636 |
|
3637 | <th class="last" style="min-width:310px;">Description</th>
|
3638 | </tr>
|
3639 | </thead>
|
3640 |
|
3641 | <tbody>
|
3642 |
|
3643 |
|
3644 | <tr>
|
3645 |
|
3646 | <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>response</code></td>
|
3647 |
|
3648 |
|
3649 | <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;">
|
3650 |
|
3651 |
|
3652 | <span class="param-type">Object</span>
|
3653 | |
|
3654 |
|
3655 | <span class="param-type">string</span>
|
3656 |
|
3657 |
|
3658 |
|
3659 |
|
3660 | </td>
|
3661 |
|
3662 |
|
3663 | <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;">
|
3664 |
|
3665 |
|
3666 |
|
3667 |
|
3668 |
|
3669 | </td>
|
3670 |
|
3671 |
|
3672 |
|
3673 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3674 |
|
3675 | </td>
|
3676 |
|
3677 |
|
3678 | <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 object</a> which contains the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> property or the value of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> property (string) itself which should contain the <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> response generated by the "getSslPage" function used by the <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> proxy. If a string is provided, tries to parse it as a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object. The <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> property (or the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/response">response</a> property as a fallback) will be tried to be returned from it.</p></td>
|
3679 | </tr>
|
3680 |
|
3681 |
|
3682 |
|
3683 | <tr>
|
3684 |
|
3685 | <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>sanitize</code></td>
|
3686 |
|
3687 |
|
3688 | <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;">
|
3689 |
|
3690 |
|
3691 | <span class="param-type">boolean</span>
|
3692 |
|
3693 |
|
3694 |
|
3695 |
|
3696 | </td>
|
3697 |
|
3698 |
|
3699 | <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;">
|
3700 |
|
3701 | <optional><br>
|
3702 |
|
3703 |
|
3704 |
|
3705 |
|
3706 |
|
3707 | </td>
|
3708 |
|
3709 |
|
3710 |
|
3711 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3712 |
|
3713 | true
|
3714 |
|
3715 | </td>
|
3716 |
|
3717 |
|
3718 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true and neither the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> nor the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/response">response</a> properties are found, it will return an empty string ("") instead of returning null.</p></td>
|
3719 | </tr>
|
3720 |
|
3721 |
|
3722 | </tbody>
|
3723 | </table>
|
3724 |
|
3725 |
|
3726 |
|
3727 |
|
3728 | <dl class="details">
|
3729 |
|
3730 |
|
3731 |
|
3732 |
|
3733 |
|
3734 |
|
3735 |
|
3736 |
|
3737 |
|
3738 |
|
3739 |
|
3740 |
|
3741 |
|
3742 |
|
3743 |
|
3744 |
|
3745 |
|
3746 |
|
3747 |
|
3748 |
|
3749 |
|
3750 |
|
3751 |
|
3752 |
|
3753 |
|
3754 |
|
3755 |
|
3756 |
|
3757 |
|
3758 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3759 | <dd class="tag-source">
|
3760 | <ul class="dummy">
|
3761 | <li>
|
3762 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
3763 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-581">line 581</a>
|
3764 | </li>
|
3765 | </ul>
|
3766 | </dd>
|
3767 |
|
3768 |
|
3769 |
|
3770 |
|
3771 |
|
3772 |
|
3773 |
|
3774 | </dl>
|
3775 |
|
3776 |
|
3777 |
|
3778 |
|
3779 |
|
3780 |
|
3781 |
|
3782 |
|
3783 |
|
3784 |
|
3785 |
|
3786 |
|
3787 |
|
3788 | <h5>Returns:</h5>
|
3789 |
|
3790 |
|
3791 | <div class="param-desc">
|
3792 | <p>Returns the content of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> (or <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/response">response</a>) property if possible. If it is not possible, it will return null if the parameter "sanitize" is set to false or an empty string ("") otherwise.</p>
|
3793 | </div>
|
3794 |
|
3795 |
|
3796 |
|
3797 | <dl>
|
3798 | <dt>
|
3799 | Type
|
3800 | </dt>
|
3801 | <dd>
|
3802 |
|
3803 | <span class="param-type">string</span>
|
3804 | |
|
3805 |
|
3806 | <span class="param-type">null</span>
|
3807 |
|
3808 |
|
3809 |
|
3810 | </dd>
|
3811 | </dl>
|
3812 |
|
3813 |
|
3814 |
|
3815 |
|
3816 |
|
3817 | </dd>
|
3818 |
|
3819 |
|
3820 |
|
3821 | <hr>
|
3822 | <dt>
|
3823 | <h4 class="name" id=".getResponseHeaders"><span class="type-signature"><static> </span>getResponseHeaders<span class="signature">(response [, sanitize])</span><span class="type-signature"> → {Object|null}</span></h4>
|
3824 |
|
3825 |
|
3826 | </dt>
|
3827 | <dd>
|
3828 |
|
3829 |
|
3830 | <div class="description">
|
3831 | <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> (it should be an object) from the <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> response generated by the "getSslPage" function used by the <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> proxy ("headers" property). Useful to parse the response from the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> (or <a href="CB_Net.XHR.html#.callREST"><code>CB_Net.XHR.callREST</code></a> and related) function when it has been called with the "forceJSON" parameter set to true.</p>
|
3832 | </div>
|
3833 |
|
3834 |
|
3835 |
|
3836 |
|
3837 |
|
3838 |
|
3839 |
|
3840 |
|
3841 | <h5>Parameters:</h5>
|
3842 |
|
3843 |
|
3844 | <table class="params table table-striped">
|
3845 | <thead>
|
3846 | <tr>
|
3847 |
|
3848 | <th style="width:12%; min-width:110px;">Name</th>
|
3849 |
|
3850 |
|
3851 | <th style="width:12%; min-width:110px;">Type</th>
|
3852 |
|
3853 |
|
3854 | <th style="width:12%; min-width:110px;">Argument</th>
|
3855 |
|
3856 |
|
3857 |
|
3858 | <th style="width:12%; min-width:110px;">Default</th>
|
3859 |
|
3860 |
|
3861 | <th class="last" style="min-width:310px;">Description</th>
|
3862 | </tr>
|
3863 | </thead>
|
3864 |
|
3865 | <tbody>
|
3866 |
|
3867 |
|
3868 | <tr>
|
3869 |
|
3870 | <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>response</code></td>
|
3871 |
|
3872 |
|
3873 | <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;">
|
3874 |
|
3875 |
|
3876 | <span class="param-type">Object</span>
|
3877 | |
|
3878 |
|
3879 | <span class="param-type">string</span>
|
3880 |
|
3881 |
|
3882 |
|
3883 |
|
3884 | </td>
|
3885 |
|
3886 |
|
3887 | <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;">
|
3888 |
|
3889 |
|
3890 |
|
3891 |
|
3892 |
|
3893 | </td>
|
3894 |
|
3895 |
|
3896 |
|
3897 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3898 |
|
3899 | </td>
|
3900 |
|
3901 |
|
3902 | <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 object</a> which contains the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> property or the value of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> property (string) itself which should contain the <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> response generated by the "getSslPage" function used by the <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> proxy. If a string is provided, tries to parse it as a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object. The "headers" property will be tried to be returned from it.</p></td>
|
3903 | </tr>
|
3904 |
|
3905 |
|
3906 |
|
3907 | <tr>
|
3908 |
|
3909 | <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>sanitize</code></td>
|
3910 |
|
3911 |
|
3912 | <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;">
|
3913 |
|
3914 |
|
3915 | <span class="param-type">boolean</span>
|
3916 |
|
3917 |
|
3918 |
|
3919 |
|
3920 | </td>
|
3921 |
|
3922 |
|
3923 | <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;">
|
3924 |
|
3925 | <optional><br>
|
3926 |
|
3927 |
|
3928 |
|
3929 |
|
3930 |
|
3931 | </td>
|
3932 |
|
3933 |
|
3934 |
|
3935 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3936 |
|
3937 | true
|
3938 |
|
3939 | </td>
|
3940 |
|
3941 |
|
3942 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true and the "headers" property is not found, it will return an empty object ({}) instead of returning null.</p></td>
|
3943 | </tr>
|
3944 |
|
3945 |
|
3946 | </tbody>
|
3947 | </table>
|
3948 |
|
3949 |
|
3950 |
|
3951 |
|
3952 | <dl class="details">
|
3953 |
|
3954 |
|
3955 |
|
3956 |
|
3957 |
|
3958 |
|
3959 |
|
3960 |
|
3961 |
|
3962 |
|
3963 |
|
3964 |
|
3965 |
|
3966 |
|
3967 |
|
3968 |
|
3969 |
|
3970 |
|
3971 |
|
3972 |
|
3973 |
|
3974 |
|
3975 |
|
3976 |
|
3977 |
|
3978 |
|
3979 |
|
3980 |
|
3981 |
|
3982 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3983 | <dd class="tag-source">
|
3984 | <ul class="dummy">
|
3985 | <li>
|
3986 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
3987 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-546">line 546</a>
|
3988 | </li>
|
3989 | </ul>
|
3990 | </dd>
|
3991 |
|
3992 |
|
3993 |
|
3994 |
|
3995 |
|
3996 |
|
3997 |
|
3998 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
3999 | <dd class="tag-todo">
|
4000 | <ul>
|
4001 | <li>Consider adding the parameter "headerNameFirst".</li>
|
4002 | </ul>
|
4003 | </dd>
|
4004 |
|
4005 | </dl>
|
4006 |
|
4007 |
|
4008 |
|
4009 |
|
4010 |
|
4011 |
|
4012 |
|
4013 |
|
4014 |
|
4015 |
|
4016 |
|
4017 |
|
4018 |
|
4019 | <h5>Returns:</h5>
|
4020 |
|
4021 |
|
4022 | <div class="param-desc">
|
4023 | <p>Returns the content of the "headers" property if possible (it should be a <a href="CB_Net.XHR.html#.HEADERS"><code>CB_Net.XHR.HEADERS</code></a> object). If it is not possible, it will return null if the parameter "sanitize" is set to false or an empty object ({}) otherwise.</p>
|
4024 | </div>
|
4025 |
|
4026 |
|
4027 |
|
4028 | <dl>
|
4029 | <dt>
|
4030 | Type
|
4031 | </dt>
|
4032 | <dd>
|
4033 |
|
4034 | <span class="param-type">Object</span>
|
4035 | |
|
4036 |
|
4037 | <span class="param-type">null</span>
|
4038 |
|
4039 |
|
4040 |
|
4041 | </dd>
|
4042 | </dl>
|
4043 |
|
4044 |
|
4045 |
|
4046 |
|
4047 |
|
4048 | </dd>
|
4049 |
|
4050 |
|
4051 |
|
4052 | <hr>
|
4053 | <dt>
|
4054 | <h4 class="name" id=".getStatusCode"><span class="type-signature"><static> </span>getStatusCode<span class="signature">(response [, sanitize] [, statusDefault])</span><span class="type-signature"> → {integer|*}</span></h4>
|
4055 |
|
4056 |
|
4057 | </dt>
|
4058 | <dd>
|
4059 |
|
4060 |
|
4061 | <div class="description">
|
4062 | <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status">HTTP status</a> code from an <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR object</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status">status</a> property) or from the info array generated by the <a href="https://en.wikipedia.org/wiki/PHP">PHP</a>'s <a href="http://php.net/manual/function.curl-getinfo.php">curl_getinfo</a> function ("http_code" index) or from the <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> response generated by the "getSslPage" function used by the <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> proxy (<a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status">status</a> property). Useful to parse the response from the <a href="CB_Net.XHR.html#.callProxy"><code>CB_Net.XHR.callProxy</code></a> (or <a href="CB_Net.XHR.html#.callREST"><code>CB_Net.XHR.callREST</code></a> and related) function when it has been called with the "forceJSON" parameter set to true.</p>
|
4063 | </div>
|
4064 |
|
4065 |
|
4066 |
|
4067 |
|
4068 |
|
4069 |
|
4070 |
|
4071 |
|
4072 | <h5>Parameters:</h5>
|
4073 |
|
4074 |
|
4075 | <table class="params table table-striped">
|
4076 | <thead>
|
4077 | <tr>
|
4078 |
|
4079 | <th style="width:12%; min-width:110px;">Name</th>
|
4080 |
|
4081 |
|
4082 | <th style="width:12%; min-width:110px;">Type</th>
|
4083 |
|
4084 |
|
4085 | <th style="width:12%; min-width:110px;">Argument</th>
|
4086 |
|
4087 |
|
4088 |
|
4089 | <th style="width:12%; min-width:110px;">Default</th>
|
4090 |
|
4091 |
|
4092 | <th class="last" style="min-width:310px;">Description</th>
|
4093 | </tr>
|
4094 | </thead>
|
4095 |
|
4096 | <tbody>
|
4097 |
|
4098 |
|
4099 | <tr>
|
4100 |
|
4101 | <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>response</code></td>
|
4102 |
|
4103 |
|
4104 | <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;">
|
4105 |
|
4106 |
|
4107 | <span class="param-type">Object</span>
|
4108 | |
|
4109 |
|
4110 | <span class="param-type">string</span>
|
4111 |
|
4112 |
|
4113 |
|
4114 |
|
4115 | </td>
|
4116 |
|
4117 |
|
4118 | <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;">
|
4119 |
|
4120 |
|
4121 |
|
4122 |
|
4123 |
|
4124 | </td>
|
4125 |
|
4126 |
|
4127 |
|
4128 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4129 |
|
4130 | </td>
|
4131 |
|
4132 |
|
4133 | <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 object</a> which contains the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status">status</a> property or the value of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText">responseText</a> property (string) itself which should contain the <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> response generated by the "getSslPage" function used by the <a href="https://en.wikipedia.org/wiki/PHP">PHP</a> proxy. If a string is provided, tries to parse it as a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object. The <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status">status</a> property will be tried to be returned from it (or the "http_code" property as a fallback).</p></td>
|
4134 | </tr>
|
4135 |
|
4136 |
|
4137 |
|
4138 | <tr>
|
4139 |
|
4140 | <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>sanitize</code></td>
|
4141 |
|
4142 |
|
4143 | <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;">
|
4144 |
|
4145 |
|
4146 | <span class="param-type">boolean</span>
|
4147 |
|
4148 |
|
4149 |
|
4150 |
|
4151 | </td>
|
4152 |
|
4153 |
|
4154 | <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;">
|
4155 |
|
4156 | <optional><br>
|
4157 |
|
4158 |
|
4159 |
|
4160 |
|
4161 |
|
4162 | </td>
|
4163 |
|
4164 |
|
4165 |
|
4166 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4167 |
|
4168 | true
|
4169 |
|
4170 | </td>
|
4171 |
|
4172 |
|
4173 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true and neither the "status" nor the "http_code" property are found (or is not a number), it will return the value of "statusDefault" instead of returning null.</p></td>
|
4174 | </tr>
|
4175 |
|
4176 |
|
4177 |
|
4178 | <tr>
|
4179 |
|
4180 | <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>statusDefault</code></td>
|
4181 |
|
4182 |
|
4183 | <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;">
|
4184 |
|
4185 |
|
4186 | <span class="param-type">boolean</span>
|
4187 |
|
4188 |
|
4189 |
|
4190 |
|
4191 | </td>
|
4192 |
|
4193 |
|
4194 | <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;">
|
4195 |
|
4196 | <optional><br>
|
4197 |
|
4198 |
|
4199 |
|
4200 |
|
4201 |
|
4202 | </td>
|
4203 |
|
4204 |
|
4205 |
|
4206 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4207 |
|
4208 | -1
|
4209 |
|
4210 | </td>
|
4211 |
|
4212 |
|
4213 | <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>Default value to return when the status cannot be found (or is not a number). Only used when the "sanitize" parameter is set to true.</p></td>
|
4214 | </tr>
|
4215 |
|
4216 |
|
4217 | </tbody>
|
4218 | </table>
|
4219 |
|
4220 |
|
4221 |
|
4222 |
|
4223 | <dl class="details">
|
4224 |
|
4225 |
|
4226 |
|
4227 |
|
4228 |
|
4229 |
|
4230 |
|
4231 |
|
4232 |
|
4233 |
|
4234 |
|
4235 |
|
4236 |
|
4237 |
|
4238 |
|
4239 |
|
4240 |
|
4241 |
|
4242 |
|
4243 |
|
4244 |
|
4245 |
|
4246 |
|
4247 |
|
4248 |
|
4249 |
|
4250 |
|
4251 |
|
4252 |
|
4253 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4254 | <dd class="tag-source">
|
4255 | <ul class="dummy">
|
4256 | <li>
|
4257 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
4258 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-563">line 563</a>
|
4259 | </li>
|
4260 | </ul>
|
4261 | </dd>
|
4262 |
|
4263 |
|
4264 |
|
4265 |
|
4266 |
|
4267 |
|
4268 |
|
4269 | </dl>
|
4270 |
|
4271 |
|
4272 |
|
4273 |
|
4274 |
|
4275 |
|
4276 |
|
4277 |
|
4278 |
|
4279 |
|
4280 |
|
4281 |
|
4282 |
|
4283 | <h5>Returns:</h5>
|
4284 |
|
4285 |
|
4286 | <div class="param-desc">
|
4287 | <p>Returns the content of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status">status</a> (or "http_code") property if possible (it should be an integer). If it is not possible, it will return null if the parameter "sanitize" is set to false or the value of "statusDefault" otherwise.</p>
|
4288 | </div>
|
4289 |
|
4290 |
|
4291 |
|
4292 | <dl>
|
4293 | <dt>
|
4294 | Type
|
4295 | </dt>
|
4296 | <dd>
|
4297 |
|
4298 | <span class="param-type">integer</span>
|
4299 | |
|
4300 |
|
4301 | <span class="param-type">*</span>
|
4302 |
|
4303 |
|
4304 |
|
4305 | </dd>
|
4306 | </dl>
|
4307 |
|
4308 |
|
4309 |
|
4310 |
|
4311 |
|
4312 | </dd>
|
4313 |
|
4314 |
|
4315 |
|
4316 | <hr>
|
4317 | <dt>
|
4318 | <h4 class="name" id=".supported"><span class="type-signature"><static> </span>supported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
4319 |
|
4320 |
|
4321 | </dt>
|
4322 | <dd>
|
4323 |
|
4324 |
|
4325 | <div class="description">
|
4326 | <p>Returns whether <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>) is available or not.</p>
|
4327 | </div>
|
4328 |
|
4329 |
|
4330 |
|
4331 |
|
4332 |
|
4333 |
|
4334 |
|
4335 |
|
4336 |
|
4337 |
|
4338 | <dl class="details">
|
4339 |
|
4340 |
|
4341 |
|
4342 |
|
4343 |
|
4344 |
|
4345 |
|
4346 |
|
4347 |
|
4348 |
|
4349 |
|
4350 |
|
4351 |
|
4352 |
|
4353 |
|
4354 |
|
4355 |
|
4356 |
|
4357 |
|
4358 |
|
4359 |
|
4360 |
|
4361 |
|
4362 |
|
4363 |
|
4364 |
|
4365 |
|
4366 |
|
4367 |
|
4368 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4369 | <dd class="tag-source">
|
4370 | <ul class="dummy">
|
4371 | <li>
|
4372 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
4373 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-40">line 40</a>
|
4374 | </li>
|
4375 | </ul>
|
4376 | </dd>
|
4377 |
|
4378 |
|
4379 |
|
4380 |
|
4381 |
|
4382 |
|
4383 |
|
4384 | </dl>
|
4385 |
|
4386 |
|
4387 |
|
4388 |
|
4389 |
|
4390 |
|
4391 |
|
4392 |
|
4393 |
|
4394 |
|
4395 |
|
4396 |
|
4397 |
|
4398 | <h5>Returns:</h5>
|
4399 |
|
4400 |
|
4401 | <div class="param-desc">
|
4402 | <p>Returns true if <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR</a> (<a href="https://en.wikipedia.org/wiki/Ajax_(programming)">AJAX</a>) objects can be used.</p>
|
4403 | </div>
|
4404 |
|
4405 |
|
4406 |
|
4407 | <dl>
|
4408 | <dt>
|
4409 | Type
|
4410 | </dt>
|
4411 | <dd>
|
4412 |
|
4413 | <span class="param-type">boolean</span>
|
4414 |
|
4415 |
|
4416 |
|
4417 | </dd>
|
4418 | </dl>
|
4419 |
|
4420 |
|
4421 |
|
4422 |
|
4423 |
|
4424 | </dd>
|
4425 |
|
4426 | </dl>
|
4427 |
|
4428 |
|
4429 |
|
4430 | <h3 class="subsection-title">Type Definitions</h3>
|
4431 |
|
4432 | <dl>
|
4433 |
|
4434 | <hr>
|
4435 | <dt class="name" id=".HEADERS">
|
4436 | <h4 id=".HEADERS">HEADERS</h4>
|
4437 |
|
4438 |
|
4439 | </dt>
|
4440 | <dd>
|
4441 |
|
4442 | <div class="description">
|
4443 | <p>Object containing the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> and their values.</p>
|
4444 | </div>
|
4445 |
|
4446 |
|
4447 |
|
4448 | <h5>Type:</h5>
|
4449 | <ul>
|
4450 | <li>
|
4451 |
|
4452 | <span class="param-type">Object</span>
|
4453 |
|
4454 |
|
4455 |
|
4456 | </li>
|
4457 | </ul>
|
4458 |
|
4459 |
|
4460 |
|
4461 | <dl class="details">
|
4462 |
|
4463 |
|
4464 | <h5 class="subsection-title">Properties:</h5>
|
4465 |
|
4466 | <dl>
|
4467 |
|
4468 | <table class="props table table-striped">
|
4469 | <thead>
|
4470 | <tr>
|
4471 |
|
4472 | <th>Name</th>
|
4473 |
|
4474 |
|
4475 | <th>Type</th>
|
4476 |
|
4477 |
|
4478 |
|
4479 |
|
4480 |
|
4481 | <th class="last">Description</th>
|
4482 | </tr>
|
4483 | </thead>
|
4484 |
|
4485 | <tbody>
|
4486 |
|
4487 |
|
4488 | <tr>
|
4489 |
|
4490 | <td class="name"><code>HTTPHeaderName</code></td>
|
4491 |
|
4492 |
|
4493 | <td class="type">
|
4494 |
|
4495 |
|
4496 | <span class="param-type">Object</span>
|
4497 |
|
4498 |
|
4499 |
|
4500 |
|
4501 | </td>
|
4502 |
|
4503 |
|
4504 |
|
4505 |
|
4506 |
|
4507 | <td class="description last"><p>Each property name is an <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP header</a> and its value is the desired one for this header.</p></td>
|
4508 | </tr>
|
4509 |
|
4510 |
|
4511 | </tbody>
|
4512 | </table>
|
4513 | </dl>
|
4514 |
|
4515 |
|
4516 |
|
4517 |
|
4518 |
|
4519 |
|
4520 |
|
4521 |
|
4522 |
|
4523 |
|
4524 |
|
4525 |
|
4526 |
|
4527 |
|
4528 |
|
4529 |
|
4530 |
|
4531 |
|
4532 |
|
4533 |
|
4534 |
|
4535 |
|
4536 |
|
4537 |
|
4538 |
|
4539 |
|
4540 |
|
4541 |
|
4542 |
|
4543 |
|
4544 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4545 | <dd class="tag-source">
|
4546 | <ul class="dummy">
|
4547 | <li>
|
4548 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html">CrossBase/net/XHR/CB_Net_XHR.js</a>,
|
4549 | <a href="CrossBase_net_XHR_CB_Net_XHR.js.html#sunlight-1-line-92">line 92</a>
|
4550 | </li>
|
4551 | </ul>
|
4552 | </dd>
|
4553 |
|
4554 |
|
4555 |
|
4556 |
|
4557 |
|
4558 |
|
4559 |
|
4560 | </dl>
|
4561 |
|
4562 |
|
4563 |
|
4564 | <h5>Example</h5>
|
4565 |
|
4566 | <pre class="sunlight-highlight-javascript">{ "Content-Type" : "text/plain; charset=x-user-defined", "Cache-Control" : "no-cache", "Pragma" : "no-cache" }</pre>
|
4567 |
|
4568 |
|
4569 |
|
4570 | </dd>
|
4571 |
|
4572 | </dl>
|
4573 |
|
4574 |
|
4575 |
|
4576 | </article>
|
4577 |
|
4578 | </section>
|
4579 |
|
4580 |
|
4581 |
|
4582 |
|
4583 | </div>
|
4584 | </div>
|
4585 |
|
4586 | <div class="clearfix"></div>
|
4587 |
|
4588 |
|
4589 | <div class="col-md-3">
|
4590 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
4591 | </div>
|
4592 |
|
4593 |
|
4594 | </div>
|
4595 | </div>
|
4596 |
|
4597 |
|
4598 | <div class="modal fade" id="searchResults">
|
4599 | <div class="modal-dialog">
|
4600 | <div class="modal-content">
|
4601 | <div class="modal-header">
|
4602 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
4603 | <h4 class="modal-title">Search results</h4>
|
4604 | </div>
|
4605 | <div class="modal-body"></div>
|
4606 | <div class="modal-footer">
|
4607 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
4608 | </div>
|
4609 | </div>
|
4610 | </div>
|
4611 | </div>
|
4612 |
|
4613 |
|
4614 | <footer>
|
4615 |
|
4616 |
|
4617 | <span class="copyright">
|
4618 | <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>
|
4619 | </span>
|
4620 |
|
4621 | <span class="jsdoc-message">
|
4622 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
|
4623 |
|
4624 | on Wed Mar 22nd 2023
|
4625 |
|
4626 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
4627 | </span>
|
4628 | </footer>
|
4629 |
|
4630 | <script src="scripts/docstrap.lib.js"></script>
|
4631 | <script src="scripts/toc.js"></script>
|
4632 |
|
4633 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
4634 |
|
4635 |
|
4636 | <script>
|
4637 | $( function () {
|
4638 | $( "[id*='$']" ).each( function () {
|
4639 | var $this = $( this );
|
4640 |
|
4641 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
4642 | } );
|
4643 |
|
4644 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
4645 | var $this = $( this );
|
4646 |
|
4647 | var example = $this.find( "code" );
|
4648 | exampleText = example.html();
|
4649 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
4650 | if ( lang && lang[1] ) {
|
4651 | exampleText = exampleText.replace( lang[0], "" );
|
4652 | example.html( exampleText );
|
4653 | lang = lang[1];
|
4654 | } else {
|
4655 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
4656 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
4657 | }
|
4658 |
|
4659 | if ( lang ) {
|
4660 |
|
4661 | $this
|
4662 | .addClass( "sunlight-highlight-" + lang )
|
4663 | .addClass( "linenums" )
|
4664 | .html( example.html() );
|
4665 |
|
4666 | }
|
4667 | } );
|
4668 |
|
4669 | Sunlight.highlightAll( {
|
4670 | lineNumbers : true,
|
4671 | showMenu : true,
|
4672 | enableDoclinks : true
|
4673 | } );
|
4674 |
|
4675 | $.catchAnchorLinks( {
|
4676 | navbarOffset: 10
|
4677 | } );
|
4678 | $( "#toc" ).toc( {
|
4679 | anchorName : function ( i, heading, prefix ) {
|
4680 | return $( heading ).attr( "id" ) || ( prefix + i );
|
4681 | },
|
4682 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
4683 | showAndHide : false,
|
4684 | smoothScrolling: true
|
4685 | } );
|
4686 |
|
4687 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
4688 | $( '.dropdown-toggle' ).dropdown();
|
4689 |
|
4690 | $( "table" ).each( function () {
|
4691 | var $this = $( this );
|
4692 | $this.addClass('table');
|
4693 | } );
|
4694 |
|
4695 | } );
|
4696 | </script>
|
4697 |
|
4698 |
|
4699 |
|
4700 |
|
4701 |
|
4702 | <script>
|
4703 | $( function () {
|
4704 | $( '#main' ).localScroll( {
|
4705 | offset : { top : 60 }
|
4706 | } );
|
4707 | $( "dt.name" ).each( function () {
|
4708 | var $this = $( this ).find("h4");
|
4709 | var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
|
4710 | var dt = $(this);
|
4711 | var children = dt.next( "dd" );
|
4712 |
|
4713 | dt.prepend( icon ).css( {cursor : "pointer"} );
|
4714 | dt.addClass( "member-collapsed" ).addClass( "member" );
|
4715 |
|
4716 |
|
4717 | children.hide();
|
4718 |
|
4719 | dt.children().on( "click", function () {
|
4720 | children = dt.next( "dd" );
|
4721 | children.slideToggle( "fast", function () {
|
4722 |
|
4723 | if ( children.is( ":visible" ) ) {
|
4724 | icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
|
4725 | dt.addClass( "member-open" ).animate( "member-collapsed" );
|
4726 | } else {
|
4727 | icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
|
4728 | dt.addClass( "member-collapsed" ).removeClass( "member-open" );
|
4729 | }
|
4730 | } );
|
4731 | } );
|
4732 |
|
4733 | } );
|
4734 | } );
|
4735 | </script>
|
4736 |
|
4737 |
|
4738 |
|
4739 |
|
4740 |
|
4741 |
|
4742 | <script type="text/javascript">
|
4743 | $(document).ready(function() {
|
4744 | SearcherDisplay.init();
|
4745 | });
|
4746 | </script>
|
4747 |
|
4748 |
|
4749 | </body>
|
4750 | </html> |
\ | No newline at end of file |