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