docs: add dummy jsdocs README
[project/luci.git] / docs / jsapi / LuCI.Request.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>Class: Request</title>
6
7
8 <script src="scripts/prettify/prettify.js"></script>
9 <script src="scripts/prettify/lang-css.js"></script>
10 <script src="scripts/jquery.min.js"></script>
11 <!--[if lt IE 9]>
12 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13 <![endif]-->
14 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15 <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
16 <link type="text/css" rel="stylesheet" href="styles/jaguar.css">
17
18
19 <script>
20 var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
21 </script>
22
23
24
25 </head>
26 <body>
27 <div id="wrap" class="clearfix">
28
29 <div class="navigation">
30 <h3 class="applicationName"><a href="index.html"></a></h3>
31
32 <div class="search">
33 <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
34 </div>
35 <ul class="list">
36
37 <li class="item" data-name="LuCI">
38 <span class="title">
39 <a href="LuCI.html">LuCI</a>
40
41 </span>
42 <ul class="members itemMembers">
43
44 <span class="subtitle">Members</span>
45
46 <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li>
47
48 </ul>
49 <ul class="typedefs itemMembers">
50
51 <span class="subtitle">Typedefs</span>
52
53 <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li>
54
55 </ul>
56 <ul class="typedefs itemMembers">
57
58 </ul>
59 <ul class="methods itemMembers">
60
61 <span class="subtitle">Methods</span>
62
63 <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li>
64
65 <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li>
66
67 <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li>
68
69 <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li>
70
71 <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li>
72
73 <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li>
74
75 <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li>
76
77 <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li>
78
79 <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li>
80
81 <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li>
82
83 <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li>
84
85 <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li>
86
87 <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li>
88
89 <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li>
90
91 <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li>
92
93 <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li>
94
95 <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li>
96
97 <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li>
98
99 <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li>
100
101 </ul>
102 <ul class="events itemMembers">
103
104 </ul>
105 </li>
106
107 <li class="item" data-name="LuCI.Class">
108 <span class="title">
109 <a href="LuCI.Class.html">LuCI.Class</a>
110
111 </span>
112 <ul class="members itemMembers">
113
114 </ul>
115 <ul class="typedefs itemMembers">
116
117 </ul>
118 <ul class="typedefs itemMembers">
119
120 </ul>
121 <ul class="methods itemMembers">
122
123 <span class="subtitle">Methods</span>
124
125 <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li>
126
127 <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li>
128
129 <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li>
130
131 <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li>
132
133 <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li>
134
135 <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li>
136
137 </ul>
138 <ul class="events itemMembers">
139
140 </ul>
141 </li>
142
143 <li class="item" data-name="LuCI.dom">
144 <span class="title">
145 <a href="LuCI.dom.html">LuCI.dom</a>
146
147 </span>
148 <ul class="members itemMembers">
149
150 </ul>
151 <ul class="typedefs itemMembers">
152
153 <span class="subtitle">Typedefs</span>
154
155 <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li>
156
157 </ul>
158 <ul class="typedefs itemMembers">
159
160 </ul>
161 <ul class="methods itemMembers">
162
163 <span class="subtitle">Methods</span>
164
165 <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li>
166
167 <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li>
168
169 <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li>
170
171 <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li>
172
173 <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li>
174
175 <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li>
176
177 <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li>
178
179 <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li>
180
181 <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li>
182
183 <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li>
184
185 <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li>
186
187 <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li>
188
189 <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li>
190
191 </ul>
192 <ul class="events itemMembers">
193
194 </ul>
195 </li>
196
197 <li class="item" data-name="LuCI.fs">
198 <span class="title">
199 <a href="LuCI.fs.html">LuCI.fs</a>
200
201 </span>
202 <ul class="members itemMembers">
203
204 </ul>
205 <ul class="typedefs itemMembers">
206
207 <span class="subtitle">Typedefs</span>
208
209 <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li>
210
211 <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li>
212
213 </ul>
214 <ul class="typedefs itemMembers">
215
216 </ul>
217 <ul class="methods itemMembers">
218
219 <span class="subtitle">Methods</span>
220
221 <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li>
222
223 <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li>
224
225 <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li>
226
227 <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li>
228
229 <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li>
230
231 <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li>
232
233 <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li>
234
235 <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li>
236
237 </ul>
238 <ul class="events itemMembers">
239
240 </ul>
241 </li>
242
243 <li class="item" data-name="LuCI.Headers">
244 <span class="title">
245 <a href="LuCI.Headers.html">LuCI.Headers</a>
246
247 </span>
248 <ul class="members itemMembers">
249
250 </ul>
251 <ul class="typedefs itemMembers">
252
253 </ul>
254 <ul class="typedefs itemMembers">
255
256 </ul>
257 <ul class="methods itemMembers">
258
259 <span class="subtitle">Methods</span>
260
261 <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li>
262
263 <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li>
264
265 </ul>
266 <ul class="events itemMembers">
267
268 </ul>
269 </li>
270
271 <li class="item" data-name="LuCI.Network">
272 <span class="title">
273 <a href="LuCI.Network.html">LuCI.Network</a>
274
275 </span>
276 <ul class="members itemMembers">
277
278 </ul>
279 <ul class="typedefs itemMembers">
280
281 <span class="subtitle">Typedefs</span>
282
283 <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li>
284
285 <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li>
286
287 <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li>
288
289 <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li>
290
291 <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li>
292
293 </ul>
294 <ul class="typedefs itemMembers">
295
296 </ul>
297 <ul class="methods itemMembers">
298
299 <span class="subtitle">Methods</span>
300
301 <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li>
302
303 <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li>
304
305 <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li>
306
307 <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
308
309 <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li>
310
311 <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li>
312
313 <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li>
314
315 <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li>
316
317 <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li>
318
319 <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li>
320
321 <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li>
322
323 <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li>
324
325 <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li>
326
327 <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li>
328
329 <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li>
330
331 <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li>
332
333 <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li>
334
335 <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li>
336
337 <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li>
338
339 <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li>
340
341 <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li>
342
343 <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li>
344
345 <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li>
346
347 <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li>
348
349 <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li>
350
351 <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li>
352
353 <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li>
354
355 <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li>
356
357 </ul>
358 <ul class="events itemMembers">
359
360 </ul>
361 </li>
362
363 <li class="item" data-name="LuCI.Network.Device">
364 <span class="title">
365 <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
366
367 </span>
368 <ul class="members itemMembers">
369
370 </ul>
371 <ul class="typedefs itemMembers">
372
373 </ul>
374 <ul class="typedefs itemMembers">
375
376 </ul>
377 <ul class="methods itemMembers">
378
379 <span class="subtitle">Methods</span>
380
381 <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li>
382
383 <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li>
384
385 <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li>
386
387 <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li>
388
389 <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li>
390
391 <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li>
392
393 <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li>
394
395 <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li>
396
397 <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li>
398
399 <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li>
400
401 <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li>
402
403 <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li>
404
405 <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li>
406
407 <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li>
408
409 <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li>
410
411 <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li>
412
413 <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li>
414
415 <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li>
416
417 <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li>
418
419 <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li>
420
421 <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li>
422
423 <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li>
424
425 </ul>
426 <ul class="events itemMembers">
427
428 </ul>
429 </li>
430
431 <li class="item" data-name="LuCI.Network.Hosts">
432 <span class="title">
433 <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>
434
435 </span>
436 <ul class="members itemMembers">
437
438 </ul>
439 <ul class="typedefs itemMembers">
440
441 </ul>
442 <ul class="typedefs itemMembers">
443
444 </ul>
445 <ul class="methods itemMembers">
446
447 <span class="subtitle">Methods</span>
448
449 <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li>
450
451 <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li>
452
453 <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li>
454
455 <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li>
456
457 <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li>
458
459 <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li>
460
461 <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li>
462
463 <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li>
464
465 </ul>
466 <ul class="events itemMembers">
467
468 </ul>
469 </li>
470
471 <li class="item" data-name="LuCI.Network.Protocol">
472 <span class="title">
473 <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
474
475 </span>
476 <ul class="members itemMembers">
477
478 </ul>
479 <ul class="typedefs itemMembers">
480
481 </ul>
482 <ul class="typedefs itemMembers">
483
484 </ul>
485 <ul class="methods itemMembers">
486
487 <span class="subtitle">Methods</span>
488
489 <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li>
490
491 <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li>
492
493 <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li>
494
495 <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li>
496
497 <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li>
498
499 <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li>
500
501 <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li>
502
503 <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li>
504
505 <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li>
506
507 <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li>
508
509 <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li>
510
511 <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li>
512
513 <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li>
514
515 <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li>
516
517 <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li>
518
519 <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li>
520
521 <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li>
522
523 <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li>
524
525 <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li>
526
527 <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li>
528
529 <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li>
530
531 <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li>
532
533 <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li>
534
535 <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li>
536
537 <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li>
538
539 <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li>
540
541 <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li>
542
543 <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li>
544
545 <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li>
546
547 <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li>
548
549 <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li>
550
551 <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li>
552
553 <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li>
554
555 <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li>
556
557 <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li>
558
559 <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li>
560
561 <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li>
562
563 <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li>
564
565 </ul>
566 <ul class="events itemMembers">
567
568 </ul>
569 </li>
570
571 <li class="item" data-name="LuCI.Network.WifiDevice">
572 <span class="title">
573 <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
574
575 </span>
576 <ul class="members itemMembers">
577
578 </ul>
579 <ul class="typedefs itemMembers">
580
581 </ul>
582 <ul class="typedefs itemMembers">
583
584 </ul>
585 <ul class="methods itemMembers">
586
587 <span class="subtitle">Methods</span>
588
589 <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li>
590
591 <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
592
593 <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li>
594
595 <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li>
596
597 <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li>
598
599 <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li>
600
601 <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li>
602
603 <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li>
604
605 <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li>
606
607 <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li>
608
609 <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li>
610
611 <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li>
612
613 <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li>
614
615 </ul>
616 <ul class="events itemMembers">
617
618 </ul>
619 </li>
620
621 <li class="item" data-name="LuCI.Network.WifiNetwork">
622 <span class="title">
623 <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>
624
625 </span>
626 <ul class="members itemMembers">
627
628 </ul>
629 <ul class="typedefs itemMembers">
630
631 </ul>
632 <ul class="typedefs itemMembers">
633
634 </ul>
635 <ul class="methods itemMembers">
636
637 <span class="subtitle">Methods</span>
638
639 <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li>
640
641 <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li>
642
643 <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li>
644
645 <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li>
646
647 <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li>
648
649 <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li>
650
651 <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li>
652
653 <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li>
654
655 <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li>
656
657 <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li>
658
659 <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li>
660
661 <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li>
662
663 <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li>
664
665 <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li>
666
667 <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li>
668
669 <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li>
670
671 <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li>
672
673 <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li>
674
675 <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li>
676
677 <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li>
678
679 <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li>
680
681 <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li>
682
683 <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li>
684
685 <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li>
686
687 <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li>
688
689 <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li>
690
691 <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li>
692
693 <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li>
694
695 <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li>
696
697 <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li>
698
699 <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li>
700
701 <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li>
702
703 <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li>
704
705 <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li>
706
707 <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li>
708
709 </ul>
710 <ul class="events itemMembers">
711
712 </ul>
713 </li>
714
715 <li class="item" data-name="LuCI.Poll">
716 <span class="title">
717 <a href="LuCI.Poll.html">LuCI.Poll</a>
718
719 </span>
720 <ul class="members itemMembers">
721
722 </ul>
723 <ul class="typedefs itemMembers">
724
725 </ul>
726 <ul class="typedefs itemMembers">
727
728 </ul>
729 <ul class="methods itemMembers">
730
731 <span class="subtitle">Methods</span>
732
733 <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li>
734
735 <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li>
736
737 <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li>
738
739 <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li>
740
741 <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li>
742
743 </ul>
744 <ul class="events itemMembers">
745
746 </ul>
747 </li>
748
749 <li class="item" data-name="LuCI.Request">
750 <span class="title">
751 <a href="LuCI.Request.html">LuCI.Request</a>
752
753 </span>
754 <ul class="members itemMembers">
755
756 </ul>
757 <ul class="typedefs itemMembers">
758
759 <span class="subtitle">Typedefs</span>
760
761 <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li>
762
763 <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li>
764
765 </ul>
766 <ul class="typedefs itemMembers">
767
768 </ul>
769 <ul class="methods itemMembers">
770
771 <span class="subtitle">Methods</span>
772
773 <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li>
774
775 <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li>
776
777 <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li>
778
779 <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li>
780
781 <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li>
782
783 <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li>
784
785 </ul>
786 <ul class="events itemMembers">
787
788 </ul>
789 </li>
790
791 <li class="item" data-name="LuCI.Request.poll">
792 <span class="title">
793 <a href="LuCI.Request.poll.html">LuCI.Request.poll</a>
794
795 </span>
796 <ul class="members itemMembers">
797
798 </ul>
799 <ul class="typedefs itemMembers">
800
801 <span class="subtitle">Typedefs</span>
802
803 <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li>
804
805 </ul>
806 <ul class="typedefs itemMembers">
807
808 </ul>
809 <ul class="methods itemMembers">
810
811 <span class="subtitle">Methods</span>
812
813 <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li>
814
815 <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li>
816
817 <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li>
818
819 <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li>
820
821 <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li>
822
823 </ul>
824 <ul class="events itemMembers">
825
826 </ul>
827 </li>
828
829 <li class="item" data-name="LuCI.Response">
830 <span class="title">
831 <a href="LuCI.Response.html">LuCI.Response</a>
832
833 </span>
834 <ul class="members itemMembers">
835
836 <span class="subtitle">Members</span>
837
838 <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li>
839
840 <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li>
841
842 <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li>
843
844 <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li>
845
846 <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li>
847
848 <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li>
849
850 </ul>
851 <ul class="typedefs itemMembers">
852
853 </ul>
854 <ul class="typedefs itemMembers">
855
856 </ul>
857 <ul class="methods itemMembers">
858
859 <span class="subtitle">Methods</span>
860
861 <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li>
862
863 <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li>
864
865 <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li>
866
867 </ul>
868 <ul class="events itemMembers">
869
870 </ul>
871 </li>
872
873 <li class="item" data-name="LuCI.rpc">
874 <span class="title">
875 <a href="LuCI.rpc.html">LuCI.rpc</a>
876
877 </span>
878 <ul class="members itemMembers">
879
880 </ul>
881 <ul class="typedefs itemMembers">
882
883 <span class="subtitle">Typedefs</span>
884
885 <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li>
886
887 <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li>
888
889 <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li>
890
891 <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li>
892
893 </ul>
894 <ul class="typedefs itemMembers">
895
896 </ul>
897 <ul class="methods itemMembers">
898
899 <span class="subtitle">Methods</span>
900
901 <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li>
902
903 <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li>
904
905 <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li>
906
907 <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li>
908
909 <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li>
910
911 <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li>
912
913 <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li>
914
915 <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li>
916
917 <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li>
918
919 </ul>
920 <ul class="events itemMembers">
921
922 </ul>
923 </li>
924
925 <li class="item" data-name="LuCI.uci">
926 <span class="title">
927 <a href="LuCI.uci.html">LuCI.uci</a>
928
929 </span>
930 <ul class="members itemMembers">
931
932 </ul>
933 <ul class="typedefs itemMembers">
934
935 <span class="subtitle">Typedefs</span>
936
937 <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li>
938
939 <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li>
940
941 <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li>
942
943 </ul>
944 <ul class="typedefs itemMembers">
945
946 </ul>
947 <ul class="methods itemMembers">
948
949 <span class="subtitle">Methods</span>
950
951 <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li>
952
953 <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li>
954
955 <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li>
956
957 <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li>
958
959 <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li>
960
961 <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li>
962
963 <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li>
964
965 <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li>
966
967 <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li>
968
969 <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li>
970
971 <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li>
972
973 <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li>
974
975 <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li>
976
977 <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li>
978
979 <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li>
980
981 <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li>
982
983 <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li>
984
985 </ul>
986 <ul class="events itemMembers">
987
988 </ul>
989 </li>
990
991 <li class="item" data-name="LuCI.view">
992 <span class="title">
993 <a href="LuCI.view.html">LuCI.view</a>
994
995 </span>
996 <ul class="members itemMembers">
997
998 </ul>
999 <ul class="typedefs itemMembers">
1000
1001 </ul>
1002 <ul class="typedefs itemMembers">
1003
1004 </ul>
1005 <ul class="methods itemMembers">
1006
1007 <span class="subtitle">Methods</span>
1008
1009 <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li>
1010
1011 <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li>
1012
1013 <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li>
1014
1015 <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li>
1016
1017 <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li>
1018
1019 <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li>
1020
1021 </ul>
1022 <ul class="events itemMembers">
1023
1024 </ul>
1025 </li>
1026
1027 <li class="item" data-name="LuCI.XHR">
1028 <span class="title">
1029 <a href="LuCI.XHR.html">LuCI.XHR</a>
1030
1031 </span>
1032 <ul class="members itemMembers">
1033
1034 </ul>
1035 <ul class="typedefs itemMembers">
1036
1037 </ul>
1038 <ul class="typedefs itemMembers">
1039
1040 </ul>
1041 <ul class="methods itemMembers">
1042
1043 <span class="subtitle">Methods</span>
1044
1045 <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li>
1046
1047 <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li>
1048
1049 <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li>
1050
1051 <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li>
1052
1053 <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li>
1054
1055 <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li>
1056
1057 </ul>
1058 <ul class="events itemMembers">
1059
1060 </ul>
1061 </li>
1062
1063 </ul>
1064 </div>
1065 <div class="main">
1066 <h1 class="page-title" data-filename="LuCI.Request.html">Class: Request</h1>
1067
1068
1069
1070
1071 <section>
1072
1073 <header>
1074 <h2>
1075 <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>
1076
1077 Request
1078 </h2>
1079
1080 <div class="class-description"><p>The <code>Request</code> class allows initiating HTTP requests and provides utilities
1081 for dealing with responses.</p></div>
1082
1083 </header>
1084
1085 <article>
1086 <div class="container-overview">
1087
1088
1089
1090
1091 <dt>
1092 <div class="nameContainer">
1093 <h4 class="name" id="Request">
1094
1095 new LuCI.Request<span class="signature">()</span>
1096 </h4>
1097
1098
1099 <div class="tag-source">
1100 luci.js, line 569
1101 </div>
1102
1103 </div>
1104
1105
1106 </dt>
1107 <dd>
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118 <dl class="details">
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140 </dl>
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154 </dd>
1155
1156
1157 </div>
1158
1159
1160
1161
1162
1163
1164
1165
1166 <h3 class="subsection-title">Classes</h3>
1167
1168 <dl>
1169 <dt><a href="LuCI.Request.poll.html">poll</a></dt>
1170 <dd></dd>
1171 </dl>
1172
1173
1174
1175
1176
1177
1178
1179 <h3 class="subsection-title">Methods</h3>
1180
1181 <dl>
1182
1183 <dt>
1184 <div class="nameContainer">
1185 <h4 class="name" id="addInterceptor">
1186
1187 addInterceptor<span class="signature">(interceptorFn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Request.html#.interceptorFn">LuCI.Request.interceptorFn</a>}</span>
1188 </h4>
1189
1190
1191 <div class="tag-source">
1192 luci.js, line 844
1193 </div>
1194
1195 </div>
1196
1197
1198 </dt>
1199 <dd>
1200
1201
1202 <div class="description">
1203 <p>Register an HTTP response interceptor function. Interceptor
1204 functions are useful to perform default actions on incoming HTTP
1205 responses, such as checking for expired authentication or for
1206 implementing request retries before returning a failure.</p>
1207 </div>
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217 <table class="params">
1218 <thead>
1219 <tr>
1220
1221 <th>Name</th>
1222
1223
1224 <th>Type</th>
1225
1226
1227
1228 <th class="last">Description</th>
1229 </tr>
1230 </thead>
1231
1232 <tbody>
1233
1234
1235 <tr>
1236
1237 <td class="name"><code>interceptorFn</code></td>
1238
1239
1240 <td class="type">
1241
1242
1243 <span class="param-type"><a href="LuCI.Request.html#.interceptorFn">LuCI.Request.interceptorFn</a></span>
1244
1245
1246
1247 </td>
1248
1249
1250
1251 <td class="description last">
1252
1253 <p>The interceptor function to register.</p></td>
1254 </tr>
1255
1256
1257 </tbody>
1258 </table>
1259
1260
1261
1262 <dl class="details">
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284 </dl>
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296 <h5>Returns:</h5>
1297
1298
1299
1300 <table class="params">
1301 <thead>
1302 <tr>
1303
1304 <th>Type</th>
1305 <th class="last">Description</th>
1306 </tr>
1307 </thead>
1308 <tbody>
1309
1310 <tr>
1311
1312 <td class="type">
1313
1314 <a href="LuCI.Request.html#.interceptorFn">LuCI.Request.interceptorFn</a>
1315
1316
1317 </td>
1318 <td class="description last">The registered function.</td>
1319 </tr>
1320
1321 </tbody>
1322 </table>
1323
1324
1325
1326
1327 </dd>
1328
1329
1330
1331 <dt>
1332 <div class="nameContainer">
1333 <h4 class="name" id="expandURL">
1334
1335 expandURL<span class="signature">(url)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1336 </h4>
1337
1338
1339 <div class="tag-source">
1340 luci.js, line 586
1341 </div>
1342
1343 </div>
1344
1345
1346 </dt>
1347 <dd>
1348
1349
1350 <div class="description">
1351 <p>Turn the given relative URL into an absolute URL if necessary.</p>
1352 </div>
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362 <table class="params">
1363 <thead>
1364 <tr>
1365
1366 <th>Name</th>
1367
1368
1369 <th>Type</th>
1370
1371
1372
1373 <th class="last">Description</th>
1374 </tr>
1375 </thead>
1376
1377 <tbody>
1378
1379
1380 <tr>
1381
1382 <td class="name"><code>url</code></td>
1383
1384
1385 <td class="type">
1386
1387
1388 <span class="param-type">string</span>
1389
1390
1391
1392 </td>
1393
1394
1395
1396 <td class="description last">
1397
1398 <p>The URL to convert.</p></td>
1399 </tr>
1400
1401
1402 </tbody>
1403 </table>
1404
1405
1406
1407 <dl class="details">
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429 </dl>
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441 <h5>Returns:</h5>
1442
1443
1444
1445 <table class="params">
1446 <thead>
1447 <tr>
1448
1449 <th>Type</th>
1450 <th class="last">Description</th>
1451 </tr>
1452 </thead>
1453 <tbody>
1454
1455 <tr>
1456
1457 <td class="type">
1458
1459 string
1460
1461
1462 </td>
1463 <td class="description last">The absolute URL derived from the given one, or the original URL
1464 if it already was absolute.</td>
1465 </tr>
1466
1467 </tbody>
1468 </table>
1469
1470
1471
1472
1473 </dd>
1474
1475
1476
1477 <dt>
1478 <div class="nameContainer">
1479 <h4 class="name" id="get">
1480
1481 get<span class="signature">(target, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;<a href="LuCI.Response.html">LuCI.Response</a>>}</span>
1482 </h4>
1483
1484
1485 <div class="tag-source">
1486 luci.js, line 797
1487 </div>
1488
1489 </div>
1490
1491
1492 </dt>
1493 <dd>
1494
1495
1496 <div class="description">
1497 <p>Initiate an HTTP GET request to the given target.</p>
1498 </div>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508 <table class="params">
1509 <thead>
1510 <tr>
1511
1512 <th>Name</th>
1513
1514
1515 <th>Type</th>
1516
1517
1518
1519 <th class="last">Description</th>
1520 </tr>
1521 </thead>
1522
1523 <tbody>
1524
1525
1526 <tr>
1527
1528 <td class="name"><code>target</code></td>
1529
1530
1531 <td class="type">
1532
1533
1534 <span class="param-type">string</span>
1535
1536
1537
1538 </td>
1539
1540
1541
1542 <td class="description last">
1543
1544
1545
1546
1547
1548
1549 <p>The URL to request.</p></td>
1550 </tr>
1551
1552
1553
1554 <tr>
1555
1556 <td class="name"><code>options</code></td>
1557
1558
1559 <td class="type">
1560
1561
1562 <span class="param-type"><a href="LuCI.Request.html#.RequestOptions">LuCI.Request.RequestOptions</a></span>
1563
1564
1565
1566 </td>
1567
1568
1569
1570 <td class="description last">
1571
1572
1573 <span class="optional">optional</span>
1574
1575
1576
1577
1578
1579 <p>Additional options to configure the request.</p></td>
1580 </tr>
1581
1582
1583 </tbody>
1584 </table>
1585
1586
1587
1588 <dl class="details">
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610 </dl>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622 <h5>Returns:</h5>
1623
1624
1625
1626 <table class="params">
1627 <thead>
1628 <tr>
1629
1630 <th>Type</th>
1631 <th class="last">Description</th>
1632 </tr>
1633 </thead>
1634 <tbody>
1635
1636 <tr>
1637
1638 <td class="type">
1639
1640 Promise.&lt;<a href="LuCI.Response.html">LuCI.Response</a>>
1641
1642
1643 </td>
1644 <td class="description last">The resulting HTTP response.</td>
1645 </tr>
1646
1647 </tbody>
1648 </table>
1649
1650
1651
1652
1653 </dd>
1654
1655
1656
1657 <dt>
1658 <div class="nameContainer">
1659 <h4 class="name" id="post">
1660
1661 post<span class="signature">(target, <span class="optional">data</span>, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;<a href="LuCI.Response.html">LuCI.Response</a>>}</span>
1662 </h4>
1663
1664
1665 <div class="tag-source">
1666 luci.js, line 818
1667 </div>
1668
1669 </div>
1670
1671
1672 </dt>
1673 <dd>
1674
1675
1676 <div class="description">
1677 <p>Initiate an HTTP POST request to the given target.</p>
1678 </div>
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688 <table class="params">
1689 <thead>
1690 <tr>
1691
1692 <th>Name</th>
1693
1694
1695 <th>Type</th>
1696
1697
1698
1699 <th class="last">Description</th>
1700 </tr>
1701 </thead>
1702
1703 <tbody>
1704
1705
1706 <tr>
1707
1708 <td class="name"><code>target</code></td>
1709
1710
1711 <td class="type">
1712
1713
1714 <span class="param-type">string</span>
1715
1716
1717
1718 </td>
1719
1720
1721
1722 <td class="description last">
1723
1724
1725
1726
1727
1728
1729 <p>The URL to request.</p></td>
1730 </tr>
1731
1732
1733
1734 <tr>
1735
1736 <td class="name"><code>data</code></td>
1737
1738
1739 <td class="type">
1740
1741
1742 <span class="param-type">*</span>
1743
1744
1745
1746 </td>
1747
1748
1749
1750 <td class="description last">
1751
1752
1753 <span class="optional">optional</span>
1754
1755
1756
1757
1758
1759 <p>The request data to send, see <a href="LuCI.Request.html#.RequestOptions"><code>LuCI.Request.RequestOptions</code></a> for details.</p></td>
1760 </tr>
1761
1762
1763
1764 <tr>
1765
1766 <td class="name"><code>options</code></td>
1767
1768
1769 <td class="type">
1770
1771
1772 <span class="param-type"><a href="LuCI.Request.html#.RequestOptions">LuCI.Request.RequestOptions</a></span>
1773
1774
1775
1776 </td>
1777
1778
1779
1780 <td class="description last">
1781
1782
1783 <span class="optional">optional</span>
1784
1785
1786
1787
1788
1789 <p>Additional options to configure the request.</p></td>
1790 </tr>
1791
1792
1793 </tbody>
1794 </table>
1795
1796
1797
1798 <dl class="details">
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820 </dl>
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832 <h5>Returns:</h5>
1833
1834
1835
1836 <table class="params">
1837 <thead>
1838 <tr>
1839
1840 <th>Type</th>
1841 <th class="last">Description</th>
1842 </tr>
1843 </thead>
1844 <tbody>
1845
1846 <tr>
1847
1848 <td class="type">
1849
1850 Promise.&lt;<a href="LuCI.Response.html">LuCI.Response</a>>
1851
1852
1853 </td>
1854 <td class="description last">The resulting HTTP response.</td>
1855 </tr>
1856
1857 </tbody>
1858 </table>
1859
1860
1861
1862
1863 </dd>
1864
1865
1866
1867 <dt>
1868 <div class="nameContainer">
1869 <h4 class="name" id="removeInterceptor">
1870
1871 removeInterceptor<span class="signature">(interceptorFn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
1872 </h4>
1873
1874
1875 <div class="tag-source">
1876 luci.js, line 863
1877 </div>
1878
1879 </div>
1880
1881
1882 </dt>
1883 <dd>
1884
1885
1886 <div class="description">
1887 <p>Remove an HTTP response interceptor function. The passed function
1888 value must be the very same value that was used to register the
1889 function.</p>
1890 </div>
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900 <table class="params">
1901 <thead>
1902 <tr>
1903
1904 <th>Name</th>
1905
1906
1907 <th>Type</th>
1908
1909
1910
1911 <th class="last">Description</th>
1912 </tr>
1913 </thead>
1914
1915 <tbody>
1916
1917
1918 <tr>
1919
1920 <td class="name"><code>interceptorFn</code></td>
1921
1922
1923 <td class="type">
1924
1925
1926 <span class="param-type"><a href="LuCI.Request.html#.interceptorFn">LuCI.Request.interceptorFn</a></span>
1927
1928
1929
1930 </td>
1931
1932
1933
1934 <td class="description last">
1935
1936 <p>The interceptor function to remove.</p></td>
1937 </tr>
1938
1939
1940 </tbody>
1941 </table>
1942
1943
1944
1945 <dl class="details">
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967 </dl>
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979 <h5>Returns:</h5>
1980
1981
1982
1983 <table class="params">
1984 <thead>
1985 <tr>
1986
1987 <th>Type</th>
1988 <th class="last">Description</th>
1989 </tr>
1990 </thead>
1991 <tbody>
1992
1993 <tr>
1994
1995 <td class="type">
1996
1997 boolean
1998
1999
2000 </td>
2001 <td class="description last">Returns <code>true</code> if any function has been removed, else <code>false</code>.</td>
2002 </tr>
2003
2004 </tbody>
2005 </table>
2006
2007
2008
2009
2010 </dd>
2011
2012
2013
2014 <dt>
2015 <div class="nameContainer">
2016 <h4 class="name" id="request">
2017
2018 request<span class="signature">(target, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;<a href="LuCI.Response.html">LuCI.Response</a>>}</span>
2019 </h4>
2020
2021
2022 <div class="tag-source">
2023 luci.js, line 648
2024 </div>
2025
2026 </div>
2027
2028
2029 </dt>
2030 <dd>
2031
2032
2033 <div class="description">
2034 <p>Initiate an HTTP request to the given target.</p>
2035 </div>
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045 <table class="params">
2046 <thead>
2047 <tr>
2048
2049 <th>Name</th>
2050
2051
2052 <th>Type</th>
2053
2054
2055
2056 <th class="last">Description</th>
2057 </tr>
2058 </thead>
2059
2060 <tbody>
2061
2062
2063 <tr>
2064
2065 <td class="name"><code>target</code></td>
2066
2067
2068 <td class="type">
2069
2070
2071 <span class="param-type">string</span>
2072
2073
2074
2075 </td>
2076
2077
2078
2079 <td class="description last">
2080
2081
2082
2083
2084
2085
2086 <p>The URL to request.</p></td>
2087 </tr>
2088
2089
2090
2091 <tr>
2092
2093 <td class="name"><code>options</code></td>
2094
2095
2096 <td class="type">
2097
2098
2099 <span class="param-type"><a href="LuCI.Request.html#.RequestOptions">LuCI.Request.RequestOptions</a></span>
2100
2101
2102
2103 </td>
2104
2105
2106
2107 <td class="description last">
2108
2109
2110 <span class="optional">optional</span>
2111
2112
2113
2114
2115
2116 <p>Additional options to configure the request.</p></td>
2117 </tr>
2118
2119
2120 </tbody>
2121 </table>
2122
2123
2124
2125 <dl class="details">
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147 </dl>
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159 <h5>Returns:</h5>
2160
2161
2162
2163 <table class="params">
2164 <thead>
2165 <tr>
2166
2167 <th>Type</th>
2168 <th class="last">Description</th>
2169 </tr>
2170 </thead>
2171 <tbody>
2172
2173 <tr>
2174
2175 <td class="type">
2176
2177 Promise.&lt;<a href="LuCI.Response.html">LuCI.Response</a>>
2178
2179
2180 </td>
2181 <td class="description last">The resulting HTTP response.</td>
2182 </tr>
2183
2184 </tbody>
2185 </table>
2186
2187
2188
2189
2190 </dd>
2191
2192 </dl>
2193
2194
2195
2196 <h3 class="subsection-title">Type Definitions</h3>
2197
2198 <dl>
2199
2200 <dt>
2201 <div class="nameContainer">
2202 <h4 class="name" id=".interceptorFn">
2203
2204 LuCI.Request.interceptorFn<span class="signature">(res)</span>
2205 </h4>
2206
2207
2208 <div class="tag-source">
2209 luci.js, line 822
2210 </div>
2211
2212 </div>
2213
2214
2215 </dt>
2216 <dd>
2217
2218
2219 <div class="description">
2220 <p>Interceptor functions are invoked whenever an HTTP reply is received, in the order
2221 these functions have been registered.</p>
2222 </div>
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232 <table class="params">
2233 <thead>
2234 <tr>
2235
2236 <th>Name</th>
2237
2238
2239 <th>Type</th>
2240
2241
2242
2243 <th class="last">Description</th>
2244 </tr>
2245 </thead>
2246
2247 <tbody>
2248
2249
2250 <tr>
2251
2252 <td class="name"><code>res</code></td>
2253
2254
2255 <td class="type">
2256
2257
2258 <span class="param-type"><a href="LuCI.Response.html">LuCI.Response</a></span>
2259
2260
2261
2262 </td>
2263
2264
2265
2266 <td class="description last">
2267
2268 <p>The HTTP response object</p></td>
2269 </tr>
2270
2271
2272 </tbody>
2273 </table>
2274
2275
2276
2277 <dl class="details">
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299 </dl>
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313 </dd>
2314
2315
2316
2317 <dt>
2318 <div class="nameContainer">
2319 <h4 class="name" id=".RequestOptions">LuCI.Request.RequestOptions<span class="type-signature type object">Object</span> </h4>
2320 </div>
2321
2322
2323 </dt>
2324 <dd>
2325
2326
2327
2328 <dl class="details">
2329
2330
2331 <h5 class="subsection-title">Properties:</h5>
2332
2333 <dl>
2334
2335 <table class="props">
2336 <thead>
2337 <tr>
2338
2339 <th>Name</th>
2340
2341
2342 <th>Type</th>
2343
2344
2345 <th>Argument</th>
2346
2347
2348
2349 <th>Default</th>
2350
2351
2352 <th class="last">Description</th>
2353 </tr>
2354 </thead>
2355
2356 <tbody>
2357
2358
2359 <tr>
2360
2361 <td class="name"><code>method</code></td>
2362
2363
2364 <td class="type">
2365
2366
2367 <span class="param-type">string</span>
2368
2369
2370
2371 </td>
2372
2373
2374 <td class="attributes">
2375
2376 &lt;optional><br>
2377
2378
2379
2380 </td>
2381
2382
2383
2384 <td class="default">
2385
2386 GET
2387
2388 </td>
2389
2390
2391 <td class="description last"><p>The HTTP method to use, e.g. <code>GET</code> or <code>POST</code>.</p></td>
2392 </tr>
2393
2394
2395
2396 <tr>
2397
2398 <td class="name"><code>query</code></td>
2399
2400
2401 <td class="type">
2402
2403
2404 <span class="param-type">Object.&lt;string, (Object|string)></span>
2405
2406
2407
2408 </td>
2409
2410
2411 <td class="attributes">
2412
2413 &lt;optional><br>
2414
2415
2416
2417 </td>
2418
2419
2420
2421 <td class="default">
2422
2423 </td>
2424
2425
2426 <td class="description last"><p>Query string data to append to the URL. Non-string values of the
2427 given object will be converted to JSON.</p></td>
2428 </tr>
2429
2430
2431
2432 <tr>
2433
2434 <td class="name"><code>cache</code></td>
2435
2436
2437 <td class="type">
2438
2439
2440 <span class="param-type">boolean</span>
2441
2442
2443
2444 </td>
2445
2446
2447 <td class="attributes">
2448
2449 &lt;optional><br>
2450
2451
2452
2453 </td>
2454
2455
2456
2457 <td class="default">
2458
2459 false
2460
2461 </td>
2462
2463
2464 <td class="description last"><p>Specifies whether the HTTP response may be retrieved from cache.</p></td>
2465 </tr>
2466
2467
2468
2469 <tr>
2470
2471 <td class="name"><code>username</code></td>
2472
2473
2474 <td class="type">
2475
2476
2477 <span class="param-type">string</span>
2478
2479
2480
2481 </td>
2482
2483
2484 <td class="attributes">
2485
2486 &lt;optional><br>
2487
2488
2489
2490 </td>
2491
2492
2493
2494 <td class="default">
2495
2496 </td>
2497
2498
2499 <td class="description last"><p>Provides a username for HTTP basic authentication.</p></td>
2500 </tr>
2501
2502
2503
2504 <tr>
2505
2506 <td class="name"><code>password</code></td>
2507
2508
2509 <td class="type">
2510
2511
2512 <span class="param-type">string</span>
2513
2514
2515
2516 </td>
2517
2518
2519 <td class="attributes">
2520
2521 &lt;optional><br>
2522
2523
2524
2525 </td>
2526
2527
2528
2529 <td class="default">
2530
2531 </td>
2532
2533
2534 <td class="description last"><p>Provides a password for HTTP basic authentication.</p></td>
2535 </tr>
2536
2537
2538
2539 <tr>
2540
2541 <td class="name"><code>timeout</code></td>
2542
2543
2544 <td class="type">
2545
2546
2547 <span class="param-type">number</span>
2548
2549
2550
2551 </td>
2552
2553
2554 <td class="attributes">
2555
2556 &lt;optional><br>
2557
2558
2559
2560 </td>
2561
2562
2563
2564 <td class="default">
2565
2566 </td>
2567
2568
2569 <td class="description last"><p>Specifies the request timeout in seconds.</p></td>
2570 </tr>
2571
2572
2573
2574 <tr>
2575
2576 <td class="name"><code>credentials</code></td>
2577
2578
2579 <td class="type">
2580
2581
2582 <span class="param-type">boolean</span>
2583
2584
2585
2586 </td>
2587
2588
2589 <td class="attributes">
2590
2591 &lt;optional><br>
2592
2593
2594
2595 </td>
2596
2597
2598
2599 <td class="default">
2600
2601 false
2602
2603 </td>
2604
2605
2606 <td class="description last"><p>Whether to include credentials such as cookies in the request.</p></td>
2607 </tr>
2608
2609
2610
2611 <tr>
2612
2613 <td class="name"><code>content</code></td>
2614
2615
2616 <td class="type">
2617
2618
2619 <span class="param-type">*</span>
2620
2621
2622
2623 </td>
2624
2625
2626 <td class="attributes">
2627
2628 &lt;optional><br>
2629
2630
2631
2632 </td>
2633
2634
2635
2636 <td class="default">
2637
2638 </td>
2639
2640
2641 <td class="description last"><p>Specifies the HTTP message body to send along with the request.
2642 If the value is a function, it is invoked and the return value
2643 used as content, if it is a FormData instance, it is used as-is,
2644 if it is an object, it will be converted to JSON, in all other
2645 cases it is converted to a string.</p></td>
2646 </tr>
2647
2648
2649
2650 <tr>
2651
2652 <td class="name"><code>header</code></td>
2653
2654
2655 <td class="type">
2656
2657
2658 <span class="param-type">Object.&lt;string, string></span>
2659
2660
2661
2662 </td>
2663
2664
2665 <td class="attributes">
2666
2667 &lt;optional><br>
2668
2669
2670
2671 </td>
2672
2673
2674
2675 <td class="default">
2676
2677 </td>
2678
2679
2680 <td class="description last"><p>Specifies HTTP headers to set for the request.</p></td>
2681 </tr>
2682
2683
2684
2685 <tr>
2686
2687 <td class="name"><code>progress</code></td>
2688
2689
2690 <td class="type">
2691
2692
2693 <span class="param-type">function</span>
2694
2695
2696
2697 </td>
2698
2699
2700 <td class="attributes">
2701
2702 &lt;optional><br>
2703
2704
2705
2706 </td>
2707
2708
2709
2710 <td class="default">
2711
2712 </td>
2713
2714
2715 <td class="description last"><p>An optional request callback function which receives ProgressEvent
2716 instances as sole argument during the HTTP request transfer.</p></td>
2717 </tr>
2718
2719
2720 </tbody>
2721 </table></dl>
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744 </dl>
2745
2746
2747
2748 </dd>
2749
2750 </dl>
2751
2752
2753
2754
2755
2756 </article>
2757
2758 </section>
2759
2760
2761
2762
2763
2764
2765
2766 <footer>
2767 Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
2768 </footer>
2769 </div>
2770 </div>
2771 <script>prettyPrint();</script>
2772 <script src="scripts/jaguar.js"></script>
2773 </body>
2774 </html>