<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Class: uci</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <script src="scripts/jquery.min.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css"> <link type="text/css" rel="stylesheet" href="styles/jaguar.css"> <script> var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}}; </script> </head> <body> <div id="wrap" class="clearfix"> <div class="navigation"> <h3 class="applicationName"><a href="index.html"></a></h3> <div class="search"> <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations"> </div> <ul class="list"> <li class="item" data-name="LuCI"> <span class="title"> <a href="LuCI.html">LuCI</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li> <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li> <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li> <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li> <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li> <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li> <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li> <li data-name="LuCI#media"><a href="LuCI.html#media">media</a></li> <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li> <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li> <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li> <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li> <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li> <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li> <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li> <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li> <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li> <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li> <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li> <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Class"> <span class="title"> <a href="LuCI.Class.html">LuCI.Class</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li> <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li> <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li> <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li> <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li> <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.dom"> <span class="title"> <a href="LuCI.dom.html">LuCI.dom</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li> <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li> <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li> <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li> <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li> <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li> <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li> <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li> <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li> <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li> <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li> <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li> <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.fs"> <span class="title"> <a href="LuCI.fs.html">LuCI.fs</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li> <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li> <li data-name="LuCI.fs#exec_direct"><a href="LuCI.fs.html#exec_direct">exec_direct</a></li> <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li> <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li> <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li> <li data-name="LuCI.fs#read_direct"><a href="LuCI.fs.html#read_direct">read_direct</a></li> <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li> <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li> <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li> <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Headers"> <span class="title"> <a href="LuCI.Headers.html">LuCI.Headers</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li> <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Network"> <span class="title"> <a href="LuCI.Network.html">LuCI.Network</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li> <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li> <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li> <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li> <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li> <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li> <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li> <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li> <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li> <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li> <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li> <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li> <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li> <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li> <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li> <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li> <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li> <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li> <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li> <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li> <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li> <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li> <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li> <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li> <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li> <li data-name="LuCI.Network#getWifiNetworks"><a href="LuCI.Network.html#getWifiNetworks">getWifiNetworks</a></li> <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li> <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li> <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li> <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li> <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li> <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li> <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Network.Device"> <span class="title"> <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li> <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li> <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li> <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li> <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li> <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li> <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li> <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li> <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li> <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li> <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li> <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li> <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li> <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li> <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li> <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li> <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li> <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li> <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li> <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li> <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li> <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Network.Hosts"> <span class="title"> <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li> <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li> <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li> <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li> <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li> <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li> <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li> <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Network.Protocol"> <span class="title"> <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li> <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li> <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li> <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li> <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li> <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li> <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li> <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li> <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li> <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li> <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li> <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li> <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li> <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li> <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li> <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li> <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li> <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li> <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li> <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li> <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li> <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li> <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li> <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li> <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li> <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li> <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li> <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li> <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li> <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li> <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li> <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li> <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li> <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li> <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li> <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li> <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li> <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Network.WifiDevice"> <span class="title"> <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li> <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li> <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li> <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li> <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li> <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li> <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li> <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li> <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li> <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li> <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li> <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li> <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Network.WifiNetwork"> <span class="title"> <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Network.WifiNetwork#disconnectClient"><a href="LuCI.Network.WifiNetwork.html#disconnectClient">disconnectClient</a></li> <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li> <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li> <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li> <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li> <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li> <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li> <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li> <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li> <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li> <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li> <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li> <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li> <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li> <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li> <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li> <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li> <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li> <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li> <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li> <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li> <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li> <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li> <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li> <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li> <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li> <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li> <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li> <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li> <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li> <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li> <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li> <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li> <li data-name="LuCI.Network.WifiNetwork#isClientDisconnectSupported"><a href="LuCI.Network.WifiNetwork.html#isClientDisconnectSupported">isClientDisconnectSupported</a></li> <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li> <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li> <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Poll"> <span class="title"> <a href="LuCI.Poll.html">LuCI.Poll</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li> <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li> <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li> <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li> <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Request"> <span class="title"> <a href="LuCI.Request.html">LuCI.Request</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li> <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li> <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li> <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li> <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li> <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li> <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Request.poll"> <span class="title"> <a href="LuCI.Request.poll.html">LuCI.Request.poll</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li> <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li> <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li> <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li> <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.Response"> <span class="title"> <a href="LuCI.Response.html">LuCI.Response</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li> <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li> <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li> <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li> <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li> <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.Response#blob"><a href="LuCI.Response.html#blob">blob</a></li> <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li> <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li> <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.rpc"> <span class="title"> <a href="LuCI.rpc.html">LuCI.rpc</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li> <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li> <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li> <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li> <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li> <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li> <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li> <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li> <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li> <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li> <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li> <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.uci"> <span class="title"> <a href="LuCI.uci.html">LuCI.uci</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li> <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li> <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li> <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li> <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li> <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li> <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li> <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li> <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li> <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li> <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li> <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li> <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li> <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li> <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li> <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li> <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li> <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li> <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.view"> <span class="title"> <a href="LuCI.view.html">LuCI.view</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li> <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li> <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li> <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li> <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li> <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LuCI.XHR"> <span class="title"> <a href="LuCI.XHR.html">LuCI.XHR</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li> <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li> <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li> <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li> <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li> <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li> </ul> <ul class="events itemMembers"> </ul> </li> </ul> </div> <div class="main"> <h1 class="page-title" data-filename="LuCI.uci.html">Class: uci</h1> <section> <header> <h2> <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> uci </h2> <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 remote UCI <code>ubus</code> procedures and implements a local caching and data manipulation layer on top to allow for synchroneous operations on UCI configuration data.</p></div> </header> <article> <div class="container-overview"> <dt> <div class="nameContainer"> <h4 class="name" id="uci"> new LuCI.uci<span class="signature">()</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line4">line 4</a> </div> </div> </dt> <dd> <dl class="details"> </dl> </dd> </div> <h3 class="subsection-title">Methods</h3> <dl> <dt> <div class="nameContainer"> <h4 class="name" id="add"> 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> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line269">line 269</a> </div> </div> </dt> <dd> <div class="description"> <p>Adds a new section of the given type to the given configuration, optionally named according to the given name.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to add the section to.</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The type of the section to add.</p></td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <span class="optional">optional</span> <p>The name of the section to add. If the name is omitted, an anonymous section will be added instead.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> string </td> <td class="description last">Returns the section ID of the newly added section which is equivalent to the given name for non-anonymous sections.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="apply"> apply<span class="signature">(<span class="optional">timeout</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<number>}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line858">line 858</a> </div> </div> </dt> <dd> <div class="description"> <p>Instructs the remote <code>ubus</code> UCI api to commit all saved changes with rollback protection and attempts to confirm the pending commit operation to cancel the rollback timer.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>timeout</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> 10 </td> <td class="description last"> <span class="optional">optional</span> <p>Override the confirmation timeout after which a rollback is triggered.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Promise.<number> </td> <td class="description last">Returns a promise resolving/rejecting with the <code>ubus</code> RPC status code.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="changes"> changes<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Object.<string, Array.<<a href="LuCI.uci.html#.ChangeRecord">LuCI.uci.ChangeRecord</a>>>>}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line938">line 938</a> </div> </div> </dt> <dd> <div class="description"> <p>Fetches uncommitted UCI changes from the remote <code>ubus</code> RPC api.</p> </div> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Promise.<Object.<string, Array.<<a href="LuCI.uci.html#.ChangeRecord">LuCI.uci.ChangeRecord</a>>>> </td> <td class="description last">Returns a promise resolving to an object containing the configuration names as keys and arrays of related change records as values.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="createSID"> createSID<span class="signature">(config)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line88">line 88</a> </div> </div> </dt> <dd> <div class="description"> <p>Generates a new, unique section ID for the given configuration.</p> <p>Note that the generated ID is temporary, it will get replaced by an identifier in the form <code>cfgXXXXXX</code> once the configuration is saved by the remote <code>ubus</code> UCI api.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The configuration to generate the new section ID for.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> string </td> <td class="description last">A newly generated, unique section ID in the form <code>newXXXXXX</code> where <code>X</code> denotes a hexadecimal digit.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="get"> 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.<string>|<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line443">line 443</a> </div> </div> </dt> <dd> <div class="description"> <p>Gets the value of the given option within the specified section of the given configuration or the entire section object if the option name is omitted.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to read the value from.</p></td> </tr> <tr> <td class="name"><code>sid</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name or ID of the section to read.</p></td> </tr> <tr> <td class="name"><code>option</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <span class="optional">optional</span> <p>The option name to read the value from. If the option name is omitted or <code>null</code>, the entire section is returned instead.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> null | string | Array.<string> | <a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a> </td> <td class="description last"><ul> <li>Returns a string containing the option value in case of a plain UCI option.</li> <li>Returns an array of strings containing the option values in case of <code>option</code> pointing to an UCI list.</li> <li>Returns a <a href="LuCI.uci.html#.SectionObject"><code>section object</code></a> if the <code>option</code> argument has been omitted or is <code>null</code>.</li> <li>Returns <code>null</code> if the config, section or option has not been found or if the corresponding configuration is not loaded.</li> </ul></td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="get_first"> 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.<string>|<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line618">line 618</a> </div> </div> </dt> <dd> <div class="description"> <p>Gets the value of the given option or the entire section object of the first found section of the specified type or the first found section of the entire configuration if no type is specfied.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to read the value from.</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <span class="optional">optional</span> <p>The type of the first section to find. If it is <code>null</code>, the first section of the entire config is read, otherwise the first section matching the given type.</p></td> </tr> <tr> <td class="name"><code>option</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <span class="optional">optional</span> <p>The option name to read the value from. If the option name is omitted or <code>null</code>, the entire section is returned instead.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> null | string | Array.<string> | <a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a> </td> <td class="description last"><ul> <li>Returns a string containing the option value in case of a plain UCI option.</li> <li>Returns an array of strings containing the option values in case of <code>option</code> pointing to an UCI list.</li> <li>Returns a <a href="LuCI.uci.html#.SectionObject"><code>section object</code></a> if the <code>option</code> argument has been omitted or is <code>null</code>.</li> <li>Returns <code>null</code> if the config, section or option has not been found or if the corresponding configuration is not loaded.</li> </ul></td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="load"> load<span class="signature">(config)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<string>>}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line205">line 205</a> </div> </div> </dt> <dd> <div class="description"> <p>Loads the given UCI configurations from the remote <code>ubus</code> api.</p> <p>Loaded configurations are cached and only loaded once. Subsequent load operations of the same configurations will return the cached data.</p> <p>To force reloading a configuration, it has to be unloaded with <a href="LuCI.uci.html#unload"><code>uci.unload()</code></a> first.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </td> <td class="description last"> <p>The name of the configuration or an array of configuration names to load.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Promise.<Array.<string>> </td> <td class="description last">Returns a promise resolving to the names of the configurations that have been successfully loaded.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="move"> 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> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line718">line 718</a> </div> </div> </dt> <dd> <div class="description"> <p>Move the first specified section within the given configuration before or after the second specified section.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> </td> <td class="description last"> <p>The configuration to move the section within.</p></td> </tr> <tr> <td class="name"><code>sid1</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> </td> <td class="description last"> <p>The ID of the section to move within the configuration.</p></td> </tr> <tr> <td class="name"><code>sid2</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> </td> <td class="description last"> <span class="optional">optional</span> <p>The ID of the target section for the move operation. If the <code>after</code> argument is <code>false</code> or not specified, the section named by <code>sid1</code> will be moved before this target section, if the <code>after</code> argument is <code>true</code>, the <code>sid1</code> section will be moved after this section.</p> <p>When the <code>sid2</code> argument is <code>null</code>, the section specified by <code>sid1</code> is moved to the end of the configuration.</p></td> </tr> <tr> <td class="name"><code>after</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last"> <span class="optional">optional</span> <p>When <code>true</code>, the section <code>sid1</code> is moved after the section <code>sid2</code>, when <code>false</code>, the section <code>sid1</code> is moved before <code>sid2</code>.</p> <p>If <code>sid2</code> is null, then this parameter has no effect and the section <code>sid1</code> is moved to the end of the configuration instead.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> boolean </td> <td class="description last">Returns <code>true</code> when the section was successfully moved, or <code>false</code> when either the section specified by <code>sid1</code> or by <code>sid2</code> is not found.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="remove"> remove<span class="signature">(config, sid)</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line296">line 296</a> </div> </div> </dt> <dd> <div class="description"> <p>Removes the section with the given ID from the given configuration.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to remove the section from.</p></td> </tr> <tr> <td class="name"><code>sid</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The ID of the section to remove.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="resolveSID"> resolveSID<span class="signature">(config, sid)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string|null}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line119">line 119</a> </div> </div> </dt> <dd> <div class="description"> <p>Resolves a given section ID in extended notation to the internal section ID value.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The configuration to resolve the section ID for.</p></td> </tr> <tr> <td class="name"><code>sid</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The section ID to resolve. If the ID is in the form <code>@typename[#]</code>, it will get resolved to an internal anonymous ID in the forms <code>cfgXXXXXX</code>/<code>newXXXXXX</code> or to the name of a section in case it points to a named section. When the given ID is not in extended notation, it will be returned as-is.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> string | null </td> <td class="description last">Returns the resolved section ID or the original given ID if it was not in extended notation. Returns <code>null</code> when an extended ID could not be resolved to existing section ID.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="save"> save<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line772">line 772</a> </div> </div> </dt> <dd> <div class="description"> <p>Submits all local configuration changes to the remove <code>ubus</code> api, adds, removes and reorders remote sections as needed and reloads all loaded configurations to resynchronize the local state with the remote configuration values.</p> </div> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Array.<string> </td> <td class="description last">Returns a promise resolving to an array of configuration names which have been reloaded by the save operation.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="sections"> 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.<<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>>}</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line384">line 384</a> </div> </div> </dt> <dd> <div class="description"> <p>Enumerates the sections of the given configuration, optionally filtered by type.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to enumerate the sections for.</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <span class="optional">optional</span> <p>Enumerate only sections of the given type. If omitted, enumerate all sections.</p></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type"><a href="LuCI.uci.html#~sectionsFn">LuCI.uci~sectionsFn</a></span> </td> <td class="description last"> <span class="optional">optional</span> <p>An optional callback to invoke for each enumerated section.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Array.<<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>> </td> <td class="description last">Returns a sorted array of the section objects within the given configuration, filtered by type of a type has been specified.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="set"> set<span class="signature">(config, sid, option, value)</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line516">line 516</a> </div> </div> </dt> <dd> <div class="description"> <p>Sets the value of the given option within the specified section of the given configuration.</p> <p>If either config, section or option is null, or if <code>option</code> begins with a dot, the function will do nothing.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to set the option value in.</p></td> </tr> <tr> <td class="name"><code>sid</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name or ID of the section to set the option value in.</p></td> </tr> <tr> <td class="name"><code>option</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The option name to set the value for.</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">null</span> | <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </td> <td class="description last"> <p>The option value to set. If the value is <code>null</code> or an empty string, the option will be removed, otherwise it will be set or overwritten with the given value.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="set_first"> set_first<span class="signature">(config, <span class="optional">type</span>, option, value)</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line653">line 653</a> </div> </div> </dt> <dd> <div class="description"> <p>Sets the value of the given option within the first found section of the given configuration matching the specified type or within the first section of the entire config when no type has is specified.</p> <p>If either config, type or option is null, or if <code>option</code> begins with a dot, the function will do nothing.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to set the option value in.</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <span class="optional">optional</span> <p>The type of the first section to find. If it is <code>null</code>, the first section of the entire config is written to, otherwise the first section matching the given type is used.</p></td> </tr> <tr> <td class="name"><code>option</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The option name to set the value for.</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">null</span> | <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </td> <td class="description last"> <p>The option value to set. If the value is <code>null</code> or an empty string, the option will be removed, otherwise it will be set or overwritten with the given value.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="unload"> unload<span class="signature">(config)</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line237">line 237</a> </div> </div> </dt> <dd> <div class="description"> <p>Unloads the given UCI configurations from the local cache.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </td> <td class="description last"> <p>The name of the configuration or an array of configuration names to unload.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="unset"> unset<span class="signature">(config, sid, option)</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line587">line 587</a> </div> </div> </dt> <dd> <div class="description"> <p>Remove the given option within the specified section of the given configuration.</p> <p>This function is a convenience wrapper around <code>uci.set(config, section, option, null)</code>.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to remove the option from.</p></td> </tr> <tr> <td class="name"><code>sid</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name or ID of the section to remove the option from.</p></td> </tr> <tr> <td class="name"><code>option</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the option to remove.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="unset_first"> unset_first<span class="signature">(config, <span class="optional">type</span>, option)</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line683">line 683</a> </div> </div> </dt> <dd> <div class="description"> <p>Removes the given option within the first found section of the given configuration matching the specified type or within the first section of the entire config when no type has is specified.</p> <p>This function is a convenience wrapper around <code>uci.set_first(config, type, option, null)</code>.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name of the configuration to set the option value in.</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <span class="optional">optional</span> <p>The type of the first section to find. If it is <code>null</code>, the first section of the entire config is written to, otherwise the first section matching the given type is used.</p></td> </tr> <tr> <td class="name"><code>option</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The option name to set the value for.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> </dl> <h3 class="subsection-title">Type Definitions</h3> <dl> <dt> <div class="nameContainer"> <h4 class="name" id=".ChangeRecord">LuCI.uci.ChangeRecord<span class="type-signature type array.<string>">Array.<string></span> </h4> </div> </dt> <dd> <div class="description"> <p>An UCI change record is a plain array containing the change operation name as first element, the affected section ID as second argument and an optional third and fourth argument whose meanings depend on the operation.</p> </div> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>0</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The operation name - may be one of <code>add</code>, <code>set</code>, <code>remove</code>, <code>order</code>, <code>list-add</code>, <code>list-del</code> or <code>rename</code>.</p></td> </tr> <tr> <td class="name"><code>1</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The section ID targeted by the operation.</p></td> </tr> <tr> <td class="name"><code>2</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The meaning of the third element depends on the operation.</p> <ul> <li>For <code>add</code> it is type of the section that has been added</li> <li>For <code>set</code> it either is the option name if a fourth element exists, or the type of a named section which has been added when the change entry only contains three elements.</li> <li>For <code>remove</code> it contains the name of the option that has been removed.</li> <li>For <code>order</code> it specifies the new sort index of the section.</li> <li>For <code>list-add</code> it contains the name of the list option a new value has been added to.</li> <li>For <code>list-del</code> it contains the name of the list option a value has been removed from.</li> <li>For <code>rename</code> it contains the name of the option that has been renamed if a fourth element exists, else it contains the new name a section has been renamed to if the change entry only contains three elements.</li> </ul></td> </tr> <tr> <td class="name"><code>4</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The meaning of the fourth element depends on the operation.</p> <ul> <li>For <code>set</code> it is the value an option has been set to.</li> <li>For <code>list-add</code> it is the new value that has been added to a list option.</li> <li>For <code>rename</code> it is the new name of an option that has been renamed.</li> </ul></td> </tr> </tbody> </table></dl> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id=".SectionObject">LuCI.uci.SectionObject<span class="type-signature type object.<string, (boolean|number|string|array.<string>)>">Object.<string, (boolean|number|string|Array.<string>)></span> </h4> </div> </dt> <dd> <div class="description"> <p>A section object represents the options and their corresponding values enclosed within a configuration section, as well as some additional meta data such as sort indexes and internal ID.</p> <p>Any internal metadata fields are prefixed with a dot which is isn't an allowed character for normal option names.</p> </div> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>.anonymous</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>The <code>.anonymous</code> property specifies whether the configuration is anonymous (<code>true</code>) or named (<code>false</code>).</p></td> </tr> <tr> <td class="name"><code>.index</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The <code>.index</code> property specifes the sort order of the section.</p></td> </tr> <tr> <td class="name"><code>.name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The <code>.name</code> property holds the name of the section object. It may be either an anonymous ID in the form <code>cfgXXXXXX</code> or <code>newXXXXXX</code> with <code>X</code> being a hexadecimal digit or a string holding the name of the section.</p></td> </tr> <tr> <td class="name"><code>.type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The <code>.type</code> property contains the type of the corresponding uci section.</p></td> </tr> <tr> <td class="name"><code>*</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </td> <td class="description last"><p>A section object may contain an arbitrary number of further properties representing the uci option enclosed in the section.</p> <p>All option property names will be in the form <code>[A-Za-z0-9_]+</code> and either contain a string value or an array of strings, in case the underlying option is an UCI list.</p></td> </tr> </tbody> </table></dl> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~sectionsFn"> sectionsFn<span class="signature">(section, sid)</span> </h4> <div class="tag-source"> <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line352">line 352</a> </div> </div> </dt> <dd> <div class="description"> <p>The sections callback is invoked for each section found within the given configuration and receives the section object and its associated name as arguments.</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>section</code></td> <td class="type"> <span class="param-type"><a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a></span> </td> <td class="description last"> <p>The section object.</p></td> </tr> <tr> <td class="name"><code>sid</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The name or ID of the section.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> </dl> </article> </section> <footer> 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) </footer> </div> </div> <script>prettyPrint();</script> <script src="scripts/jaguar.js"></script> </body> </html>