docs: rename documentation folder to docs
[project/luci.git] / docs / jsapi / LuCI.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>Class: LuCI</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.html">Class: LuCI</h1>
1067
1068
1069
1070
1071 <section>
1072
1073 <header>
1074 <h2>
1075 LuCI
1076 </h2>
1077
1078 <div class="class-description"><p>This is the LuCI base class. It is automatically instantiated and
1079 accessible using the global <code>L</code> variable.</p></div>
1080
1081 </header>
1082
1083 <article>
1084 <div class="container-overview">
1085
1086
1087
1088
1089 <dt>
1090 <div class="nameContainer">
1091 <h4 class="name" id="LuCI">
1092
1093 new LuCI<span class="signature">(env)</span>
1094 </h4>
1095
1096
1097 <div class="tag-source">
1098 luci.js, line 1
1099 </div>
1100
1101 </div>
1102
1103
1104 </dt>
1105 <dd>
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116 <table class="params">
1117 <thead>
1118 <tr>
1119
1120 <th>Name</th>
1121
1122
1123 <th>Type</th>
1124
1125
1126
1127 <th class="last">Description</th>
1128 </tr>
1129 </thead>
1130
1131 <tbody>
1132
1133
1134 <tr>
1135
1136 <td class="name"><code>env</code></td>
1137
1138
1139 <td class="type">
1140
1141
1142 <span class="param-type">Object</span>
1143
1144
1145
1146 </td>
1147
1148
1149
1150 <td class="description last">
1151
1152 <p>The environment settings to use for the LuCI runtime.</p></td>
1153 </tr>
1154
1155
1156 </tbody>
1157 </table>
1158
1159
1160
1161 <dl class="details">
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183 </dl>
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197 </dd>
1198
1199
1200 </div>
1201
1202
1203
1204
1205
1206
1207
1208
1209 <h3 class="subsection-title">Classes</h3>
1210
1211 <dl>
1212 <dt><a href="LuCI.Class.html">Class</a></dt>
1213 <dd></dd>
1214
1215 <dt><a href="LuCI.dom.html">dom</a></dt>
1216 <dd></dd>
1217
1218 <dt><a href="LuCI.fs.html">fs</a></dt>
1219 <dd></dd>
1220
1221 <dt><a href="LuCI.Headers.html">Headers</a></dt>
1222 <dd></dd>
1223
1224 <dt><a href="LuCI.Network.html">Network</a></dt>
1225 <dd></dd>
1226
1227 <dt><a href="LuCI.Poll.html">Poll</a></dt>
1228 <dd></dd>
1229
1230 <dt><a href="LuCI.Request.html">Request</a></dt>
1231 <dd></dd>
1232
1233 <dt><a href="LuCI.Response.html">Response</a></dt>
1234 <dd></dd>
1235
1236 <dt><a href="LuCI.rpc.html">rpc</a></dt>
1237 <dd></dd>
1238
1239 <dt><a href="LuCI.uci.html">uci</a></dt>
1240 <dd></dd>
1241
1242 <dt><a href="LuCI.view.html">view</a></dt>
1243 <dd></dd>
1244
1245 <dt><a href="LuCI.XHR.html">XHR</a></dt>
1246 <dd></dd>
1247 </dl>
1248
1249
1250
1251
1252
1253 <h3 class="subsection-title">Members</h3>
1254
1255 <dl>
1256
1257 <dt>
1258 <div class="nameContainer">
1259 <h4 class="name" id="env">env</h4>
1260 </div>
1261
1262
1263 </dt>
1264 <dd>
1265
1266 <div class="description">
1267 <p>The <code>env</code> object holds environment settings used by LuCI, such
1268 as request timeouts, base URLs etc.</p>
1269 </div>
1270
1271
1272
1273 <dl class="details">
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295 </dl>
1296
1297
1298
1299 </dd>
1300
1301 </dl>
1302
1303
1304
1305 <h3 class="subsection-title">Methods</h3>
1306
1307 <dl>
1308
1309 <dt>
1310 <div class="nameContainer">
1311 <h4 class="name" id="bind">
1312
1313 bind<span class="signature">(fn, self, <span class="optional">args</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{function}</span>
1314 </h4>
1315
1316
1317 <div class="tag-source">
1318 luci.js, line 1340
1319 </div>
1320
1321 </div>
1322
1323
1324 </dt>
1325 <dd>
1326
1327
1328 <div class="description">
1329 <p>Return a bound function using the given <code>self</code> as <code>this</code> context
1330 and any further arguments as parameters to the bound function.</p>
1331 </div>
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341 <table class="params">
1342 <thead>
1343 <tr>
1344
1345 <th>Name</th>
1346
1347
1348 <th>Type</th>
1349
1350
1351
1352 <th class="last">Description</th>
1353 </tr>
1354 </thead>
1355
1356 <tbody>
1357
1358
1359 <tr>
1360
1361 <td class="name"><code>fn</code></td>
1362
1363
1364 <td class="type">
1365
1366
1367 <span class="param-type">function</span>
1368
1369
1370
1371 </td>
1372
1373
1374
1375 <td class="description last">
1376
1377
1378
1379
1380
1381
1382 <p>The function to bind.</p></td>
1383 </tr>
1384
1385
1386
1387 <tr>
1388
1389 <td class="name"><code>self</code></td>
1390
1391
1392 <td class="type">
1393
1394
1395 <span class="param-type">*</span>
1396
1397
1398
1399 </td>
1400
1401
1402
1403 <td class="description last">
1404
1405
1406
1407
1408
1409
1410 <p>The value to bind as <code>this</code> context to the specified function.</p></td>
1411 </tr>
1412
1413
1414
1415 <tr>
1416
1417 <td class="name"><code>args</code></td>
1418
1419
1420 <td class="type">
1421
1422
1423 <span class="param-type">*</span>
1424
1425
1426
1427 </td>
1428
1429
1430
1431 <td class="description last">
1432
1433
1434 <span class="optional">optional</span>
1435
1436
1437
1438
1439 <span class="repeatable">repeatable</span>
1440
1441
1442 <p>Zero or more variable arguments which are bound to the function
1443 as parameters.</p></td>
1444 </tr>
1445
1446
1447 </tbody>
1448 </table>
1449
1450
1451
1452 <dl class="details">
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474 </dl>
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486 <h5>Returns:</h5>
1487
1488
1489
1490 <table class="params">
1491 <thead>
1492 <tr>
1493
1494 <th>Type</th>
1495 <th class="last">Description</th>
1496 </tr>
1497 </thead>
1498 <tbody>
1499
1500 <tr>
1501
1502 <td class="type">
1503
1504 function
1505
1506
1507 </td>
1508 <td class="description last">Returns the bound function.</td>
1509 </tr>
1510
1511 </tbody>
1512 </table>
1513
1514
1515
1516
1517 </dd>
1518
1519
1520
1521 <dt>
1522 <div class="nameContainer">
1523 <h4 class="name" id="error">
1524
1525 error<span class="signature">(<span class="optional">type</span>, <span class="optional">fmt</span>, <span class="optional">args</span>)</span>
1526 </h4>
1527
1528
1529 <div class="tag-source">
1530 luci.js, line 1300
1531 </div>
1532
1533 </div>
1534
1535
1536 </dt>
1537 <dd>
1538
1539
1540 <div class="description">
1541 <p>A wrapper around <a href="LuCI.html#raise"><code>raise()</code></a> which also renders
1542 the error either as modal overlay when <code>ui.js</code> is already loaed
1543 or directly into the view body.</p>
1544 </div>
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554 <table class="params">
1555 <thead>
1556 <tr>
1557
1558 <th>Name</th>
1559
1560
1561 <th>Type</th>
1562
1563
1564 <th>Default</th>
1565
1566
1567 <th class="last">Description</th>
1568 </tr>
1569 </thead>
1570
1571 <tbody>
1572
1573
1574 <tr>
1575
1576 <td class="name"><code>type</code></td>
1577
1578
1579 <td class="type">
1580
1581
1582 <span class="param-type">Error</span>
1583 |
1584
1585 <span class="param-type">string</span>
1586
1587
1588
1589 </td>
1590
1591
1592 <td class="default">
1593
1594 Error
1595
1596 </td>
1597
1598
1599 <td class="description last">
1600
1601
1602 <span class="optional">optional</span>
1603
1604
1605
1606
1607
1608 <p>Either a string specifying the type of the error to throw or an
1609 existing <code>Error</code> instance to copy.</p></td>
1610 </tr>
1611
1612
1613
1614 <tr>
1615
1616 <td class="name"><code>fmt</code></td>
1617
1618
1619 <td class="type">
1620
1621
1622 <span class="param-type">string</span>
1623
1624
1625
1626 </td>
1627
1628
1629 <td class="default">
1630
1631 Unspecified error
1632
1633 </td>
1634
1635
1636 <td class="description last">
1637
1638
1639 <span class="optional">optional</span>
1640
1641
1642
1643
1644
1645 <p>A format string which is used to form the error message, together
1646 with all subsequent optional arguments.</p></td>
1647 </tr>
1648
1649
1650
1651 <tr>
1652
1653 <td class="name"><code>args</code></td>
1654
1655
1656 <td class="type">
1657
1658
1659 <span class="param-type">*</span>
1660
1661
1662
1663 </td>
1664
1665
1666 <td class="default">
1667
1668 </td>
1669
1670
1671 <td class="description last">
1672
1673
1674 <span class="optional">optional</span>
1675
1676
1677
1678
1679 <span class="repeatable">repeatable</span>
1680
1681
1682 <p>Zero or more variable arguments to the supplied format string.</p></td>
1683 </tr>
1684
1685
1686 </tbody>
1687 </table>
1688
1689
1690
1691 <dl class="details">
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713 </dl>
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723 <h5>Throws:</h5>
1724
1725
1726
1727 <dl>
1728 <dt>
1729 <div class="param-desc">
1730 <p>Throws the created error object with the captured stack trace
1731 appended to the message and the type set to the given type
1732 argument or copied from the given error instance.</p>
1733 </div>
1734 </dt>
1735 <dt>
1736 <dl>
1737 <dt>
1738 Type
1739 </dt>
1740 <dd>
1741
1742 <span class="param-type">Error</span>
1743
1744
1745 </dd>
1746 </dl>
1747 </dt>
1748 </dl>
1749
1750
1751
1752
1753
1754
1755
1756 </dd>
1757
1758
1759
1760 <dt>
1761 <div class="nameContainer">
1762 <h4 class="name" id="get">
1763
1764 get<span class="signature">(url, <span class="optional">args</span>, cb)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;null>}</span>
1765 </h4>
1766
1767
1768 <div class="tag-source">
1769 luci.js, line 1918
1770 </div>
1771
1772 </div>
1773
1774
1775 </dt>
1776 <dd>
1777
1778
1779 <div class="description">
1780 <p>Issues a GET request to the given url and invokes the specified
1781 callback function. The function is a wrapper around
1782 <a href="LuCI.Request.html#request"><code>Request.request()</code></a>.</p>
1783 </div>
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793 <table class="params">
1794 <thead>
1795 <tr>
1796
1797 <th>Name</th>
1798
1799
1800 <th>Type</th>
1801
1802
1803
1804 <th class="last">Description</th>
1805 </tr>
1806 </thead>
1807
1808 <tbody>
1809
1810
1811 <tr>
1812
1813 <td class="name"><code>url</code></td>
1814
1815
1816 <td class="type">
1817
1818
1819 <span class="param-type">string</span>
1820
1821
1822
1823 </td>
1824
1825
1826
1827 <td class="description last">
1828
1829
1830
1831
1832
1833
1834 <p>The URL to request.</p></td>
1835 </tr>
1836
1837
1838
1839 <tr>
1840
1841 <td class="name"><code>args</code></td>
1842
1843
1844 <td class="type">
1845
1846
1847 <span class="param-type">Object.&lt;string, string></span>
1848
1849
1850
1851 </td>
1852
1853
1854
1855 <td class="description last">
1856
1857
1858 <span class="optional">optional</span>
1859
1860
1861
1862
1863
1864 <p>Additional query string arguments to append to the URL.</p></td>
1865 </tr>
1866
1867
1868
1869 <tr>
1870
1871 <td class="name"><code>cb</code></td>
1872
1873
1874 <td class="type">
1875
1876
1877 <span class="param-type"><a href="LuCI.html#.requestCallbackFn">LuCI.requestCallbackFn</a></span>
1878
1879
1880
1881 </td>
1882
1883
1884
1885 <td class="description last">
1886
1887
1888
1889
1890
1891
1892 <p>The callback function to invoke when the request finishes.</p></td>
1893 </tr>
1894
1895
1896 </tbody>
1897 </table>
1898
1899
1900
1901 <dl class="details">
1902
1903
1904
1905
1906
1907
1908
1909 <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925 </dl>
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937 <h5>Returns:</h5>
1938
1939
1940
1941 <table class="params">
1942 <thead>
1943 <tr>
1944
1945 <th>Type</th>
1946 <th class="last">Description</th>
1947 </tr>
1948 </thead>
1949 <tbody>
1950
1951 <tr>
1952
1953 <td class="type">
1954
1955 Promise.&lt;null>
1956
1957
1958 </td>
1959 <td class="description last">Returns a promise resolving to <code>null</code> when concluded.</td>
1960 </tr>
1961
1962 </tbody>
1963 </table>
1964
1965
1966
1967
1968 </dd>
1969
1970
1971
1972 <dt>
1973 <div class="nameContainer">
1974 <h4 class="name" id="halt">
1975
1976 halt<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
1977 </h4>
1978
1979
1980 <div class="tag-source">
1981 luci.js, line 2040
1982 </div>
1983
1984 </div>
1985
1986
1987 </dt>
1988 <dd>
1989
1990
1991 <div class="description">
1992 <p>Deprecated wrapper around <code>Poll.stop()</code>.</p>
1993 </div>
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003 <dl class="details">
2004
2005
2006
2007
2008
2009
2010
2011 <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027 </dl>
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039 <h5>Returns:</h5>
2040
2041
2042
2043 <table class="params">
2044 <thead>
2045 <tr>
2046
2047 <th>Type</th>
2048 <th class="last">Description</th>
2049 </tr>
2050 </thead>
2051 <tbody>
2052
2053 <tr>
2054
2055 <td class="type">
2056
2057 boolean
2058
2059
2060 </td>
2061 <td class="description last">Returns <code>true</code> when the polling loop has been stopped or <code>false</code>
2062 when it didn't run to begin with.</td>
2063 </tr>
2064
2065 </tbody>
2066 </table>
2067
2068
2069
2070
2071 </dd>
2072
2073
2074
2075 <dt>
2076 <div class="nameContainer">
2077 <h4 class="name" id="hasSystemFeature">
2078
2079 hasSystemFeature<span class="signature">(feature, <span class="optional">subfeature</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean|null}</span>
2080 </h4>
2081
2082
2083 <div class="tag-source">
2084 luci.js, line 1574
2085 </div>
2086
2087 </div>
2088
2089
2090 </dt>
2091 <dd>
2092
2093
2094 <div class="description">
2095 <p>Test whether a particular system feature is available, such as
2096 hostapd SAE support or an installed firewall. The features are
2097 queried once at the beginning of the LuCI session and cached in
2098 <code>SessionStorage</code> throughout the lifetime of the associated tab or
2099 browser window.</p>
2100 </div>
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110 <table class="params">
2111 <thead>
2112 <tr>
2113
2114 <th>Name</th>
2115
2116
2117 <th>Type</th>
2118
2119
2120
2121 <th class="last">Description</th>
2122 </tr>
2123 </thead>
2124
2125 <tbody>
2126
2127
2128 <tr>
2129
2130 <td class="name"><code>feature</code></td>
2131
2132
2133 <td class="type">
2134
2135
2136 <span class="param-type">string</span>
2137
2138
2139
2140 </td>
2141
2142
2143
2144 <td class="description last">
2145
2146
2147
2148
2149
2150
2151 <p>The feature to test. For detailed list of known feature flags,
2152 see <code>/modules/luci-base/root/usr/libexec/rpcd/luci</code>.</p></td>
2153 </tr>
2154
2155
2156
2157 <tr>
2158
2159 <td class="name"><code>subfeature</code></td>
2160
2161
2162 <td class="type">
2163
2164
2165 <span class="param-type">string</span>
2166
2167
2168
2169 </td>
2170
2171
2172
2173 <td class="description last">
2174
2175
2176 <span class="optional">optional</span>
2177
2178
2179
2180
2181
2182 <p>Some feature classes like <code>hostapd</code> provide sub-feature flags,
2183 such as <code>sae</code> or <code>11w</code> support. The <code>subfeature</code> argument can
2184 be used to query these.</p></td>
2185 </tr>
2186
2187
2188 </tbody>
2189 </table>
2190
2191
2192
2193 <dl class="details">
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215 </dl>
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227 <h5>Returns:</h5>
2228
2229
2230
2231 <table class="params">
2232 <thead>
2233 <tr>
2234
2235 <th>Type</th>
2236 <th class="last">Description</th>
2237 </tr>
2238 </thead>
2239 <tbody>
2240
2241 <tr>
2242
2243 <td class="type">
2244
2245 boolean
2246 |
2247
2248 null
2249
2250
2251 </td>
2252 <td class="description last">Return <code>true</code> if the queried feature (and sub-feature) is available
2253 or <code>false</code> if the requested feature isn't present or known.
2254 Return <code>null</code> when a sub-feature was queried for a feature which
2255 has no sub-features.</td>
2256 </tr>
2257
2258 </tbody>
2259 </table>
2260
2261
2262
2263
2264 </dd>
2265
2266
2267
2268 <dt>
2269 <div class="nameContainer">
2270 <h4 class="name" id="isObject">
2271
2272 isObject<span class="signature">(<span class="optional">val</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
2273 </h4>
2274
2275
2276 <div class="tag-source">
2277 luci.js, line 1765
2278 </div>
2279
2280 </div>
2281
2282
2283 </dt>
2284 <dd>
2285
2286
2287 <div class="description">
2288 <p>Tests whether the passed argument is a JavaScript object.
2289 This function is meant to be an object counterpart to the
2290 standard <code>Array.isArray()</code> function.</p>
2291 </div>
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301 <table class="params">
2302 <thead>
2303 <tr>
2304
2305 <th>Name</th>
2306
2307
2308 <th>Type</th>
2309
2310
2311
2312 <th class="last">Description</th>
2313 </tr>
2314 </thead>
2315
2316 <tbody>
2317
2318
2319 <tr>
2320
2321 <td class="name"><code>val</code></td>
2322
2323
2324 <td class="type">
2325
2326
2327 <span class="param-type">*</span>
2328
2329
2330
2331 </td>
2332
2333
2334
2335 <td class="description last">
2336
2337
2338 <span class="optional">optional</span>
2339
2340
2341
2342
2343
2344 <p>The value to test</p></td>
2345 </tr>
2346
2347
2348 </tbody>
2349 </table>
2350
2351
2352
2353 <dl class="details">
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375 </dl>
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387 <h5>Returns:</h5>
2388
2389
2390
2391 <table class="params">
2392 <thead>
2393 <tr>
2394
2395 <th>Type</th>
2396 <th class="last">Description</th>
2397 </tr>
2398 </thead>
2399 <tbody>
2400
2401 <tr>
2402
2403 <td class="type">
2404
2405 boolean
2406
2407
2408 </td>
2409 <td class="description last">Returns <code>true</code> if the given value is of type object and
2410 not <code>null</code>, else returns <code>false</code>.</td>
2411 </tr>
2412
2413 </tbody>
2414 </table>
2415
2416
2417
2418
2419 </dd>
2420
2421
2422
2423 <dt>
2424 <div class="nameContainer">
2425 <h4 class="name" id="location">
2426
2427 location<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2428 </h4>
2429
2430
2431 <div class="tag-source">
2432 luci.js, line 1745
2433 </div>
2434
2435 </div>
2436
2437
2438 </dt>
2439 <dd>
2440
2441
2442 <div class="description">
2443 <p>Return the complete URL path to the current view.</p>
2444 </div>
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454 <dl class="details">
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476 </dl>
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488 <h5>Returns:</h5>
2489
2490
2491
2492 <table class="params">
2493 <thead>
2494 <tr>
2495
2496 <th>Type</th>
2497 <th class="last">Description</th>
2498 </tr>
2499 </thead>
2500 <tbody>
2501
2502 <tr>
2503
2504 <td class="type">
2505
2506 string
2507
2508
2509 </td>
2510 <td class="description last">Returns the URL path to the current view.</td>
2511 </tr>
2512
2513 </tbody>
2514 </table>
2515
2516
2517
2518
2519 </dd>
2520
2521
2522
2523 <dt>
2524 <div class="nameContainer">
2525 <h4 class="name" id="path">
2526
2527 path<span class="signature">(<span class="optional">prefix</span>, <span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2528 </h4>
2529
2530
2531 <div class="tag-source">
2532 luci.js, line 1679
2533 </div>
2534
2535 </div>
2536
2537
2538 </dt>
2539 <dd>
2540
2541
2542 <div class="description">
2543 <p>Construct a relative URL path from the given prefix and parts.
2544 The resulting URL is guaranteed to only contain the characters
2545 <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well
2546 as <code>/</code> for the path separator.</p>
2547 </div>
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557 <table class="params">
2558 <thead>
2559 <tr>
2560
2561 <th>Name</th>
2562
2563
2564 <th>Type</th>
2565
2566
2567
2568 <th class="last">Description</th>
2569 </tr>
2570 </thead>
2571
2572 <tbody>
2573
2574
2575 <tr>
2576
2577 <td class="name"><code>prefix</code></td>
2578
2579
2580 <td class="type">
2581
2582
2583 <span class="param-type">string</span>
2584
2585
2586
2587 </td>
2588
2589
2590
2591 <td class="description last">
2592
2593
2594 <span class="optional">optional</span>
2595
2596
2597
2598
2599
2600 <p>The prefix to join the given parts with. If the <code>prefix</code> is
2601 omitted, it defaults to an empty string.</p></td>
2602 </tr>
2603
2604
2605
2606 <tr>
2607
2608 <td class="name"><code>parts</code></td>
2609
2610
2611 <td class="type">
2612
2613
2614 <span class="param-type">Array.&lt;string></span>
2615
2616
2617
2618 </td>
2619
2620
2621
2622 <td class="description last">
2623
2624
2625 <span class="optional">optional</span>
2626
2627
2628
2629
2630
2631 <p>An array of parts to join into an URL path. Parts may contain
2632 slashes and any of the other characters mentioned above.</p></td>
2633 </tr>
2634
2635
2636 </tbody>
2637 </table>
2638
2639
2640
2641 <dl class="details">
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663 </dl>
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675 <h5>Returns:</h5>
2676
2677
2678
2679 <table class="params">
2680 <thead>
2681 <tr>
2682
2683 <th>Type</th>
2684 <th class="last">Description</th>
2685 </tr>
2686 </thead>
2687 <tbody>
2688
2689 <tr>
2690
2691 <td class="type">
2692
2693 string
2694
2695
2696 </td>
2697 <td class="description last">Return the joined URL path.</td>
2698 </tr>
2699
2700 </tbody>
2701 </table>
2702
2703
2704
2705
2706 </dd>
2707
2708
2709
2710 <dt>
2711 <div class="nameContainer">
2712 <h4 class="name" id="poll">
2713
2714 poll<span class="signature">(interval, url, <span class="optional">args</span>, cb, <span class="optional">post</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{function}</span>
2715 </h4>
2716
2717
2718 <div class="tag-source">
2719 luci.js, line 1988
2720 </div>
2721
2722 </div>
2723
2724
2725 </dt>
2726 <dd>
2727
2728
2729 <div class="description">
2730 <p>Register a polling HTTP request that invokes the specified
2731 callback function. The function is a wrapper around
2732 <a href="LuCI.Request.poll.html#add"><code>Request.poll.add()</code></a>.</p>
2733 </div>
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743 <table class="params">
2744 <thead>
2745 <tr>
2746
2747 <th>Name</th>
2748
2749
2750 <th>Type</th>
2751
2752
2753 <th>Default</th>
2754
2755
2756 <th class="last">Description</th>
2757 </tr>
2758 </thead>
2759
2760 <tbody>
2761
2762
2763 <tr>
2764
2765 <td class="name"><code>interval</code></td>
2766
2767
2768 <td class="type">
2769
2770
2771 <span class="param-type">number</span>
2772
2773
2774
2775 </td>
2776
2777
2778 <td class="default">
2779
2780 </td>
2781
2782
2783 <td class="description last">
2784
2785
2786
2787
2788
2789
2790 <p>The poll interval to use. If set to a value less than or equal
2791 to <code>0</code>, it will default to the global poll interval configured
2792 in <code>LuCI.env.pollinterval</code>.</p></td>
2793 </tr>
2794
2795
2796
2797 <tr>
2798
2799 <td class="name"><code>url</code></td>
2800
2801
2802 <td class="type">
2803
2804
2805 <span class="param-type">string</span>
2806
2807
2808
2809 </td>
2810
2811
2812 <td class="default">
2813
2814 </td>
2815
2816
2817 <td class="description last">
2818
2819
2820
2821
2822
2823
2824 <p>The URL to request.</p></td>
2825 </tr>
2826
2827
2828
2829 <tr>
2830
2831 <td class="name"><code>args</code></td>
2832
2833
2834 <td class="type">
2835
2836
2837 <span class="param-type">Object.&lt;string, string></span>
2838
2839
2840
2841 </td>
2842
2843
2844 <td class="default">
2845
2846 </td>
2847
2848
2849 <td class="description last">
2850
2851
2852 <span class="optional">optional</span>
2853
2854
2855
2856
2857
2858 <p>Specifies additional arguments for the request. For GET requests,
2859 the arguments are appended to the URL as query string, for POST
2860 requests, they'll be added to the request body.</p></td>
2861 </tr>
2862
2863
2864
2865 <tr>
2866
2867 <td class="name"><code>cb</code></td>
2868
2869
2870 <td class="type">
2871
2872
2873 <span class="param-type"><a href="LuCI.html#.requestCallbackFn">LuCI.requestCallbackFn</a></span>
2874
2875
2876
2877 </td>
2878
2879
2880 <td class="default">
2881
2882 </td>
2883
2884
2885 <td class="description last">
2886
2887
2888
2889
2890
2891
2892 <p>The callback function to invoke whenever a request finishes.</p></td>
2893 </tr>
2894
2895
2896
2897 <tr>
2898
2899 <td class="name"><code>post</code></td>
2900
2901
2902 <td class="type">
2903
2904
2905 <span class="param-type">boolean</span>
2906
2907
2908
2909 </td>
2910
2911
2912 <td class="default">
2913
2914 false
2915
2916 </td>
2917
2918
2919 <td class="description last">
2920
2921
2922 <span class="optional">optional</span>
2923
2924
2925
2926
2927
2928 <p>When set to <code>false</code> or not specified, poll requests will be made
2929 using the GET method. When set to <code>true</code>, POST requests will be
2930 issued. In case of POST requests, the request body will contain
2931 an argument <code>token</code> with the current value of <code>LuCI.env.token</code> by
2932 default, regardless of the parameters specified with <code>args</code>.</p></td>
2933 </tr>
2934
2935
2936 </tbody>
2937 </table>
2938
2939
2940
2941 <dl class="details">
2942
2943
2944
2945
2946
2947
2948
2949 <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965 </dl>
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977 <h5>Returns:</h5>
2978
2979
2980
2981 <table class="params">
2982 <thead>
2983 <tr>
2984
2985 <th>Type</th>
2986 <th class="last">Description</th>
2987 </tr>
2988 </thead>
2989 <tbody>
2990
2991 <tr>
2992
2993 <td class="type">
2994
2995 function
2996
2997
2998 </td>
2999 <td class="description last">Returns the internally created function that has been passed to
3000 <a href="LuCI.Request.poll.html#add"><code>Request.poll.add()</code></a>. This value can
3001 be passed to <code>Poll.remove()</code> to remove the
3002 polling request.</td>
3003 </tr>
3004
3005 </tbody>
3006 </table>
3007
3008
3009
3010
3011 </dd>
3012
3013
3014
3015 <dt>
3016 <div class="nameContainer">
3017 <h4 class="name" id="post">
3018
3019 post<span class="signature">(url, <span class="optional">args</span>, cb)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;null>}</span>
3020 </h4>
3021
3022
3023 <div class="tag-source">
3024 luci.js, line 1946
3025 </div>
3026
3027 </div>
3028
3029
3030 </dt>
3031 <dd>
3032
3033
3034 <div class="description">
3035 <p>Issues a POST request to the given url and invokes the specified
3036 callback function. The function is a wrapper around
3037 <a href="LuCI.Request.html#request"><code>Request.request()</code></a>. The request is
3038 sent using <code>application/x-www-form-urlencoded</code> encoding and will
3039 contain a field <code>token</code> with the current value of <code>LuCI.env.token</code>
3040 by default.</p>
3041 </div>
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051 <table class="params">
3052 <thead>
3053 <tr>
3054
3055 <th>Name</th>
3056
3057
3058 <th>Type</th>
3059
3060
3061
3062 <th class="last">Description</th>
3063 </tr>
3064 </thead>
3065
3066 <tbody>
3067
3068
3069 <tr>
3070
3071 <td class="name"><code>url</code></td>
3072
3073
3074 <td class="type">
3075
3076
3077 <span class="param-type">string</span>
3078
3079
3080
3081 </td>
3082
3083
3084
3085 <td class="description last">
3086
3087
3088
3089
3090
3091
3092 <p>The URL to request.</p></td>
3093 </tr>
3094
3095
3096
3097 <tr>
3098
3099 <td class="name"><code>args</code></td>
3100
3101
3102 <td class="type">
3103
3104
3105 <span class="param-type">Object.&lt;string, string></span>
3106
3107
3108
3109 </td>
3110
3111
3112
3113 <td class="description last">
3114
3115
3116 <span class="optional">optional</span>
3117
3118
3119
3120
3121
3122 <p>Additional post arguments to append to the request body.</p></td>
3123 </tr>
3124
3125
3126
3127 <tr>
3128
3129 <td class="name"><code>cb</code></td>
3130
3131
3132 <td class="type">
3133
3134
3135 <span class="param-type"><a href="LuCI.html#.requestCallbackFn">LuCI.requestCallbackFn</a></span>
3136
3137
3138
3139 </td>
3140
3141
3142
3143 <td class="description last">
3144
3145
3146
3147
3148
3149
3150 <p>The callback function to invoke when the request finishes.</p></td>
3151 </tr>
3152
3153
3154 </tbody>
3155 </table>
3156
3157
3158
3159 <dl class="details">
3160
3161
3162
3163
3164
3165
3166
3167 <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183 </dl>
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195 <h5>Returns:</h5>
3196
3197
3198
3199 <table class="params">
3200 <thead>
3201 <tr>
3202
3203 <th>Type</th>
3204 <th class="last">Description</th>
3205 </tr>
3206 </thead>
3207 <tbody>
3208
3209 <tr>
3210
3211 <td class="type">
3212
3213 Promise.&lt;null>
3214
3215
3216 </td>
3217 <td class="description last">Returns a promise resolving to <code>null</code> when concluded.</td>
3218 </tr>
3219
3220 </tbody>
3221 </table>
3222
3223
3224
3225
3226 </dd>
3227
3228
3229
3230 <dt>
3231 <div class="nameContainer">
3232 <h4 class="name" id="raise">
3233
3234 raise<span class="signature">(<span class="optional">type</span>, <span class="optional">fmt</span>, <span class="optional">args</span>)</span>
3235 </h4>
3236
3237
3238 <div class="tag-source">
3239 luci.js, line 1234
3240 </div>
3241
3242 </div>
3243
3244
3245 </dt>
3246 <dd>
3247
3248
3249 <div class="description">
3250 <p>Captures the current stack trace and throws an error of the
3251 specified type as a new exception. Also logs the exception as
3252 error to the debug console if it is available.</p>
3253 </div>
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263 <table class="params">
3264 <thead>
3265 <tr>
3266
3267 <th>Name</th>
3268
3269
3270 <th>Type</th>
3271
3272
3273 <th>Default</th>
3274
3275
3276 <th class="last">Description</th>
3277 </tr>
3278 </thead>
3279
3280 <tbody>
3281
3282
3283 <tr>
3284
3285 <td class="name"><code>type</code></td>
3286
3287
3288 <td class="type">
3289
3290
3291 <span class="param-type">Error</span>
3292 |
3293
3294 <span class="param-type">string</span>
3295
3296
3297
3298 </td>
3299
3300
3301 <td class="default">
3302
3303 Error
3304
3305 </td>
3306
3307
3308 <td class="description last">
3309
3310
3311 <span class="optional">optional</span>
3312
3313
3314
3315
3316
3317 <p>Either a string specifying the type of the error to throw or an
3318 existing <code>Error</code> instance to copy.</p></td>
3319 </tr>
3320
3321
3322
3323 <tr>
3324
3325 <td class="name"><code>fmt</code></td>
3326
3327
3328 <td class="type">
3329
3330
3331 <span class="param-type">string</span>
3332
3333
3334
3335 </td>
3336
3337
3338 <td class="default">
3339
3340 Unspecified error
3341
3342 </td>
3343
3344
3345 <td class="description last">
3346
3347
3348 <span class="optional">optional</span>
3349
3350
3351
3352
3353
3354 <p>A format string which is used to form the error message, together
3355 with all subsequent optional arguments.</p></td>
3356 </tr>
3357
3358
3359
3360 <tr>
3361
3362 <td class="name"><code>args</code></td>
3363
3364
3365 <td class="type">
3366
3367
3368 <span class="param-type">*</span>
3369
3370
3371
3372 </td>
3373
3374
3375 <td class="default">
3376
3377 </td>
3378
3379
3380 <td class="description last">
3381
3382
3383 <span class="optional">optional</span>
3384
3385
3386
3387
3388 <span class="repeatable">repeatable</span>
3389
3390
3391 <p>Zero or more variable arguments to the supplied format string.</p></td>
3392 </tr>
3393
3394
3395 </tbody>
3396 </table>
3397
3398
3399
3400 <dl class="details">
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422 </dl>
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432 <h5>Throws:</h5>
3433
3434
3435
3436 <dl>
3437 <dt>
3438 <div class="param-desc">
3439 <p>Throws the created error object with the captured stack trace
3440 appended to the message and the type set to the given type
3441 argument or copied from the given error instance.</p>
3442 </div>
3443 </dt>
3444 <dt>
3445 <dl>
3446 <dt>
3447 Type
3448 </dt>
3449 <dd>
3450
3451 <span class="param-type">Error</span>
3452
3453
3454 </dd>
3455 </dl>
3456 </dt>
3457 </dl>
3458
3459
3460
3461
3462
3463
3464
3465 </dd>
3466
3467
3468
3469 <dt>
3470 <div class="nameContainer">
3471 <h4 class="name" id="require">
3472
3473 require<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;LuCI#Class>}</span>
3474 </h4>
3475
3476
3477 <div class="tag-source">
3478 luci.js, line 1379
3479 </div>
3480
3481 </div>
3482
3483
3484 </dt>
3485 <dd>
3486
3487
3488 <div class="description">
3489 <p>Load an additional LuCI JavaScript class and its dependencies,
3490 instantiate it and return the resulting class instance. Each
3491 class is only loaded once. Subsequent attempts to load the same
3492 class will return the already instantiated class.</p>
3493 </div>
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503 <table class="params">
3504 <thead>
3505 <tr>
3506
3507 <th>Name</th>
3508
3509
3510 <th>Type</th>
3511
3512
3513
3514 <th class="last">Description</th>
3515 </tr>
3516 </thead>
3517
3518 <tbody>
3519
3520
3521 <tr>
3522
3523 <td class="name"><code>name</code></td>
3524
3525
3526 <td class="type">
3527
3528
3529 <span class="param-type">string</span>
3530
3531
3532
3533 </td>
3534
3535
3536
3537 <td class="description last">
3538
3539 <p>The name of the class to load in dotted notation. Dots will
3540 be replaced by spaces and joined with the runtime-determined
3541 base URL of LuCI.js to form an absolute URL to load the class
3542 file from.</p></td>
3543 </tr>
3544
3545
3546 </tbody>
3547 </table>
3548
3549
3550
3551 <dl class="details">
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573 </dl>
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583 <h5>Throws:</h5>
3584 <ul>
3585 <li>
3586
3587 <dl>
3588 <dt>
3589 <div class="param-desc">
3590 <p>Throws a <code>DependencyError</code> when the class to load includes
3591 circular dependencies.</p>
3592 </div>
3593 </dt>
3594 <dt>
3595 <dl>
3596 <dt>
3597 Type
3598 </dt>
3599 <dd>
3600
3601 <span class="param-type">DependencyError</span>
3602
3603
3604 </dd>
3605 </dl>
3606 </dt>
3607 </dl>
3608
3609 </li>
3610
3611 <li>
3612
3613 <dl>
3614 <dt>
3615 <div class="param-desc">
3616 <p>Throws <code>NetworkError</code> when the underlying <a href="LuCI.Request.html"><code>LuCI.Request</code></a>
3617 call failed.</p>
3618 </div>
3619 </dt>
3620 <dt>
3621 <dl>
3622 <dt>
3623 Type
3624 </dt>
3625 <dd>
3626
3627 <span class="param-type">NetworkError</span>
3628
3629
3630 </dd>
3631 </dl>
3632 </dt>
3633 </dl>
3634
3635 </li>
3636
3637 <li>
3638
3639 <dl>
3640 <dt>
3641 <div class="param-desc">
3642 <p>Throws <code>SyntaxError</code> when the loaded class file code cannot
3643 be interpreted by <code>eval</code>.</p>
3644 </div>
3645 </dt>
3646 <dt>
3647 <dl>
3648 <dt>
3649 Type
3650 </dt>
3651 <dd>
3652
3653 <span class="param-type">SyntaxError</span>
3654
3655
3656 </dd>
3657 </dl>
3658 </dt>
3659 </dl>
3660
3661 </li>
3662
3663 <li>
3664
3665 <dl>
3666 <dt>
3667 <div class="param-desc">
3668 <p>Throws <code>TypeError</code> when the class file could be loaded and
3669 interpreted, but when invoking its code did not yield a valid
3670 class instance.</p>
3671 </div>
3672 </dt>
3673 <dt>
3674 <dl>
3675 <dt>
3676 Type
3677 </dt>
3678 <dd>
3679
3680 <span class="param-type">TypeError</span>
3681
3682
3683 </dd>
3684 </dl>
3685 </dt>
3686 </dl>
3687
3688 </li>
3689 </ul>
3690
3691
3692 <h5>Returns:</h5>
3693
3694
3695
3696 <table class="params">
3697 <thead>
3698 <tr>
3699
3700 <th>Type</th>
3701 <th class="last">Description</th>
3702 </tr>
3703 </thead>
3704 <tbody>
3705
3706 <tr>
3707
3708 <td class="type">
3709
3710 Promise.&lt;LuCI#Class>
3711
3712
3713 </td>
3714 <td class="description last">Returns the instantiated class.</td>
3715 </tr>
3716
3717 </tbody>
3718 </table>
3719
3720
3721
3722
3723 </dd>
3724
3725
3726
3727 <dt>
3728 <div class="nameContainer">
3729 <h4 class="name" id="resolveDefault">
3730
3731 resolveDefault<span class="signature">(value, defvalue)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;*>}</span>
3732 </h4>
3733
3734
3735 <div class="tag-source">
3736 luci.js, line 1873
3737 </div>
3738
3739 </div>
3740
3741
3742 </dt>
3743 <dd>
3744
3745
3746 <div class="description">
3747 <p>Returns a promise resolving with either the given value or or with
3748 the given default in case the input value is a rejecting promise.</p>
3749 </div>
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759 <table class="params">
3760 <thead>
3761 <tr>
3762
3763 <th>Name</th>
3764
3765
3766 <th>Type</th>
3767
3768
3769
3770 <th class="last">Description</th>
3771 </tr>
3772 </thead>
3773
3774 <tbody>
3775
3776
3777 <tr>
3778
3779 <td class="name"><code>value</code></td>
3780
3781
3782 <td class="type">
3783
3784
3785 <span class="param-type">*</span>
3786
3787
3788
3789 </td>
3790
3791
3792
3793 <td class="description last">
3794
3795 <p>The value to resolve the promise with.</p></td>
3796 </tr>
3797
3798
3799
3800 <tr>
3801
3802 <td class="name"><code>defvalue</code></td>
3803
3804
3805 <td class="type">
3806
3807
3808 <span class="param-type">*</span>
3809
3810
3811
3812 </td>
3813
3814
3815
3816 <td class="description last">
3817
3818 <p>The default value to resolve the promise with in case the given
3819 input value is a rejecting promise.</p></td>
3820 </tr>
3821
3822
3823 </tbody>
3824 </table>
3825
3826
3827
3828 <dl class="details">
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850 </dl>
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862 <h5>Returns:</h5>
3863
3864
3865
3866 <table class="params">
3867 <thead>
3868 <tr>
3869
3870 <th>Type</th>
3871 <th class="last">Description</th>
3872 </tr>
3873 </thead>
3874 <tbody>
3875
3876 <tr>
3877
3878 <td class="type">
3879
3880 Promise.&lt;*>
3881
3882
3883 </td>
3884 <td class="description last">Returns a new promise resolving either to the given input value or
3885 to the given default value on error.</td>
3886 </tr>
3887
3888 </tbody>
3889 </table>
3890
3891
3892
3893
3894 </dd>
3895
3896
3897
3898 <dt>
3899 <div class="nameContainer">
3900 <h4 class="name" id="resource">
3901
3902 resource<span class="signature">(<span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
3903 </h4>
3904
3905
3906 <div class="tag-source">
3907 luci.js, line 1732
3908 </div>
3909
3910 </div>
3911
3912
3913 </dt>
3914 <dd>
3915
3916
3917 <div class="description">
3918 <p>Construct an URL path relative to the global static resource path
3919 of the LuCI ui (usually <code>/luci-static/resources</code>).</p>
3920 <p>The resulting URL is guaranteed to only contain the characters
3921 <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well
3922 as <code>/</code> for the path separator.</p>
3923 </div>
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933 <table class="params">
3934 <thead>
3935 <tr>
3936
3937 <th>Name</th>
3938
3939
3940 <th>Type</th>
3941
3942
3943
3944 <th class="last">Description</th>
3945 </tr>
3946 </thead>
3947
3948 <tbody>
3949
3950
3951 <tr>
3952
3953 <td class="name"><code>parts</code></td>
3954
3955
3956 <td class="type">
3957
3958
3959 <span class="param-type">Array.&lt;string></span>
3960
3961
3962
3963 </td>
3964
3965
3966
3967 <td class="description last">
3968
3969
3970 <span class="optional">optional</span>
3971
3972
3973
3974
3975
3976 <p>An array of parts to join into an URL path. Parts may contain
3977 slashes and any of the other characters mentioned above.</p></td>
3978 </tr>
3979
3980
3981 </tbody>
3982 </table>
3983
3984
3985
3986 <dl class="details">
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008 </dl>
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020 <h5>Returns:</h5>
4021
4022
4023
4024 <table class="params">
4025 <thead>
4026 <tr>
4027
4028 <th>Type</th>
4029 <th class="last">Description</th>
4030 </tr>
4031 </thead>
4032 <tbody>
4033
4034 <tr>
4035
4036 <td class="type">
4037
4038 string
4039
4040
4041 </td>
4042 <td class="description last">Returns the resulting URL path.</td>
4043 </tr>
4044
4045 </tbody>
4046 </table>
4047
4048
4049
4050
4051 </dd>
4052
4053
4054
4055 <dt>
4056 <div class="nameContainer">
4057 <h4 class="name" id="run">
4058
4059 run<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4060 </h4>
4061
4062
4063 <div class="tag-source">
4064 luci.js, line 2053
4065 </div>
4066
4067 </div>
4068
4069
4070 </dt>
4071 <dd>
4072
4073
4074 <div class="description">
4075 <p>Deprecated wrapper around <code>Poll.start()</code>.</p>
4076 </div>
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086 <dl class="details">
4087
4088
4089
4090
4091
4092
4093
4094 <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110 </dl>
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122 <h5>Returns:</h5>
4123
4124
4125
4126 <table class="params">
4127 <thead>
4128 <tr>
4129
4130 <th>Type</th>
4131 <th class="last">Description</th>
4132 </tr>
4133 </thead>
4134 <tbody>
4135
4136 <tr>
4137
4138 <td class="type">
4139
4140 boolean
4141
4142
4143 </td>
4144 <td class="description last">Returns <code>true</code> when the polling loop has been started or <code>false</code>
4145 when it was already running.</td>
4146 </tr>
4147
4148 </tbody>
4149 </table>
4150
4151
4152
4153
4154 </dd>
4155
4156
4157
4158 <dt>
4159 <div class="nameContainer">
4160 <h4 class="name" id="sortedKeys">
4161
4162 sortedKeys<span class="signature">(obj, <span class="optional">key</span>, <span class="optional">sortmode</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
4163 </h4>
4164
4165
4166 <div class="tag-source">
4167 luci.js, line 1794
4168 </div>
4169
4170 </div>
4171
4172
4173 </dt>
4174 <dd>
4175
4176
4177 <div class="description">
4178 <p>Return an array of sorted object keys, optionally sorted by
4179 a different key or a different sorting mode.</p>
4180 </div>
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190 <table class="params">
4191 <thead>
4192 <tr>
4193
4194 <th>Name</th>
4195
4196
4197 <th>Type</th>
4198
4199
4200
4201 <th class="last">Description</th>
4202 </tr>
4203 </thead>
4204
4205 <tbody>
4206
4207
4208 <tr>
4209
4210 <td class="name"><code>obj</code></td>
4211
4212
4213 <td class="type">
4214
4215
4216 <span class="param-type">object</span>
4217
4218
4219
4220 </td>
4221
4222
4223
4224 <td class="description last">
4225
4226
4227
4228
4229
4230
4231 <p>The object to extract the keys from. If the given value is
4232 not an object, the function will return an empty array.</p></td>
4233 </tr>
4234
4235
4236
4237 <tr>
4238
4239 <td class="name"><code>key</code></td>
4240
4241
4242 <td class="type">
4243
4244
4245 <span class="param-type">string</span>
4246
4247
4248
4249 </td>
4250
4251
4252
4253 <td class="description last">
4254
4255
4256 <span class="optional">optional</span>
4257
4258
4259
4260
4261
4262 <p>Specifies the key to order by. This is mainly useful for
4263 nested objects of objects or objects of arrays when sorting
4264 shall not be performed by the primary object keys but by
4265 some other key pointing to a value within the nested values.</p></td>
4266 </tr>
4267
4268
4269
4270 <tr>
4271
4272 <td class="name"><code>sortmode</code></td>
4273
4274
4275 <td class="type">
4276
4277
4278 <span class="param-type">string</span>
4279
4280
4281
4282 </td>
4283
4284
4285
4286 <td class="description last">
4287
4288
4289 <span class="optional">optional</span>
4290
4291
4292
4293
4294
4295 <p>May be either <code>addr</code> or <code>num</code> to override the natural
4296 lexicographic sorting with a sorting suitable for IP/MAC style
4297 addresses or numeric values respectively.</p></td>
4298 </tr>
4299
4300
4301 </tbody>
4302 </table>
4303
4304
4305
4306 <dl class="details">
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328 </dl>
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340 <h5>Returns:</h5>
4341
4342
4343
4344 <table class="params">
4345 <thead>
4346 <tr>
4347
4348 <th>Type</th>
4349 <th class="last">Description</th>
4350 </tr>
4351 </thead>
4352 <tbody>
4353
4354 <tr>
4355
4356 <td class="type">
4357
4358 Array.&lt;string>
4359
4360
4361 </td>
4362 <td class="description last">Returns an array containing the sorted keys of the given object.</td>
4363 </tr>
4364
4365 </tbody>
4366 </table>
4367
4368
4369
4370
4371 </dd>
4372
4373
4374
4375 <dt>
4376 <div class="nameContainer">
4377 <h4 class="name" id="stop">
4378
4379 stop<span class="signature">(entry)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4380 </h4>
4381
4382
4383 <div class="tag-source">
4384 luci.js, line 2027
4385 </div>
4386
4387 </div>
4388
4389
4390 </dt>
4391 <dd>
4392
4393
4394 <div class="description">
4395 <p>Deprecated wrapper around <code>Poll.remove()</code>.</p>
4396 </div>
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406 <table class="params">
4407 <thead>
4408 <tr>
4409
4410 <th>Name</th>
4411
4412
4413 <th>Type</th>
4414
4415
4416
4417 <th class="last">Description</th>
4418 </tr>
4419 </thead>
4420
4421 <tbody>
4422
4423
4424 <tr>
4425
4426 <td class="name"><code>entry</code></td>
4427
4428
4429 <td class="type">
4430
4431
4432 <span class="param-type">function</span>
4433
4434
4435
4436 </td>
4437
4438
4439
4440 <td class="description last">
4441
4442 <p>The polling function to remove.</p></td>
4443 </tr>
4444
4445
4446 </tbody>
4447 </table>
4448
4449
4450
4451 <dl class="details">
4452
4453
4454
4455
4456
4457
4458
4459 <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475 </dl>
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487 <h5>Returns:</h5>
4488
4489
4490
4491 <table class="params">
4492 <thead>
4493 <tr>
4494
4495 <th>Type</th>
4496 <th class="last">Description</th>
4497 </tr>
4498 </thead>
4499 <tbody>
4500
4501 <tr>
4502
4503 <td class="type">
4504
4505 boolean
4506
4507
4508 </td>
4509 <td class="description last">Returns <code>true</code> when the function has been removed or <code>false</code> if
4510 it could not be found.</td>
4511 </tr>
4512
4513 </tbody>
4514 </table>
4515
4516
4517
4518
4519 </dd>
4520
4521
4522
4523 <dt>
4524 <div class="nameContainer">
4525 <h4 class="name" id="toArray">
4526
4527 toArray<span class="signature">(val)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;*>}</span>
4528 </h4>
4529
4530
4531 <div class="tag-source">
4532 luci.js, line 1839
4533 </div>
4534
4535 </div>
4536
4537
4538 </dt>
4539 <dd>
4540
4541
4542 <div class="description">
4543 <p>Converts the given value to an array. If the given value is of
4544 type array, it is returned as-is, values of type object are
4545 returned as one-element array containing the object, empty
4546 strings and <code>null</code> values are returned as empty array, all other
4547 values are converted using <code>String()</code>, trimmed, split on white
4548 space and returned as array.</p>
4549 </div>
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559 <table class="params">
4560 <thead>
4561 <tr>
4562
4563 <th>Name</th>
4564
4565
4566 <th>Type</th>
4567
4568
4569
4570 <th class="last">Description</th>
4571 </tr>
4572 </thead>
4573
4574 <tbody>
4575
4576
4577 <tr>
4578
4579 <td class="name"><code>val</code></td>
4580
4581
4582 <td class="type">
4583
4584
4585 <span class="param-type">*</span>
4586
4587
4588
4589 </td>
4590
4591
4592
4593 <td class="description last">
4594
4595 <p>The value to convert into an array.</p></td>
4596 </tr>
4597
4598
4599 </tbody>
4600 </table>
4601
4602
4603
4604 <dl class="details">
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626 </dl>
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638 <h5>Returns:</h5>
4639
4640
4641
4642 <table class="params">
4643 <thead>
4644 <tr>
4645
4646 <th>Type</th>
4647 <th class="last">Description</th>
4648 </tr>
4649 </thead>
4650 <tbody>
4651
4652 <tr>
4653
4654 <td class="type">
4655
4656 Array.&lt;*>
4657
4658
4659 </td>
4660 <td class="description last">Returns the resulting array.</td>
4661 </tr>
4662
4663 </tbody>
4664 </table>
4665
4666
4667
4668
4669 </dd>
4670
4671
4672
4673 <dt>
4674 <div class="nameContainer">
4675 <h4 class="name" id="url">
4676
4677 url<span class="signature">(<span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
4678 </h4>
4679
4680
4681 <div class="tag-source">
4682 luci.js, line 1710
4683 </div>
4684
4685 </div>
4686
4687
4688 </dt>
4689 <dd>
4690
4691
4692 <div class="description">
4693 <p>Construct an URL pathrelative to the script path of the server
4694 side LuCI application (usually <code>/cgi-bin/luci</code>).</p>
4695 <p>The resulting URL is guaranteed to only contain the characters
4696 <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well
4697 as <code>/</code> for the path separator.</p>
4698 </div>
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708 <table class="params">
4709 <thead>
4710 <tr>
4711
4712 <th>Name</th>
4713
4714
4715 <th>Type</th>
4716
4717
4718
4719 <th class="last">Description</th>
4720 </tr>
4721 </thead>
4722
4723 <tbody>
4724
4725
4726 <tr>
4727
4728 <td class="name"><code>parts</code></td>
4729
4730
4731 <td class="type">
4732
4733
4734 <span class="param-type">Array.&lt;string></span>
4735
4736
4737
4738 </td>
4739
4740
4741
4742 <td class="description last">
4743
4744
4745 <span class="optional">optional</span>
4746
4747
4748
4749
4750
4751 <p>An array of parts to join into an URL path. Parts may contain
4752 slashes and any of the other characters mentioned above.</p></td>
4753 </tr>
4754
4755
4756 </tbody>
4757 </table>
4758
4759
4760
4761 <dl class="details">
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783 </dl>
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795 <h5>Returns:</h5>
4796
4797
4798
4799 <table class="params">
4800 <thead>
4801 <tr>
4802
4803 <th>Type</th>
4804 <th class="last">Description</th>
4805 </tr>
4806 </thead>
4807 <tbody>
4808
4809 <tr>
4810
4811 <td class="type">
4812
4813 string
4814
4815
4816 </td>
4817 <td class="description last">Returns the resulting URL path.</td>
4818 </tr>
4819
4820 </tbody>
4821 </table>
4822
4823
4824
4825
4826 </dd>
4827
4828 </dl>
4829
4830
4831
4832 <h3 class="subsection-title">Type Definitions</h3>
4833
4834 <dl>
4835
4836 <dt>
4837 <div class="nameContainer">
4838 <h4 class="name" id=".requestCallbackFn">
4839
4840 LuCI.requestCallbackFn<span class="signature">(xhr, data, duration)</span>
4841 </h4>
4842
4843
4844 <div class="tag-source">
4845 luci.js, line 1877
4846 </div>
4847
4848 </div>
4849
4850
4851 </dt>
4852 <dd>
4853
4854
4855 <div class="description">
4856 <p>The request callback function is invoked whenever an HTTP
4857 reply to a request made using the <code>L.get()</code>, <code>L.post()</code> or
4858 <code>L.poll()</code> function is timed out or received successfully.</p>
4859 </div>
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869 <table class="params">
4870 <thead>
4871 <tr>
4872
4873 <th>Name</th>
4874
4875
4876 <th>Type</th>
4877
4878
4879
4880 <th class="last">Description</th>
4881 </tr>
4882 </thead>
4883
4884 <tbody>
4885
4886
4887 <tr>
4888
4889 <td class="name"><code>xhr</code></td>
4890
4891
4892 <td class="type">
4893
4894
4895 <span class="param-type">XMLHTTPRequest</span>
4896
4897
4898
4899 </td>
4900
4901
4902
4903 <td class="description last">
4904
4905 <p>The XMLHTTPRequest instance used to make the request.</p></td>
4906 </tr>
4907
4908
4909
4910 <tr>
4911
4912 <td class="name"><code>data</code></td>
4913
4914
4915 <td class="type">
4916
4917
4918 <span class="param-type">*</span>
4919
4920
4921
4922 </td>
4923
4924
4925
4926 <td class="description last">
4927
4928 <p>The response JSON if the response could be parsed as such,
4929 else <code>null</code>.</p></td>
4930 </tr>
4931
4932
4933
4934 <tr>
4935
4936 <td class="name"><code>duration</code></td>
4937
4938
4939 <td class="type">
4940
4941
4942 <span class="param-type">number</span>
4943
4944
4945
4946 </td>
4947
4948
4949
4950 <td class="description last">
4951
4952 <p>The total duration of the request in milliseconds.</p></td>
4953 </tr>
4954
4955
4956 </tbody>
4957 </table>
4958
4959
4960
4961 <dl class="details">
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983 </dl>
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997 </dd>
4998
4999 </dl>
5000
5001
5002
5003
5004
5005 </article>
5006
5007 </section>
5008
5009
5010
5011
5012
5013
5014
5015 <footer>
5016 Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time)
5017 </footer>
5018 </div>
5019 </div>
5020 <script>prettyPrint();</script>
5021 <script src="scripts/jaguar.js"></script>
5022 </body>
5023 </html>