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