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