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