docs/jsapi/LuCI.uci.html

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