diff options
| author | Jo-Philipp Wich <jo@mein.io> | 2019-11-05 10:18:51 +0100 |
|---|---|---|
| committer | Jo-Philipp Wich <jo@mein.io> | 2019-11-05 10:18:51 +0100 |
| commit | 355a48866d1a43df9443a3b559c8ec8642343f3a (patch) | |
| tree | f5bea3a7a89baeeaa8ab498821b840f085f6315e /documentation/jsapi | |
| parent | f3f6bf64b860380cdaa52e3386113d3b7ccd6a24 (diff) | |
documentation: change JS docs template
Use another template for the JS api documentation which provides a better
overview over the classes and methods.
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to 'documentation/jsapi')
21 files changed, 44505 insertions, 28095 deletions
diff --git a/documentation/jsapi/LuCI.Class.html b/documentation/jsapi/LuCI.Class.html index 7b5c3a8f74..28916f113e 100644 --- a/documentation/jsapi/LuCI.Class.html +++ b/documentation/jsapi/LuCI.Class.html @@ -1,195 +1,1234 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Class</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Class</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Class</h1> - +<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#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#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#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#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#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#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#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.Class.html">Class: Class</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>Class</h2> - - <div class="class-description"><p><code>LuCI.Class</code> is the abstract base class all LuCI classes inherit from.</p> + Class + </h2> + + <div class="class-description"><p><code>LuCI.Class</code> is the abstract base class all LuCI classes inherit from.</p> <p>It provides simple means to create subclasses of given classes and implements prototypal inheritance.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Class"> + + new LuCI.Class<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 59 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line59">line 59</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".extend"> + + <span class="type-signature static">static</span>LuCI.Class.extend<span class="signature">(properties)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Class.html">LuCI.Class</a>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 87 + </div> + + </div> - <h4 class="name" id=".extend"><span class="type-signature">(static) </span>extend<span class="signature">(properties)</span><span class="type-signature"> → {<a href="LuCI.Class.html">LuCI.Class</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Extends this base class with the properties described in + <div class="description"> + <p>Extends this base class with the properties described in <code>properties</code> and returns a new subclassed Class instance</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>properties</code></td> - + <td class="type"> @@ -198,164 +1237,148 @@ implements prototypal inheritance.</p></div> </td> - - - - <td class="description last"><p>An object describing the properties to add to the new + + <td class="description last"> + + <p>An object describing the properties to add to the new subclass.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line87">line 87</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a new LuCI.Class sublassed from this class, extended + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.Class.html">LuCI.Class</a> + + + </td> + <td class="description last">Returns a new LuCI.Class sublassed from this class, extended by the given properties and with its prototype set to this base class to enable inheritance. The resulting value represents a -class constructor and can be instantiated with <code>new</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type"><a href="LuCI.Class.html">LuCI.Class</a></span> - - - </dd> -</dl> - +class constructor and can be instantiated with <code>new</code>.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".instantiate"> + + <span class="type-signature static">static</span>LuCI.Class.instantiate<span class="signature">(params, <span class="optional">new_args</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Class.html">LuCI.Class</a>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 169 + </div> + + </div> - <h4 class="name" id=".instantiate"><span class="type-signature">(static) </span>instantiate<span class="signature">(params, …new_args<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="LuCI.Class.html">LuCI.Class</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Calls the class constructor using <code>new</code> with the given argument + <div class="description"> + <p>Calls the class constructor using <code>new</code> with the given argument array being passed as variadic parameters to the constructor.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>params</code></td> - + <td class="type"> @@ -364,30 +1387,27 @@ array being passed as variadic parameters to the constructor.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>An array of arbitrary values which will be passed as arguments + <td class="description last"> + + + + + + + <p>An array of arbitrary values which will be passed as arguments to the constructor function.</p></td> </tr> - - - + + + <tr> <td class="name"><code>new_args</code></td> - + <td class="type"> @@ -396,172 +1416,155 @@ to the constructor function.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>Specifies arguments to be passed to the subclass constructor + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Specifies arguments to be passed to the subclass constructor as-is in order to instantiate the new subclass.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line169">line 169</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a new LuCI.Class instance extended by the given -properties with its prototype set to this base class to -enable inheritance.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type"><a href="LuCI.Class.html">LuCI.Class</a></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id=".isSubclass"><span class="type-signature">(static) </span>isSubclass<span class="signature">(classValue)</span><span class="type-signature"> → {boolean}</span></h4> - - - - -<div class="description"> - <p>Checks whether the given class value is a subclass of this class.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.Class.html">LuCI.Class</a> + + + </td> + <td class="description last">Returns a new LuCI.Class instance extended by the given +properties with its prototype set to this base class to +enable inheritance.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id=".isSubclass"> + + <span class="type-signature static">static</span>LuCI.Class.isSubclass<span class="signature">(classValue)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 195 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether the given class value is a subclass of this class.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>classValue</code></td> - + <td class="type"> @@ -570,167 +1573,151 @@ enable inheritance.</p> </td> - - - - <td class="description last"><p>The class object to test.</p></td> + + <td class="description last"> + + <p>The class object to test.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line195">line 195</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> when the given <code>classValue</code> is a subclass of this + <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 given <code>classValue</code> is a subclass of this class or <code>false</code> if the given value is not a valid class or not -a subclass of this class'.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +a subclass of this class'.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".singleton"> + + <span class="type-signature static">static</span>LuCI.Class.singleton<span class="signature">(properties, <span class="optional">new_args</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Class.html">LuCI.Class</a>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 145 + </div> + + </div> - <h4 class="name" id=".singleton"><span class="type-signature">(static) </span>singleton<span class="signature">(properties, …new_args<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="LuCI.Class.html">LuCI.Class</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Extends this base class with the properties described in + <div class="description"> + <p>Extends this base class with the properties described in <code>properties</code>, instantiates the resulting subclass using the additional optional arguments passed to this function and returns the resulting subclassed Class instance.</p> <p>This function serves as a convenience shortcut for <a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a> and subsequent <code>new</code>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>properties</code></td> - + <td class="type"> @@ -739,30 +1726,27 @@ and returns the resulting subclassed Class instance.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>An object describing the properties to add to the new + <td class="description last"> + + + + + + + <p>An object describing the properties to add to the new subclass.</p></td> </tr> - - - + + + <tr> <td class="name"><code>new_args</code></td> - + <td class="type"> @@ -771,134 +1755,122 @@ subclass.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>Specifies arguments to be passed to the subclass constructor + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Specifies arguments to be passed to the subclass constructor as-is in order to instantiate the new subclass.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line145">line 145</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a new LuCI.Class instance extended by the given + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.Class.html">LuCI.Class</a> + + + </td> + <td class="description last">Returns a new LuCI.Class instance extended by the given properties with its prototype set to this base class to -enable inheritance.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type"><a href="LuCI.Class.html">LuCI.Class</a></span> - - - </dd> -</dl> - +enable inheritance.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="super"> + + super<span class="signature">(key, <span class="optional">callArgs</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*|null}</span> + </h4> + + <div class="tag-source"> + luci.js, line 267 + </div> + + </div> - <h4 class="name" id="super"><span class="type-signature"></span>super<span class="signature">(key, callArgs<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*|null}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Walks up the parent class chain and looks for a class member + <div class="description"> + <p>Walks up the parent class chain and looks for a class member called <code>key</code> in any of the parent classes this class inherits from. Returns the member value of the superclass or calls the member as function and returns its return value when the @@ -913,46 +1885,39 @@ parent classes.</li> Calls the <code>key()</code> method with parameters <code>arg1</code> and <code>arg2</code> when found within one of the parent classes.</li> </ul> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>key</code></td> - + <td class="type"> @@ -961,29 +1926,26 @@ when found within one of the parent classes.</li> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the superclass member to retrieve.</p></td> + <td class="description last"> + + + + + + + <p>The name of the superclass member to retrieve.</p></td> </tr> - - - + + + <tr> <td class="name"><code>callArgs</code></td> - + <td class="type"> @@ -992,90 +1954,64 @@ when found within one of the parent classes.</li> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An optional array of function call parameters to use. When + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An optional array of function call parameters to use. When this parameter is specified, the found member value is called as function using the values of this array as arguments.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line267">line 267</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -1084,7 +2020,6 @@ as function using the values of this array as arguments.</p></td> the found member named by <code>key</code> is not a function value.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -1098,103 +2033,109 @@ the found member named by <code>key</code> is not a function value.</p> </dd> </dl> </dt> - <dd></dd> </dl> + + + + <h5>Returns:</h5> -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the value of the found member or the return value of + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + * + | + + null + + + </td> + <td class="description last">Returns the value of the found member or the return value of the call to the found method. Returns <code>null</code> when no member was found in the parent class chain or when the call to the -superclass method returned <code>null</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">*</span> -| - -<span class="param-type">null</span> - - - </dd> -</dl> - +superclass method returned <code>null</code>.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="varargs"> + + varargs<span class="signature">(args, offset, <span class="optional">extra_args</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 225 + </div> + + </div> - <h4 class="name" id="varargs"><span class="type-signature"></span>varargs<span class="signature">(args, offset, …extra_args<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Extract all values from the given argument array beginning from + <div class="description"> + <p>Extract all values from the given argument array beginning from <code>offset</code> and prepend any further given optional parameters to the beginning of the resulting array copy.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -1203,29 +2144,26 @@ the beginning of the resulting array copy.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The array to extract the values from.</p></td> + <td class="description last"> + + + + + + + <p>The array to extract the values from.</p></td> </tr> - - - + + + <tr> <td class="name"><code>offset</code></td> - + <td class="type"> @@ -1234,30 +2172,27 @@ the beginning of the resulting array copy.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The offset from which to extract the values. An offset of <code>0</code> + <td class="description last"> + + + + + + + <p>The offset from which to extract the values. An offset of <code>0</code> would copy all values till the end.</p></td> </tr> - - - + + + <tr> <td class="name"><code>extra_args</code></td> - + <td class="type"> @@ -1266,144 +2201,122 @@ would copy all values till the end.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>Extra arguments to add to prepend to the resultung array.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Extra arguments to add to prepend to the resultung array.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line225">line 225</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a new array consisting of the optional extra arguments + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<*> + + + </td> + <td class="description last">Returns a new array consisting of the optional extra arguments and the values extracted from the <code>args</code> array beginning with -<code>offset</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<*></span> - - - </dd> -</dl> - +<code>offset</code>.</td> + </tr> + </tbody> +</table> - - - - - + + +</dd> + </dl> + + + + </article> -</section> +</section> -</div> -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> - -<br class="clear"> - -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Headers.html b/documentation/jsapi/LuCI.Headers.html index a63017bcf6..efb898bbf4 100644 --- a/documentation/jsapi/LuCI.Headers.html +++ b/documentation/jsapi/LuCI.Headers.html @@ -1,194 +1,1233 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Headers</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Headers</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Headers</h1> - +<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#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#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#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#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#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#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#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.Headers.html">Class: Headers</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>Headers</h2> - - <div class="class-description"><p>The <code>Headers</code> class is an internal utility class exposed in HTTP + Headers + </h2> + + <div class="class-description"><p>The <code>Headers</code> class is an internal utility class exposed in HTTP response objects using the <code>response.headers</code> property.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Headers"> + + new LuCI.Headers<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 324 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line324">line 324</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string|null}</span> + </h4> + + <div class="tag-source"> + luci.js, line 363 + </div> + + </div> - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(name)</span><span class="type-signature"> → {string|null}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Returns the value of the given header name. + <div class="description"> + <p>Returns the value of the given header name. Note: Header-Names are case-insensitive.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -197,161 +1236,147 @@ Note: Header-Names are case-insensitive.</p> </td> - - - - <td class="description last"><p>The header name to read</p></td> + + <td class="description last"> + + <p>The header name to read</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line363">line 363</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The value of the given header name or <code>null</code> if the header isn't present.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> -| - -<span class="param-type">null</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="has"><span class="type-signature"></span>has<span class="signature">(name)</span><span class="type-signature"> → {boolean}</span></h4> - - - - -<div class="description"> - <p>Checks whether the given header name is present. -Note: Header-Names are case-insensitive.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + | + + null + + + </td> + <td class="description last">The value of the given header name or <code>null</code> if the header isn't present.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="has"> + + has<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 347 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether the given header name is present. +Note: Header-Names are case-insensitive.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -360,130 +1385,111 @@ Note: Header-Names are case-insensitive.</p> </td> - - - - <td class="description last"><p>The header name to check</p></td> + + <td class="description last"> + + <p>The header name to check</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line347">line 347</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the header name is present, <code>false</code> otherwise</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if the header name is present, <code>false</code> otherwise</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> - -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Network.Device.html b/documentation/jsapi/LuCI.Network.Device.html index 0236f8c503..71d88df22f 100644 --- a/documentation/jsapi/LuCI.Network.Device.html +++ b/documentation/jsapi/LuCI.Network.Device.html @@ -1,2010 +1,2888 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Device</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Device</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Device</h1> - +<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#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#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#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#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#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#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#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.Network.Device.html">Class: Device</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>Device</h2> - - <div class="class-description"><p>A <code>Network.Device</code> class instance represents an underlying Linux network + Device + </h2> + + <div class="class-description"><p>A <code>Network.Device</code> class instance represents an underlying Linux network device and allows querying device details such as packet statistics or MTU.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Device"> + + new LuCI.Network.Device<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + network.js, line 2593 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2593">line 2593</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getBridgeID"> + + getBridgeID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2800 + </div> + + </div> - <h4 class="name" id="getBridgeID"><span class="type-signature"></span>getBridgeID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the bridge ID</p> + </div> - - -<div class="description"> - <p>Get the bridge ID</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2800">line 2800</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the ID of this network bridge or <code>null</code> if this network -device is not a Linux bridge.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the ID of this network bridge or <code>null</code> if this network +device is not a Linux bridge.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getBridgeSTP"> + + getBridgeSTP<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2812 + </div> + + </div> - <h4 class="name" id="getBridgeSTP"><span class="type-signature"></span>getBridgeSTP<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the bridge STP setting</p> + </div> - - -<div class="description"> - <p>Get the bridge STP setting</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2812">line 2812</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when this device is a Linux bridge and has <code>stp</code> -enabled, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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 this device is a Linux bridge and has <code>stp</code> +enabled, else <code>false</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getI18n"> + + getI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2727 + </div> + + </div> - <h4 class="name" id="getI18n"><span class="type-signature"></span>getI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a long description string for the device.</p> + </div> - - -<div class="description"> - <p>Get a long description string for the device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2727">line 2727</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a string containing the type description and device name -for non-wifi devices or operation mode and ssid for wifi ones.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string containing the type description and device name +for non-wifi devices or operation mode and ssid for wifi ones.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIP6Addrs"> + + getIP6Addrs<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"> + network.js, line 2671 + </div> + + </div> - <h4 class="name" id="getIP6Addrs"><span class="type-signature"></span>getIP6Addrs<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the IPv6 addresses configured on the device.</p> + </div> - - -<div class="description"> - <p>Get the IPv6 addresses configured on the device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2671">line 2671</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of IPv6 address strings.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv6 address strings.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIPAddrs"> + + getIPAddrs<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"> + network.js, line 2660 + </div> + + </div> - <h4 class="name" id="getIPAddrs"><span class="type-signature"></span>getIPAddrs<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the IPv4 addresses configured on the device.</p> + </div> - - -<div class="description"> - <p>Get the IPv4 addresses configured on the device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2660">line 2660</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of IPv4 address strings.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv4 address strings.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMAC"> + + getMAC<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2639 + </div> + + </div> - <h4 class="name" id="getMAC"><span class="type-signature"></span>getMAC<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the MAC address of the device.</p> + </div> - - -<div class="description"> - <p>Get the MAC address of the device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2639">line 2639</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the MAC address of the device or <code>null</code> if not applicable, -e.g. for non-ethernet tunnel devices.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the MAC address of the device or <code>null</code> if not applicable, +e.g. for non-ethernet tunnel devices.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMTU"> + + getMTU<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 2650 + </div> + + </div> - <h4 class="name" id="getMTU"><span class="type-signature"></span>getMTU<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the MTU of the device.</p> + </div> - - -<div class="description"> - <p>Get the MTU of the device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2650">line 2650</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the MTU of the device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the MTU of the device.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getName"> + + getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2628 + </div> + + </div> - <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the name of the network device.</p> + </div> - - -<div class="description"> - <p>Get the name of the network device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2628">line 2628</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the name of the device, e.g. <code>eth0</code> or <code>wlan0</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the name of the device, e.g. <code>eth0</code> or <code>wlan0</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetwork"> + + getNetwork<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2907 + </div> + + </div> - <h4 class="name" id="getNetwork"><span class="type-signature"></span>getNetwork<span class="signature">()</span><span class="type-signature"> → {null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the primary logical interface this device is assigned to.</p> + </div> - - -<div class="description"> - <p>Get the primary logical interface this device is assigned to.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2907">line 2907</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a <code>Network.Protocol</code> instance representing the logical + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> + + + </td> + <td class="description last">Returns a <code>Network.Protocol</code> instance representing the logical interface this device is attached to or <code>null</code> if it is not -assigned to any logical interface.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> - - - </dd> -</dl> - +assigned to any logical interface.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetworks"> + + getNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2918 + </div> + + </div> - <h4 class="name" id="getNetworks"><span class="type-signature"></span>getNetworks<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the logical interfaces this device is assigned to.</p> + </div> - - -<div class="description"> - <p>Get the logical interfaces this device is assigned to.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2918">line 2918</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of <code>Network.Protocol</code> instances representing the -logical interfaces this device is assigned to.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>> + + + </td> + <td class="description last">Returns an array of <code>Network.Protocol</code> instances representing the +logical interfaces this device is assigned to.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getPorts"> + + getPorts<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2778 + </div> + + </div> - <h4 class="name" id="getPorts"><span class="type-signature"></span>getPorts<span class="signature">()</span><span class="type-signature"> → {null|Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the associated bridge ports of the device.</p> + </div> - - -<div class="description"> - <p>Get the associated bridge ports of the device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2778">line 2778</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns an array of <code>Network.Device</code> instances representing the ports + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>> + + + </td> + <td class="description last">Returns an array of <code>Network.Device</code> instances representing the ports (slave interfaces) of the bridge or <code>null</code> when this device isn't -a Linux bridge.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>></span> - - - </dd> -</dl> - +a Linux bridge.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getRXBytes"> + + getRXBytes<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 2872 + </div> + + </div> - <h4 class="name" id="getRXBytes"><span class="type-signature"></span>getRXBytes<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the amount of received bytes.</p> + </div> - - -<div class="description"> - <p>Get the amount of received bytes.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2872">line 2872</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the amount of bytes received by the network device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the amount of bytes received by the network device.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getRXPackets"> + + getRXPackets<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 2894 + </div> + + </div> - <h4 class="name" id="getRXPackets"><span class="type-signature"></span>getRXPackets<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the amount of received packets.</p> + </div> - - -<div class="description"> - <p>Get the amount of received packets.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2894">line 2894</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the amount of packets received by the network device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the amount of packets received by the network device.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getShortName"> + + getShortName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2713 + </div> + + </div> - <h4 class="name" id="getShortName"><span class="type-signature"></span>getShortName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a short description string for the device.</p> + </div> - - -<div class="description"> - <p>Get a short description string for the device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2713">line 2713</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the device name for non-wifi devices or a string containing -the operation mode and SSID for wifi devices.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the device name for non-wifi devices or a string containing +the operation mode and SSID for wifi devices.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getTXBytes"> + + getTXBytes<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 2861 + </div> + + </div> - <h4 class="name" id="getTXBytes"><span class="type-signature"></span>getTXBytes<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the amount of transmitted bytes.</p> + </div> - - -<div class="description"> - <p>Get the amount of transmitted bytes.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2861">line 2861</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the amount of bytes transmitted by the network device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the amount of bytes transmitted by the network device.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getTXPackets"> + + getTXPackets<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 2883 + </div> + + </div> - <h4 class="name" id="getTXPackets"><span class="type-signature"></span>getTXPackets<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the amount of transmitted packets.</p> + </div> - - -<div class="description"> - <p>Get the amount of transmitted packets.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2883">line 2883</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the amount of packets transmitted by the network device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the amount of packets transmitted by the network device.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getType"> + + getType<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2689 + </div> + + </div> - <h4 class="name" id="getType"><span class="type-signature"></span>getType<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the type of the device..</p> + </div> - - -<div class="description"> - <p>Get the type of the device..</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2689">line 2689</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a string describing the type of the network device:</p> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string describing the type of the network device: <ul> <li><code>alias</code> if it is an abstract alias device (<code>@</code> notation)</li> <li><code>wifi</code> if it is a wireless interface (e.g. <code>wlan0</code>)</li> @@ -2013,614 +2891,550 @@ the operation mode and SSID for wifi devices.</p> <li><code>vlan</code> if it is a vlan device (e.g. <code>eth0.1</code>)</li> <li><code>switch</code> if it is a switch device (e.g.<code>eth1</code> connected to switch0)</li> <li><code>ethernet</code> for all other device types</li> -</ul> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +</ul></td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getTypeI18n"> + + getTypeI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2745 + </div> + + </div> - <h4 class="name" id="getTypeI18n"><span class="type-signature"></span>getTypeI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a string describing the device type.</p> + </div> - - -<div class="description"> - <p>Get a string describing the device type.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2745">line 2745</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a string describing the type, e.g. "Wireless Adapter" or -"Bridge".</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string describing the type, e.g. "Wireless Adapter" or +"Bridge".</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiNetwork"> + + getWifiNetwork<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2942 + </div> + + </div> - <h4 class="name" id="getWifiNetwork"><span class="type-signature"></span>getWifiNetwork<span class="signature">()</span><span class="type-signature"> → {null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the related wireless network this device is related to.</p> + </div> - - -<div class="description"> - <p>Get the related wireless network this device is related to.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2942">line 2942</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a <code>Network.WifiNetwork</code> instance representing the wireless + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a> + + + </td> + <td class="description last">Returns a <code>Network.WifiNetwork</code> instance representing the wireless network corresponding to this network device or <code>null</code> if this device -is not a wireless device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span> - - - </dd> -</dl> - +is not a wireless device.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isBridge"> + + isBridge<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2840 + </div> + + </div> - <h4 class="name" id="isBridge"><span class="type-signature"></span>isBridge<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks whether this device is a Linux bridge.</p> + </div> - - -<div class="description"> - <p>Checks whether this device is a Linux bridge.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2840">line 2840</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the network device is present and a Linux bridge, -else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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 network device is present and a Linux bridge, +else <code>false</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isBridgePort"> + + isBridgePort<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2851 + </div> + + </div> - <h4 class="name" id="isBridgePort"><span class="type-signature"></span>isBridgePort<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks whether this device is part of a Linux bridge.</p> + </div> - - -<div class="description"> - <p>Checks whether this device is part of a Linux bridge.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2851">line 2851</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when this network device is part of a bridge, -else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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 this network device is part of a bridge, +else <code>false</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isUp"> + + isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2824 + </div> + + </div> - <h4 class="name" id="isUp"><span class="type-signature"></span>isUp<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks whether this device is up.</p> + </div> - - -<div class="description"> - <p>Checks whether this device is up.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2824">line 2824</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the associated device is running pr <code>false</code> -when it is down or absent.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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 associated device is running pr <code>false</code> +when it is down or absent.</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> - -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Network.Hosts.html b/documentation/jsapi/LuCI.Network.Hosts.html index f98641bb74..fc392d8802 100644 --- a/documentation/jsapi/LuCI.Network.Hosts.html +++ b/documentation/jsapi/LuCI.Network.Hosts.html @@ -1,194 +1,1233 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Hosts</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Hosts</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Hosts</h1> - +<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#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#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#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#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#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#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#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.Network.Hosts.html">Class: Hosts</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>Hosts</h2> - - <div class="class-description"><p>The <code>LuCI.Network.Hosts</code> class encapsulates host information aggregated + Hosts + </h2> + + <div class="class-description"><p>The <code>LuCI.Network.Hosts</code> class encapsulates host information aggregated from multiple sources and provides convenience functions to access the host information by different criteria.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Hosts"> + + new LuCI.Network.Hosts<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + network.js, line 1628 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1628">line 1628</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getHostnameByIP6Addr"> + + getHostnameByIP6Addr<span class="signature">(ipaddr)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 1725 + </div> + + </div> - <h4 class="name" id="getHostnameByIP6Addr"><span class="type-signature"></span>getHostnameByIP6Addr<span class="signature">(ipaddr)</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Lookup the hostname associated with the given IPv6 address.</p> + </div> - - -<div class="description"> - <p>Lookup the hostname associated with the given IPv6 address.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>ipaddr</code></td> - + <td class="type"> @@ -197,162 +1236,148 @@ host information by different criteria.</p></div> </td> - - - - <td class="description last"><p>The IPv6 address to lookup.</p></td> + + <td class="description last"> + + <p>The IPv6 address to lookup.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1725">line 1725</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the hostname associated with the given IPv6 or <code>null</code> if -no matching host could be found or if no hostname is known for -the corresponding host.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getHostnameByIPAddr"><span class="type-signature"></span>getHostnameByIPAddr<span class="signature">(ipaddr)</span><span class="type-signature"> → {null|string}</span></h4> - - - - -<div class="description"> - <p>Lookup the hostname associated with the given IPv4 address.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the hostname associated with the given IPv6 or <code>null</code> if +no matching host could be found or if no hostname is known for +the corresponding host.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getHostnameByIPAddr"> + + getHostnameByIPAddr<span class="signature">(ipaddr)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1689 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Lookup the hostname associated with the given IPv4 address.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>ipaddr</code></td> - + <td class="type"> @@ -361,162 +1386,148 @@ the corresponding host.</p> </td> - - - - <td class="description last"><p>The IPv4 address to lookup.</p></td> + + <td class="description last"> + + <p>The IPv4 address to lookup.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1689">line 1689</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the hostname associated with the given IPv4 or <code>null</code> if -no matching host could be found or if no hostname is known for -the corresponding host.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getHostnameByMACAddr"><span class="type-signature"></span>getHostnameByMACAddr<span class="signature">(mac)</span><span class="type-signature"> → {null|string}</span></h4> - - - - -<div class="description"> - <p>Lookup the hostname associated with the given MAC address.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the hostname associated with the given IPv4 or <code>null</code> if +no matching host could be found or if no hostname is known for +the corresponding host.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getHostnameByMACAddr"> + + getHostnameByMACAddr<span class="signature">(mac)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1644 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Lookup the hostname associated with the given MAC address.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>mac</code></td> - + <td class="type"> @@ -525,162 +1536,148 @@ the corresponding host.</p> </td> - - - - <td class="description last"><p>The MAC address to lookup.</p></td> + + <td class="description last"> + + <p>The MAC address to lookup.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1644">line 1644</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the hostname associated with the given MAC or <code>null</code> if -no matching host could be found or if no hostname is known for -the corresponding host.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getIP6AddrByMACAddr"><span class="type-signature"></span>getIP6AddrByMACAddr<span class="signature">(mac)</span><span class="type-signature"> → {null|string}</span></h4> - - - - -<div class="description"> - <p>Lookup the IPv6 address associated with the given MAC address.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the hostname associated with the given MAC or <code>null</code> if +no matching host could be found or if no hostname is known for +the corresponding host.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIP6AddrByMACAddr"> + + getIP6AddrByMACAddr<span class="signature">(mac)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1674 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Lookup the IPv6 address associated with the given MAC address.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>mac</code></td> - + <td class="type"> @@ -689,162 +1686,148 @@ the corresponding host.</p> </td> - - - - <td class="description last"><p>The MAC address to lookup.</p></td> + + <td class="description last"> + + <p>The MAC address to lookup.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1674">line 1674</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the IPv6 address associated with the given MAC or <code>null</code> if -no matching host could be found or if no IPv6 address is known for -the corresponding host.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getIPAddrByMACAddr"><span class="type-signature"></span>getIPAddrByMACAddr<span class="signature">(mac)</span><span class="type-signature"> → {null|string}</span></h4> - - - - -<div class="description"> - <p>Lookup the IPv4 address associated with the given MAC address.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the IPv6 address associated with the given MAC or <code>null</code> if +no matching host could be found or if no IPv6 address is known for +the corresponding host.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIPAddrByMACAddr"> + + getIPAddrByMACAddr<span class="signature">(mac)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1659 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Lookup the IPv4 address associated with the given MAC address.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>mac</code></td> - + <td class="type"> @@ -853,162 +1836,148 @@ the corresponding host.</p> </td> - - - - <td class="description last"><p>The MAC address to lookup.</p></td> + + <td class="description last"> + + <p>The MAC address to lookup.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1659">line 1659</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the IPv4 address associated with the given MAC or <code>null</code> if -no matching host could be found or if no IPv4 address is known for -the corresponding host.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getMACAddrByIP6Addr"><span class="type-signature"></span>getMACAddrByIP6Addr<span class="signature">(ipaddr)</span><span class="type-signature"> → {null|string}</span></h4> - - - - -<div class="description"> - <p>Lookup the MAC address associated with the given IPv6 address.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the IPv4 address associated with the given MAC or <code>null</code> if +no matching host could be found or if no IPv4 address is known for +the corresponding host.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMACAddrByIP6Addr"> + + getMACAddrByIP6Addr<span class="signature">(ipaddr)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1743 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Lookup the MAC address associated with the given IPv6 address.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>ipaddr</code></td> - + <td class="type"> @@ -1017,162 +1986,148 @@ the corresponding host.</p> </td> - - - - <td class="description last"><p>The IPv6 address to lookup.</p></td> + + <td class="description last"> + + <p>The IPv6 address to lookup.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1743">line 1743</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the MAC address associated with the given IPv6 or <code>null</code> if -no matching host could be found or if no MAC address is known for -the corresponding host.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getMACAddrByIPAddr"><span class="type-signature"></span>getMACAddrByIPAddr<span class="signature">(ipaddr)</span><span class="type-signature"> → {null|string}</span></h4> - - - - -<div class="description"> - <p>Lookup the MAC address associated with the given IPv4 address.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the MAC address associated with the given IPv6 or <code>null</code> if +no matching host could be found or if no MAC address is known for +the corresponding host.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMACAddrByIPAddr"> + + getMACAddrByIPAddr<span class="signature">(ipaddr)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1707 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Lookup the MAC address associated with the given IPv4 address.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>ipaddr</code></td> - + <td class="type"> @@ -1181,167 +2136,151 @@ the corresponding host.</p> </td> - - - - <td class="description last"><p>The IPv4 address to lookup.</p></td> + + <td class="description last"> + + <p>The IPv4 address to lookup.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1707">line 1707</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the MAC address associated with the given IPv4 or <code>null</code> if -no matching host could be found or if no MAC address is known for -the corresponding host.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getMACHints"><span class="type-signature"></span>getMACHints<span class="signature">(preferIp6<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Array.<string>>}</span></h4> - - - - -<div class="description"> - <p>Return an array of (MAC address, name hint) tuples sorted by -MAC address.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the MAC address associated with the given IPv4 or <code>null</code> if +no matching host could be found or if no MAC address is known for +the corresponding host.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMACHints"> + + getMACHints<span class="signature">(<span class="optional">preferIp6</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<Array.<string>>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1771 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Return an array of (MAC address, name hint) tuples sorted by +MAC address.</p> + </div> + - <tbody> + + + + + +<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>preferIp6</code></td> - + <td class="type"> @@ -1350,19 +2289,7 @@ MAC address.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -1370,135 +2297,125 @@ MAC address.</p> </td> - - <td class="description last"><p>Whether to prefer IPv6 addresses (<code>true</code>) or IPv4 addresses (<code>false</code>) + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Whether to prefer IPv6 addresses (<code>true</code>) or IPv4 addresses (<code>false</code>) as name hint when no hostname is known for a specific MAC address.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1771">line 1771</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns an array of arrays containing a name hint for each found -MAC address on the system. The array is sorted ascending by MAC.</p> -<p>Each item of the resulting array is a two element array with the + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<Array.<string>> + + + </td> + <td class="description last">Returns an array of arrays containing a name hint for each found +MAC address on the system. The array is sorted ascending by MAC. +Each item of the resulting array is a two element array with the MAC being the first element and the name hint being the second element. The name hint is either the hostname, an IPv4 or an IPv6 -address related to the MAC address.</p> -<p>If no hostname but both IPv4 and IPv6 addresses are known, the +address related to the MAC address. +If no hostname but both IPv4 and IPv6 addresses are known, the <code>preferIP6</code> flag specifies whether the IPv6 or the IPv4 address -is used as hint.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<Array.<string>></span> - - - </dd> -</dl> - +is used as hint.</td> + </tr> + </tbody> +</table> - - - - - + + +</dd> + </dl> + + + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> - -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Network.Protocol.html b/documentation/jsapi/LuCI.Network.Protocol.html index e23801a32b..20239bce80 100644 --- a/documentation/jsapi/LuCI.Network.Protocol.html +++ b/documentation/jsapi/LuCI.Network.Protocol.html @@ -1,193 +1,1232 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Protocol</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Protocol</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Protocol</h1> - +<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#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#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#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#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#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#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#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.Network.Protocol.html">Class: Protocol</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>Protocol</h2> - - <div class="class-description"><p>The <code>Network.Protocol</code> class serves as base for protocol specific + Protocol + </h2> + + <div class="class-description"><p>The <code>Network.Protocol</code> class serves as base for protocol specific subclasses which describe logical UCI networks defined by <code>config interface</code> sections in <code>/etc/config/network</code>.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Protocol"> + + new LuCI.Network.Protocol<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + network.js, line 1794 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1794">line 1794</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="addDevice"> + + addDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2383 + </div> + + </div> - <h4 class="name" id="addDevice"><span class="type-signature"></span>addDevice<span class="signature">(device)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Add the given network device to the logical interface.</p> + </div> - - -<div class="description"> - <p>Add the given network device to the logical interface.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>device</code></td> - + <td class="type"> @@ -208,162 +1247,148 @@ subclasses which describe logical UCI networks defined by <code>config interface </td> - - - - <td class="description last"><p>The object or device name to add to the logical interface. In case the + + <td class="description last"> + + <p>The object or device name to add to the logical interface. In case the given argument is not a string, it is resolved though the <a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2383">line 2383</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> if the device name has been added or <code>false</code> if any + <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> if the device name has been added or <code>false</code> if any argument was invalid, if the device was already part of the logical -interface or if the logical interface is virtual.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +interface or if the logical interface is virtual.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="containsDevice"> + + containsDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2552 + </div> + + </div> - <h4 class="name" id="containsDevice"><span class="type-signature"></span>containsDevice<span class="signature">(device)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Checks whether this logical interface contains the given device + <div class="description"> + <p>Checks whether this logical interface contains the given device object.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>device</code></td> - + <td class="type"> @@ -384,160 +1409,146 @@ object.</p> </td> - - - - <td class="description last"><p>The object or device name to check. In case the given argument is not + + <td class="description last"> + + <p>The object or device name to check. In case the given argument is not a string, it is resolved though the <a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2552">line 2552</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when this logical interface contains the given network -device or <code>false</code> if not.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="deleteDevice"><span class="type-signature"></span>deleteDevice<span class="signature">(device)</span><span class="type-signature"> → {boolean}</span></h4> - - - - -<div class="description"> - <p>Remove the given network device from the logical interface.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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 this logical interface contains the given network +device or <code>false</code> if not.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="deleteDevice"> + + deleteDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2410 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Remove the given network device from the logical interface.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>device</code></td> - + <td class="type"> @@ -558,161 +1569,147 @@ device or <code>false</code> if not.</p> </td> - - - - <td class="description last"><p>The object or device name to remove from the logical interface. In case + + <td class="description last"> + + <p>The object or device name to remove from the logical interface. In case the given argument is not a string, it is resolved though the <a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2410">line 2410</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the device name has been added or <code>false</code> if any -argument was invalid, if the device was already part of the logical -interface or if the logical interface is virtual.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(opt)</span><span class="type-signature"> → {null|string|Array.<string>}</span></h4> - - - - -<div class="description"> - <p>Read the given UCI option value of this network.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> if the device name has been added or <code>false</code> if any +argument was invalid, if the device was already part of the logical +interface or if the logical interface is virtual.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(opt)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1827 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Read the given UCI option value of this network.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>opt</code></td> - + <td class="type"> @@ -721,577 +1718,528 @@ interface or if the logical interface is virtual.</p> </td> - - - - <td class="description last"><p>The UCI option name to read.</p></td> + + <td class="description last"> + + <p>The UCI option name to read.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1827">line 1827</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the UCI option value or <code>null</code> if the requested option is -not found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> -| - -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + | + + Array.<string> + + + </td> + <td class="description last">Returns the UCI option value or <code>null</code> if the requested option is +not found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDevice"> + + getDevice<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2437 + </div> + + </div> - <h4 class="name" id="getDevice"><span class="type-signature"></span>getDevice<span class="signature">()</span><span class="type-signature"> → {<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Returns the Linux network device associated with this logical + <div class="description"> + <p>Returns the Linux network device associated with this logical interface.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2437">line 2437</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a <code>Network.Device</code> class instance representing the -expected Linux network device according to the configuration.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + + </td> + <td class="description last">Returns a <code>Network.Device</code> class instance representing the +expected Linux network device according to the configuration.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDevices"> + + getDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2498 + </div> + + </div> - <h4 class="name" id="getDevices"><span class="type-signature"></span>getDevices<span class="signature">()</span><span class="type-signature"> → {null|Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Returns a list of network sub-devices associated with this logical + <div class="description"> + <p>Returns a list of network sub-devices associated with this logical interface.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2498">line 2498</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns an array of of <code>Network.Device</code> class instances representing + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>> + + + </td> + <td class="description last">Returns an array of of <code>Network.Device</code> class instances representing the sub-devices attached to this logical interface or <code>null</code> if the logical interface does not support sub-devices, e.g. because it is -virtual and not a bridge.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>></span> - - - </dd> -</dl> - +virtual and not a bridge.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDNS6Addrs"> + + getDNS6Addrs<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"> + network.js, line 2152 + </div> + + </div> - <h4 class="name" id="getDNS6Addrs"><span class="type-signature"></span>getDNS6Addrs<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the IPv6 DNS servers associated with the logical interface.</p> + </div> - - -<div class="description"> - <p>Query the IPv6 DNS servers associated with the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2152">line 2152</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of IPv6 DNS servers registered by the remote -protocol backend.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv6 DNS servers registered by the remote +protocol backend.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDNSAddrs"> + + getDNSAddrs<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"> + network.js, line 2064 + </div> + + </div> - <h4 class="name" id="getDNSAddrs"><span class="type-signature"></span>getDNSAddrs<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the IPv4 DNS servers associated with the logical interface.</p> + </div> - - -<div class="description"> - <p>Query the IPv4 DNS servers associated with the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2064">line 2064</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of IPv4 DNS servers registered by the remote -protocol backend.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv4 DNS servers registered by the remote +protocol backend.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getErrors"> + + getErrors<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"> + network.js, line 2196 + </div> + + </div> - <h4 class="name" id="getErrors"><span class="type-signature"></span>getErrors<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query interface error messages published in <code>ubus</code> runtime state.</p> + <div class="description"> + <p>Query interface error messages published in <code>ubus</code> runtime state.</p> <p>Interface errors are emitted by remote protocol handlers if the setup of the underlying logical interface failed, e.g. due to bad configuration or network connectivity issues.</p> @@ -1300,3328 +2248,3033 @@ messages using the descriptions registered by <a href="LuCI.Network.html#registerErrorCode"><code>Network.registerErrorCode()</code></a> and fall back to <code>"Unknown error (%s)"</code> where <code>%s</code> is replaced by the error code in case no translation can be found.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2196">line 2196</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of translated interface error messages.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of translated interface error messages.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getExpiry"> + + getExpiry<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 1947 + </div> + + </div> - <h4 class="name" id="getExpiry"><span class="type-signature"></span>getExpiry<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the logical interface expiry time in seconds.</p> + <div class="description"> + <p>Get the logical interface expiry time in seconds.</p> <p>For protocols that have a concept of a lease, such as DHCP or DHCPv6, this function returns the remaining time in seconds until the lease expires.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1947">line 1947</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the amount of seconds until the lease expires or <code>-1</code> -if it isn't applicable to the associated protocol.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the amount of seconds until the lease expires or <code>-1</code> +if it isn't applicable to the associated protocol.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getGateway6Addr"> + + getGateway6Addr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2132 + </div> + + </div> - <h4 class="name" id="getGateway6Addr"><span class="type-signature"></span>getGateway6Addr<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query the gateway (nexthop) of the IPv6 default route associated with + <div class="description"> + <p>Query the gateway (nexthop) of the IPv6 default route associated with this logical interface.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2132">line 2132</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a string containing the IPv6 nexthop address of the associated -default route or <code>null</code> if no default route was found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string containing the IPv6 nexthop address of the associated +default route or <code>null</code> if no default route was found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getGatewayAddr"> + + getGatewayAddr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2044 + </div> + + </div> - <h4 class="name" id="getGatewayAddr"><span class="type-signature"></span>getGatewayAddr<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query the gateway (nexthop) of the default route associated with + <div class="description"> + <p>Query the gateway (nexthop) of the default route associated with this logical interface.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2044">line 2044</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a string containing the IPv4 nexthop address of the associated -default route or <code>null</code> if no default route was found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string containing the IPv4 nexthop address of the associated +default route or <code>null</code> if no default route was found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getI18n"> + + <span class="type-signature ">abstract</span>getI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 1892 + </div> + + </div> - <h4 class="name" id="getI18n"><span class="type-signature">(abstract) </span>getI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Return a human readable description for the protcol, such as + <div class="description"> + <p>Return a human readable description for the protcol, such as <code>Static address</code> or <code>DHCP client</code>.</p> <p>This function should be overwritten by subclasses.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1892">line 1892</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the description string.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the description string.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIfname"> + + getIfname<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 1852 + </div> + + </div> - <h4 class="name" id="getIfname"><span class="type-signature"></span>getIfname<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the associared Linux network device of this network.</p> + </div> - - -<div class="description"> - <p>Get the associared Linux network device of this network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1852">line 1852</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the name of the associated network device or <code>null</code> if -it could not be determined.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the name of the associated network device or <code>null</code> if +it could not be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIP6Addr"> + + getIP6Addr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2083 + </div> + + </div> - <h4 class="name" id="getIP6Addr"><span class="type-signature"></span>getIP6Addr<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the first (primary) IPv6 address of the logical interface.</p> + </div> - - -<div class="description"> - <p>Query the first (primary) IPv6 address of the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2083">line 2083</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the primary IPv6 address registered by the protocol handler -in CIDR notation or <code>null</code> if no IPv6 addresses were set.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the primary IPv6 address registered by the protocol handler +in CIDR notation or <code>null</code> if no IPv6 addresses were set.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIP6Addrs"> + + getIP6Addrs<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"> + network.js, line 2105 + </div> + + </div> - <h4 class="name" id="getIP6Addrs"><span class="type-signature"></span>getIP6Addrs<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query all IPv6 addresses of the logical interface.</p> + </div> - - -<div class="description"> - <p>Query all IPv6 addresses of the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2105">line 2105</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns an array of IPv6 addresses in CIDR notation which have been + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv6 addresses in CIDR notation which have been registered by the protocol handler. The order of the resulting array -follows the order of the addresses in <code>ubus</code> runtime information.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - +follows the order of the addresses in <code>ubus</code> runtime information.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIP6Prefix"> + + getIP6Prefix<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2171 + </div> + + </div> - <h4 class="name" id="getIP6Prefix"><span class="type-signature"></span>getIP6Prefix<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the routed IPv6 prefix associated with the logical interface.</p> + </div> - - -<div class="description"> - <p>Query the routed IPv6 prefix associated with the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2171">line 2171</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the routed IPv6 prefix registered by the remote protocol -handler or <code>null</code> if no prefix is present.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the routed IPv6 prefix registered by the remote protocol +handler or <code>null</code> if no prefix is present.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIPAddr"> + + getIPAddr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 1999 + </div> + + </div> - <h4 class="name" id="getIPAddr"><span class="type-signature"></span>getIPAddr<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the first (primary) IPv4 address of the logical interface.</p> + </div> - - -<div class="description"> - <p>Query the first (primary) IPv4 address of the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1999">line 1999</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the primary IPv4 address registered by the protocol handler -or <code>null</code> if no IPv4 addresses were set.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the primary IPv4 address registered by the protocol handler +or <code>null</code> if no IPv4 addresses were set.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIPAddrs"> + + getIPAddrs<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"> + network.js, line 2012 + </div> + + </div> - <h4 class="name" id="getIPAddrs"><span class="type-signature"></span>getIPAddrs<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query all IPv4 addresses of the logical interface.</p> + </div> - - -<div class="description"> - <p>Query all IPv4 addresses of the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2012">line 2012</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns an array of IPv4 addresses in CIDR notation which have been + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv4 addresses in CIDR notation which have been registered by the protocol handler. The order of the resulting array -follows the order of the addresses in <code>ubus</code> runtime information.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - +follows the order of the addresses in <code>ubus</code> runtime information.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getL2Device"> + + getL2Device<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2470 + </div> + + </div> - <h4 class="name" id="getL2Device"><span class="type-signature"></span>getL2Device<span class="signature">()</span><span class="type-signature"> → {<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Returns the layer 2 linux network device currently associated + <div class="description"> + <p>Returns the layer 2 linux network device currently associated with this logical interface.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2470">line 2470</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a <code>Network.Device</code> class instance representing the Linux -network device currently associated with the logical interface.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + + </td> + <td class="description last">Returns a <code>Network.Device</code> class instance representing the Linux +network device currently associated with the logical interface.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getL3Device"> + + getL3Device<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2483 + </div> + + </div> - <h4 class="name" id="getL3Device"><span class="type-signature"></span>getL3Device<span class="signature">()</span><span class="type-signature"> → {<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Returns the layer 3 linux network device currently associated + <div class="description"> + <p>Returns the layer 3 linux network device currently associated with this logical interface.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2483">line 2483</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a <code>Network.Device</code> class instance representing the Linux -network device currently associated with the logical interface.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + + </td> + <td class="description last">Returns a <code>Network.Device</code> class instance representing the Linux +network device currently associated with the logical interface.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMetric"> + + getMetric<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 1967 + </div> + + </div> - <h4 class="name" id="getMetric"><span class="type-signature"></span>getMetric<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the metric value of the logical interface.</p> + </div> - - -<div class="description"> - <p>Get the metric value of the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1967">line 1967</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the current metric value used for device and network -routes spawned by the associated logical interface.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the current metric value used for device and network +routes spawned by the associated logical interface.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getName"> + + getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 1922 + </div> + + </div> - <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the name of the associated logical interface.</p> + </div> - - -<div class="description"> - <p>Get the name of the associated logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1922">line 1922</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the logical interface name, such as <code>lan</code> or <code>wan</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the logical interface name, such as <code>lan</code> or <code>wan</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetmask"> + + getNetmask<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2030 + </div> + + </div> - <h4 class="name" id="getNetmask"><span class="type-signature"></span>getNetmask<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the first (primary) IPv4 netmask of the logical interface.</p> + </div> - - -<div class="description"> - <p>Query the first (primary) IPv4 netmask of the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2030">line 2030</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the netmask of the primary IPv4 address registered by the -protocol handler or <code>null</code> if no IPv4 addresses were set.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the netmask of the primary IPv4 address registered by the +protocol handler or <code>null</code> if no IPv4 addresses were set.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getOpkgPackage"> + + <span class="type-signature ">abstract</span>getOpkgPackage<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2236 + </div> + + </div> - <h4 class="name" id="getOpkgPackage"><span class="type-signature">(abstract) </span>getOpkgPackage<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the name of the opkg package providing the protocol functionality.</p> + <div class="description"> + <p>Get the name of the opkg package providing the protocol functionality.</p> <p>This function should be overwritten by protocol specific subclasses.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2236">line 2236</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the name of the opkg package required for the protocol to -function, e.g. <code>odhcp6c</code> for the <code>dhcpv6</code> prototocol.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the name of the opkg package required for the protocol to +function, e.g. <code>odhcp6c</code> for the <code>dhcpv6</code> prototocol.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getProtocol"> + + <span class="type-signature ">abstract</span>getProtocol<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 1878 + </div> + + </div> - <h4 class="name" id="getProtocol"><span class="type-signature">(abstract) </span>getProtocol<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the name of this network protocol class.</p> + <div class="description"> + <p>Get the name of this network protocol class.</p> <p>This function will be overwritten by subclasses created by <a href="LuCI.Network.html#registerProtocol"><code>Network.registerProtocol()</code></a>.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1878">line 1878</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the name of the network protocol implementation, e.g. -<code>static</code> or <code>dhcp</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the name of the network protocol implementation, e.g. +<code>static</code> or <code>dhcp</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getType"> + + getType<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 1912 + </div> + + </div> - <h4 class="name" id="getType"><span class="type-signature"></span>getType<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the type of the underlying interface.</p> + <div class="description"> + <p>Get the type of the underlying interface.</p> <p>This function actually is a convenience wrapper around <code>proto.get("type")</code> and is mainly used by other <code>LuCI.Network</code> code to check whether the interface is declared as bridge in UCI.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1912">line 1912</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the value of the <code>type</code> option of the associated logical -interface or <code>null</code> if no <code>type</code> option is set.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the value of the <code>type</code> option of the associated logical +interface or <code>null</code> if no <code>type</code> option is set.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getUptime"> + + getUptime<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 1932 + </div> + + </div> - <h4 class="name" id="getUptime"><span class="type-signature"></span>getUptime<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the uptime of the logical interface.</p> + </div> - - -<div class="description"> - <p>Get the uptime of the logical interface.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1932">line 1932</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the uptime of the associated interface in seconds.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the uptime of the associated interface in seconds.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getZoneName"> + + getZoneName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 1983 + </div> + + </div> - <h4 class="name" id="getZoneName"><span class="type-signature"></span>getZoneName<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the requested firewall zone name of the logical interface.</p> + <div class="description"> + <p>Get the requested firewall zone name of the logical interface.</p> <p>Some protocol implementations request a specific firewall zone to trigger inclusion of their resulting network devices into the firewall rule set.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1983">line 1983</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the requested firewall zone name as published in the + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the requested firewall zone name as published in the <code>ubus</code> runtime information or <code>null</code> if the remote protocol -handler didn't request a zone.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - +handler didn't request a zone.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isAlias"> + + isAlias<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 2324 + </div> + + </div> - <h4 class="name" id="isAlias"><span class="type-signature"></span>isAlias<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Checks whether this interface is an alias interface.</p> + <div class="description"> + <p>Checks whether this interface is an alias interface.</p> <p>Alias interfaces are interfaces layering on top of another interface and are denoted by a special <code>@interfacename</code> notation in the underlying <code>ifname</code> option.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2324">line 2324</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the name of the parent interface if this logical interface -is an alias or <code>null</code> if it is not an alias interface.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the name of the parent interface if this logical interface +is an alias or <code>null</code> if it is not an alias interface.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isBridge"> + + isBridge<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2221 + </div> + + </div> - <h4 class="name" id="isBridge"><span class="type-signature"></span>isBridge<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks whether the underlying logical interface is declared as bridge.</p> + </div> - - -<div class="description"> - <p>Checks whether the underlying logical interface is declared as bridge.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2221">line 2221</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> when the interface is declared with <code>option type bridge</code> + <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 interface is declared with <code>option type bridge</code> and when the associated protocol implementation is not marked virtual -or <code>false</code> when the logical interface is no bridge.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +or <code>false</code> when the logical interface is no bridge.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isDynamic"> + + isDynamic<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2309 + </div> + + </div> - <h4 class="name" id="isDynamic"><span class="type-signature"></span>isDynamic<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Checks whether this logical interface is dynamic.</p> + <div class="description"> + <p>Checks whether this logical interface is dynamic.</p> <p>A dynamic interface is an interface which has been created at runtime, e.g. as sub-interface of another interface, but which is not backed by any user configuration. Such dynamic interfaces cannot be edited but only brought down or restarted.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2309">line 2309</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a boolean indicating whether this interface is dynamic (<code>true</code>) -or not (<code>false</code>).</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns a boolean indicating whether this interface is dynamic (<code>true</code>) +or not (<code>false</code>).</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isEmpty"> + + isEmpty<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2344 + </div> + + </div> - <h4 class="name" id="isEmpty"><span class="type-signature"></span>isEmpty<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Checks whether this logical interface is "empty", meaning that ut + <div class="description"> + <p>Checks whether this logical interface is "empty", meaning that ut has no network devices attached.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2344">line 2344</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if this logical interface is empty, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if this logical interface is empty, else <code>false</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isFloating"> + + isFloating<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2293 + </div> + + </div> - <h4 class="name" id="isFloating"><span class="type-signature"></span>isFloating<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Checks whether this protocol is "floating".</p> + <div class="description"> + <p>Checks whether this protocol is "floating".</p> <p>A "floating" protocol is a protocol which spawns its own interfaces on demand, like a virtual one but which relies on an existinf lower level interface to initiate the connection.</p> <p>An example for such a protocol is "pppoe".</p> <p>This function exists for backwards compatibility with older code but should not be used anymore.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2293">line 2293</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a boolean indicating whether this protocol is floating (<code>true</code>) -or not (<code>false</code>).</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns a boolean indicating whether this protocol is floating (<code>true</code>) +or not (<code>false</code>).</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isInstalled"> + + <span class="type-signature ">abstract</span>isInstalled<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2252 + </div> + + </div> - <h4 class="name" id="isInstalled"><span class="type-signature">(abstract) </span>isInstalled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Checks whether the protocol functionality is installed.</p> + <div class="description"> + <p>Checks whether the protocol functionality is installed.</p> <p>This function exists for compatibility with old code, it always returns <code>true</code>.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2252">line 2252</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the protocol support is installed, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if the protocol support is installed, else <code>false</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isUp"> + + isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2366 + </div> + + </div> - <h4 class="name" id="isUp"><span class="type-signature"></span>isUp<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks whether this logical interface is configured and running.</p> + </div> - - -<div class="description"> - <p>Checks whether this logical interface is configured and running.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2366">line 2366</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the interface is active or <code>false</code> when it is not.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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 interface is active or <code>false</code> when it is not.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isVirtual"> + + isVirtual<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 2272 + </div> + + </div> - <h4 class="name" id="isVirtual"><span class="type-signature"></span>isVirtual<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Checks whether this protocol is "virtual".</p> + <div class="description"> + <p>Checks whether this protocol is "virtual".</p> <p>A "virtual" protocol is a protocol which spawns its own interfaces on demand instead of using existing physical interfaces.</p> <p>Examples for virtual protocols are <code>6in4</code> which <code>gre</code> spawn tunnel network device on startup, examples for non-virtual protcols are <code>dhcp</code> or <code>static</code> which apply IP configuration to existing interfaces.</p> <p>This function should be overwritten by subclasses.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2272">line 2272</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a boolean indicating whether the underlying protocol spawns -dynamic interfaces (<code>true</code>) or not (<code>false</code>).</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(opt, val)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Set the given UCI option of this network to the given value.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns a boolean indicating whether the underlying protocol spawns +dynamic interfaces (<code>true</code>) or not (<code>false</code>).</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="set"> + + set<span class="signature">(opt, val)</span> + </h4> + + + <div class="tag-source"> + network.js, line 1841 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Set the given UCI option of this network to the given value.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>opt</code></td> - + <td class="type"> @@ -4630,21 +5283,21 @@ dynamic interfaces (<code>true</code>) or not (<code>false</code>).</p> </td> - - - - <td class="description last"><p>The name of the UCI option to set.</p></td> + + <td class="description last"> + + <p>The name of the UCI option to set.</p></td> </tr> - - - + + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -4659,109 +5312,83 @@ dynamic interfaces (<code>true</code>) or not (<code>false</code>).</p> </td> - - - - <td class="description last"><p>The value to set or <code>null</code> to remove the given option from the + + <td class="description last"> + + <p>The value to set or <code>null</code> to remove the given option from the configuration.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1841">line 1841</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - - - + + + + + + +</dd> + </dl> + + + + </article> -</section> - - +</section> -</div> -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Network.WifiDevice.html b/documentation/jsapi/LuCI.Network.WifiDevice.html index b050c68bc8..89d050e87d 100644 --- a/documentation/jsapi/LuCI.Network.WifiDevice.html +++ b/documentation/jsapi/LuCI.Network.WifiDevice.html @@ -1,197 +1,1234 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: WifiDevice</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: WifiDevice</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: WifiDevice</h1> - +<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#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#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#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#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#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#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#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.Network.WifiDevice.html">Class: WifiDevice</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>WifiDevice</h2> - - <div class="class-description"><p>A <code>Network.WifiDevice</code> class instance represents a wireless radio device + WifiDevice + </h2> + + <div class="class-description"><p>A <code>Network.WifiDevice</code> class instance represents a wireless radio device present on the system and provides wireless capability information as well as methods for enumerating related wireless networks.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="WifiDevice"> + + new LuCI.Network.WifiDevice<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + network.js, line 2957 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2957">line 2957</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="addWifiNetwork"> + + addWifiNetwork<span class="signature">(<span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3222 + </div> + + </div> - <h4 class="name" id="addWifiNetwork"><span class="type-signature"></span>addWifiNetwork<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Adds a new wireless network associated with this radio device to the + <div class="description"> + <p>Adds a new wireless network associated with this radio device to the configuration and sets its options to the provided values.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> @@ -200,170 +1237,153 @@ configuration and sets its options to the provided values.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The options to set for the newly added wireless network.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The options to set for the newly added wireless network.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3222">line 3222</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to a <code>WifiNetwork</code> instance describing + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)> + + + </td> + <td class="description last">Returns a promise resolving to a <code>WifiNetwork</code> instance describing the newly added wireless network or <code>null</code> if the given options -were invalid.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)></span> - - - </dd> -</dl> - +were invalid.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="deleteWifiNetwork"> + + deleteWifiNetwork<span class="signature">(network)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<boolean>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3247 + </div> + + </div> - <h4 class="name" id="deleteWifiNetwork"><span class="type-signature"></span>deleteWifiNetwork<span class="signature">(network)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Deletes the wireless network with the given name associated with this + <div class="description"> + <p>Deletes the wireless network with the given name associated with this radio device.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>network</code></td> - + <td class="type"> @@ -372,163 +1392,149 @@ radio device.</p> </td> - - - - <td class="description last"><p>The name of the wireless network to lookup. This may be either an uci + + <td class="description last"> + + <p>The name of the wireless network to lookup. This may be either an uci configuration section ID, a network ID in the form <code>radio#.network#</code> or a Linux network device name like <code>wlan0</code> which is resolved to the corresponding configuration section through <code>ubus</code> runtime information.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3247">line 3247</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to <code>true</code> when the wireless network was + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<boolean> + + + </td> + <td class="description last">Returns a promise resolving to <code>true</code> when the wireless network was successfully deleted from the configuration or <code>false</code> when the given network could not be found or if the found network was not associated -with this wireless radio device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<boolean></span> - - - </dd> -</dl> - +with this wireless radio device.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(opt)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>}</span> + </h4> + + <div class="tag-source"> + network.js, line 2997 + </div> + + </div> - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(opt)</span><span class="type-signature"> → {null|string|Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Read the given UCI option value of this wireless device.</p> + </div> - - -<div class="description"> - <p>Read the given UCI option value of this wireless device.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>opt</code></td> - + <td class="type"> @@ -537,202 +1543,187 @@ with this wireless radio device.</p> </td> - - - - <td class="description last"><p>The UCI option name to read.</p></td> + + <td class="description last"> + + <p>The UCI option name to read.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line2997">line 2997</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the UCI option value or <code>null</code> if the requested option is -not found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> -| - -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + | + + Array.<string> + + + </td> + <td class="description last">Returns the UCI option value or <code>null</code> if the requested option is +not found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getHTModes"> + + getHTModes<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"> + network.js, line 3075 + </div> + + </div> - <h4 class="name" id="getHTModes"><span class="type-signature"></span>getHTModes<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Gets a list of supported htmodes.</p> + <div class="description"> + <p>Gets a list of supported htmodes.</p> <p>The htmode values describe the wide-frequency options supported by the wireless phy.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3075">line 3075</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns an array of valid htmode values for this radio. Currently -known mode values are:</p> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of valid htmode values for this radio. Currently +known mode values are: <ul> <li><code>HT20</code> - applicable to IEEE 802.11n, 20 MHz wide channels</li> <li><code>HT40</code> - applicable to IEEE 802.11n, 40 MHz wide channels</li> @@ -740,536 +1731,487 @@ known mode values are:</p> <li><code>VHT40</code> - applicable to IEEE 802.11ac, 40 MHz wide channels</li> <li><code>VHT80</code> - applicable to IEEE 802.11ac, 80 MHz wide channels</li> <li><code>VHT160</code> - applicable to IEEE 802.11ac, 160 MHz wide channels</li> -</ul> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - +</ul></td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getHWModes"> + + getHWModes<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"> + network.js, line 3054 + </div> + + </div> - <h4 class="name" id="getHWModes"><span class="type-signature"></span>getHWModes<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Gets a list of supported hwmodes.</p> + <div class="description"> + <p>Gets a list of supported hwmodes.</p> <p>The hwmode values describe the frequency band and wireless standard versions supported by the wireless phy.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3054">line 3054</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns an array of valid hwmode values for this radio. Currently -known mode values are:</p> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of valid hwmode values for this radio. Currently +known mode values are: <ul> <li><code>a</code> - Legacy 802.11a mode, 5 GHz, up to 54 Mbit/s</li> <li><code>b</code> - Legacy 802.11b mode, 2.4 GHz, up to 11 Mbit/s</li> <li><code>g</code> - Legacy 802.11g mode, 2.4 GHz, up to 54 Mbit/s</li> <li><code>n</code> - IEEE 802.11n mode, 2.4 or 5 GHz, up to 600 Mbit/s</li> <li><code>ac</code> - IEEE 802.11ac mode, 5 GHz, up to 6770 Mbit/s</li> -</ul> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - +</ul></td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getI18n"> + + getI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3086 + </div> + + </div> - <h4 class="name" id="getI18n"><span class="type-signature"></span>getI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a string describing the wireless radio hardware.</p> + </div> - - -<div class="description"> - <p>Get a string describing the wireless radio hardware.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3086">line 3086</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the description string.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the description string.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getName"> + + getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3035 + </div> + + </div> - <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configuration name of this wireless radio.</p> + </div> - - -<div class="description"> - <p>Get the configuration name of this wireless radio.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3035">line 3035</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the UCI section name (e.g. <code>radio0</code>) of the corresponding + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the UCI section name (e.g. <code>radio0</code>) of the corresponding radio configuration which also serves as unique logical identifier -for the wireless phy.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +for the wireless phy.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getScanList"> + + getScanList<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.html#.WifiScanResult">LuCI.Network.WifiScanResult</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3147 + </div> + + </div> - <h4 class="name" id="getScanList"><span class="type-signature"></span>getScanList<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.Network.html#.WifiScanResult">LuCI.Network.WifiScanResult</a>>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Trigger a wireless scan on this radio device and obtain a list of + <div class="description"> + <p>Trigger a wireless scan on this radio device and obtain a list of nearby networks.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3147">line 3147</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an array of scan result objects -describing the networks found in the vincinity.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.html#.WifiScanResult">LuCI.Network.WifiScanResult</a>>></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getWifiNetwork"><span class="type-signature"></span>getWifiNetwork<span class="signature">(network)</span><span class="type-signature"> → {Promise.<<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>>}</span></h4> - - - - -<div class="description"> - <p>Get the wifi network of the given name belonging to this radio device</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.html#.WifiScanResult">LuCI.Network.WifiScanResult</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an array of scan result objects +describing the networks found in the vincinity.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiNetwork"> + + getWifiNetwork<span class="signature">(network)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 3180 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Get the wifi network of the given name belonging to this radio device</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>network</code></td> - + <td class="type"> @@ -1278,498 +2220,454 @@ describing the networks found in the vincinity.</p> </td> - - - - <td class="description last"><p>The name of the wireless network to lookup. This may be either an uci + + <td class="description last"> + + <p>The name of the wireless network to lookup. This may be either an uci configuration section ID, a network ID in the form <code>radio#.network#</code> or a Linux network device name like <code>wlan0</code> which is resolved to the corresponding configuration section through <code>ubus</code> runtime information.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3180">line 3180</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to a <code>Network.WifiNetwork</code> instance + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>> + + + </td> + <td class="description last">Returns a promise resolving to a <code>Network.WifiNetwork</code> instance representing the wireless network and rejecting with <code>null</code> if the given network could not be found or is not associated with -this radio device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>></span> - - - </dd> -</dl> - +this radio device.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiNetworks"> + + getWifiNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3199 + </div> + + </div> - <h4 class="name" id="getWifiNetworks"><span class="type-signature"></span>getWifiNetworks<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get all wireless networks associated with this wireless radio device.</p> + </div> - - -<div class="description"> - <p>Get all wireless networks associated with this wireless radio device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3199">line 3199</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to an array of <code>Network.WifiNetwork</code> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an array of <code>Network.WifiNetwork</code> instances respresenting the wireless networks associated with this -radio device.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>>></span> - - - </dd> -</dl> - +radio device.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isDisabled"> + + isDisabled<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 3023 + </div> + + </div> - <h4 class="name" id="isDisabled"><span class="type-signature"></span>isDisabled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks whether this wireless radio is disabled.</p> + </div> - - -<div class="description"> - <p>Checks whether this wireless radio is disabled.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3023">line 3023</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> when the wireless radio is marked as disabled in <code>ubus</code> + <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 wireless radio is marked as disabled in <code>ubus</code> runtime state or when the <code>disabled</code> option is set in the corresponding -UCI configuration.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +UCI configuration.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isUp"> + + isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 3158 + </div> + + </div> - <h4 class="name" id="isUp"><span class="type-signature"></span>isUp<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Check whether the wireless radio is marked as up in the <code>ubus</code> + <div class="description"> + <p>Check whether the wireless radio is marked as up in the <code>ubus</code> runtime state.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3158">line 3158</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the radio device is up, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(opt, val)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Set the given UCI option of this network to the given value.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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 radio device is up, else <code>false</code>.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="set"> + + set<span class="signature">(opt, val)</span> + </h4> + + + <div class="tag-source"> + network.js, line 3011 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Set the given UCI option of this network to the given value.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>opt</code></td> - + <td class="type"> @@ -1778,21 +2676,21 @@ runtime state.</p> </td> - - - - <td class="description last"><p>The name of the UCI option to set.</p></td> + + <td class="description last"> + + <p>The name of the UCI option to set.</p></td> </tr> - - - + + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -1807,109 +2705,83 @@ runtime state.</p> </td> - - - - <td class="description last"><p>The value to set or <code>null</code> to remove the given option from the + + <td class="description last"> + + <p>The value to set or <code>null</code> to remove the given option from the configuration.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3011">line 3011</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - - - + + + + + + +</dd> + </dl> + + + + </article> -</section> - +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Network.WifiNetwork.html b/documentation/jsapi/LuCI.Network.WifiNetwork.html index 62e43aa5ec..20ba7447a6 100644 --- a/documentation/jsapi/LuCI.Network.WifiNetwork.html +++ b/documentation/jsapi/LuCI.Network.WifiNetwork.html @@ -1,195 +1,1234 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: WifiNetwork</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: WifiNetwork</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: WifiNetwork</h1> - +<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#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#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#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#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#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#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#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.Network.WifiNetwork.html">Class: WifiNetwork</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>WifiNetwork</h2> - - <div class="class-description"><p>A <code>Network.WifiNetwork</code> instance represents a wireless network (vif) + WifiNetwork + </h2> + + <div class="class-description"><p>A <code>Network.WifiNetwork</code> instance represents a wireless network (vif) configured on top of a radio device and provides functions for querying the runtime state of the network. Most radio devices support multiple such networks in parallel.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="WifiNetwork"> + + new LuCI.Network.WifiNetwork<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + network.js, line 3280 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3280">line 3280</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(opt)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3313 + </div> + + </div> - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(opt)</span><span class="type-signature"> → {null|string|Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Read the given UCI option value of this wireless network.</p> + </div> - - -<div class="description"> - <p>Read the given UCI option value of this wireless network.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>opt</code></td> - + <td class="type"> @@ -198,422 +1237,387 @@ such networks in parallel.</p></div> </td> - - - - <td class="description last"><p>The UCI option name to read.</p></td> + + <td class="description last"> + + <p>The UCI option name to read.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3313">line 3313</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the UCI option value or <code>null</code> if the requested option is -not found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> -| - -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + | + + Array.<string> + + + </td> + <td class="description last">Returns the UCI option value or <code>null</code> if the requested option is +not found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveBSSID"> + + getActiveBSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3566 + </div> + + </div> - <h4 class="name" id="getActiveBSSID"><span class="type-signature"></span>getActiveBSSID<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current BSSID from runtime information.</p> + </div> - - -<div class="description"> - <p>Query the current BSSID from runtime information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3566">line 3566</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the current BSSID or Mesh ID as reported by <code>ubus</code> runtime -information.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the current BSSID or Mesh ID as reported by <code>ubus</code> runtime +information.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveEncryption"> + + getActiveEncryption<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3577 + </div> + + </div> - <h4 class="name" id="getActiveEncryption"><span class="type-signature"></span>getActiveEncryption<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current encryption settings from runtime information.</p> + </div> - - -<div class="description"> - <p>Query the current encryption settings from runtime information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3577">line 3577</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a string describing the current encryption or <code>-</code> if the the -encryption state could not be found in <code>ubus</code> runtime information.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string describing the current encryption or <code>-</code> if the the +encryption state could not be found in <code>ubus</code> runtime information.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveMode"> + + getActiveMode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3514 + </div> + + </div> - <h4 class="name" id="getActiveMode"><span class="type-signature"></span>getActiveMode<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current operation mode from runtime information.</p> + </div> - - -<div class="description"> - <p>Query the current operation mode from runtime information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3514">line 3514</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the human readable mode name as reported by <code>ubus</code> runtime -state. Possible returned values are:</p> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the human readable mode name as reported by <code>ubus</code> runtime +state. Possible returned values are: <ul> <li><code>Master</code></li> <li><code>Ad-Hoc</code></li> @@ -625,3475 +1629,3166 @@ state. Possible returned values are:</p> <li><code>P2P Client</code></li> <li><code>P2P Go</code></li> <li><code>Unknown</code></li> -</ul> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +</ul></td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveModeI18n"> + + getActiveModeI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3535 + </div> + + </div> - <h4 class="name" id="getActiveModeI18n"><span class="type-signature"></span>getActiveModeI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query the current operation mode from runtime information as + <div class="description"> + <p>Query the current operation mode from runtime information as translated string.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3535">line 3535</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the translated, human readable mode name as reported by -<code>ubus</code> runtime state.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the translated, human readable mode name as reported by +<code>ubus</code> runtime state.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveSSID"> + + getActiveSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3555 + </div> + + </div> - <h4 class="name" id="getActiveSSID"><span class="type-signature"></span>getActiveSSID<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current SSID from runtime information.</p> + </div> - - -<div class="description"> - <p>Query the current SSID from runtime information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3555">line 3555</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the current SSID or Mesh ID as reported by <code>ubus</code> runtime -information.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the current SSID or Mesh ID as reported by <code>ubus</code> runtime +information.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getAssocList"> + + getAssocList<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3757 + </div> + + </div> - <h4 class="name" id="getAssocList"><span class="type-signature"></span>getAssocList<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Fetch the list of associated peers.</p> + </div> - - -<div class="description"> - <p>Fetch the list of associated peers.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3757">line 3757</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an array of wireless peers associated -with this network.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an array of wireless peers associated +with this network.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getBitRate"> + + getBitRate<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3787 + </div> + + </div> - <h4 class="name" id="getBitRate"><span class="type-signature"></span>getBitRate<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query the current average bitrate of all peers associated to this + <div class="description"> + <p>Query the current average bitrate of all peers associated to this wireless network.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3787">line 3787</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the average bit rate among all peers associated to the network + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">Returns the average bit rate among all peers associated to the network as reported by <code>ubus</code> runtime information or <code>null</code> if the information -is not available.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> -</dl> - +is not available.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getBSSID"> + + getBSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3392 + </div> + + </div> - <h4 class="name" id="getBSSID"><span class="type-signature"></span>getBSSID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configured BSSID of the wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configured BSSID of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3392">line 3392</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the BSSID value or <code>null</code> if none has been specified.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the BSSID value or <code>null</code> if none has been specified.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getChannel"> + + getChannel<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3803 + </div> + + </div> - <h4 class="name" id="getChannel"><span class="type-signature"></span>getChannel<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current wireless channel.</p> + </div> - - -<div class="description"> - <p>Query the current wireless channel.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3803">line 3803</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the wireless channel as reported by <code>ubus</code> runtime information -or <code>null</code> if it cannot be determined.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">Returns the wireless channel as reported by <code>ubus</code> runtime information +or <code>null</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getCountryCode"> + + getCountryCode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3836 + </div> + + </div> - <h4 class="name" id="getCountryCode"><span class="type-signature"></span>getCountryCode<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current country code.</p> + </div> - - -<div class="description"> - <p>Query the current country code.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3836">line 3836</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the wireless country code as reported by <code>ubus</code> runtime -information or <code>00</code> if it cannot be determined.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the wireless country code as reported by <code>ubus</code> runtime +information or <code>00</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDevice"> + + getDevice<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3982 + </div> + + </div> - <h4 class="name" id="getDevice"><span class="type-signature"></span>getDevice<span class="signature">()</span><span class="type-signature"> → {<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the associated Linux network device.</p> + </div> - - -<div class="description"> - <p>Get the associated Linux network device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3982">line 3982</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a <code>Network.Device</code> instance representing the Linux network -device associted with this wireless network.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + + </td> + <td class="description last">Returns a <code>Network.Device</code> instance representing the Linux network +device associted with this wireless network.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getFrequency"> + + getFrequency<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3769 + </div> + + </div> - <h4 class="name" id="getFrequency"><span class="type-signature"></span>getFrequency<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current operating frequency of the wireless network.</p> + </div> - - -<div class="description"> - <p>Query the current operating frequency of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3769">line 3769</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the current operating frequency of the network from <code>ubus</code> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the current operating frequency of the network from <code>ubus</code> runtime information in GHz or <code>null</code> if the information is not -available.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - +available.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getI18n"> + + getI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3930 + </div> + + </div> - <h4 class="name" id="getI18n"><span class="type-signature"></span>getI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a description string for this wireless network.</p> + </div> - - -<div class="description"> - <p>Get a description string for this wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3930">line 3930</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a string describing this network, consisting of the + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string describing this network, consisting of the term <code>Wireless Network</code>, followed by the active operation mode, the SSID, BSSID or internal network ID and the Linux network device -name, depending on which information is available.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +name, depending on which information is available.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getID"> + + getID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3417 + </div> + + </div> - <h4 class="name" id="getID"><span class="type-signature"></span>getID<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the internal network ID of this wireless network.</p> + <div class="description"> + <p>Get the internal network ID of this wireless network.</p> <p>The network ID is a LuCI specific identifer in the form <code>radio#.network#</code> to identify wireless networks by their corresponding radio and network index numbers.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3417">line 3417</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the LuCI specific network ID.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the LuCI specific network ID.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIfname"> + + getIfname<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3439 + </div> + + </div> - <h4 class="name" id="getIfname"><span class="type-signature"></span>getIfname<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the Linux network device name.</p> + </div> - - -<div class="description"> - <p>Get the Linux network device name.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3439">line 3439</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the current Linux network device name as resolved from + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the current Linux network device name as resolved from <code>ubus</code> runtime information or <code>null</code> if this network has no -associated network device, e.g. when not configured or up.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - +associated network device, e.g. when not configured or up.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMeshID"> + + getMeshID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3379 + </div> + + </div> - <h4 class="name" id="getMeshID"><span class="type-signature"></span>getMeshID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configured Mesh ID of the wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configured Mesh ID of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3379">line 3379</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the configured mesh ID value or <code>null</code> when this network -is not in mesh mode.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the configured mesh ID value or <code>null</code> when this network +is not in mesh mode.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMode"> + + getMode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3354 + </div> + + </div> - <h4 class="name" id="getMode"><span class="type-signature"></span>getMode<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configured operation mode of the wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configured operation mode of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3354">line 3354</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the configured operation mode. Possible values are:</p> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the configured operation mode. Possible values are: <ul> <li><code>ap</code> - Master (Access Point) mode</li> <li><code>sta</code> - Station (client) mode</li> <li><code>adhoc</code> - Ad-Hoc (IBSS) mode</li> <li><code>mesh</code> - Mesh (IEEE 802.11s) mode</li> <li><code>monitor</code> - Monitor mode</li> -</ul> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +</ul></td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getName"> + + getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3427 + </div> + + </div> - <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configuration ID of this wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configuration ID of this wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3427">line 3427</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the corresponding UCI section ID of the network.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the corresponding UCI section ID of the network.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetwork"> + + getNetwork<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3946 + </div> + + </div> - <h4 class="name" id="getNetwork"><span class="type-signature"></span>getNetwork<span class="signature">()</span><span class="type-signature"> → {null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the primary logical interface this wireless network is attached to.</p> + </div> - - -<div class="description"> - <p>Get the primary logical interface this wireless network is attached to.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3946">line 3946</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a <code>Network.Protocol</code> instance representing the logical + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> + + + </td> + <td class="description last">Returns a <code>Network.Protocol</code> instance representing the logical interface or <code>null</code> if this network is not attached to any logical -interface.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> - - - </dd> -</dl> - +interface.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetworkNames"> + + getNetworkNames<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"> + network.js, line 3403 + </div> + + </div> - <h4 class="name" id="getNetworkNames"><span class="type-signature"></span>getNetworkNames<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the names of the logical interfaces this wireless network is + <div class="description"> + <p>Get the names of the logical interfaces this wireless network is attached to.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3403">line 3403</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of logical interface names.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of logical interface names.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetworks"> + + getNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3957 + </div> + + </div> - <h4 class="name" id="getNetworks"><span class="type-signature"></span>getNetworks<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the logical interfaces this wireless network is attached to.</p> + </div> - - -<div class="description"> - <p>Get the logical interfaces this wireless network is attached to.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3957">line 3957</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of <code>Network.Protocol</code> instances representing the -logical interfaces this wireless network is attached to.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>> + + + </td> + <td class="description last">Returns an array of <code>Network.Protocol</code> instances representing the +logical interfaces this wireless network is attached to.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNoise"> + + getNoise<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3825 + </div> + + </div> - <h4 class="name" id="getNoise"><span class="type-signature"></span>getNoise<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current radio noise floor.</p> + </div> - - -<div class="description"> - <p>Query the current radio noise floor.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3825">line 3825</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the radio noise floor in dBm as reported by <code>ubus</code> runtime -information or <code>0</code> if it cannot be determined.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the radio noise floor in dBm as reported by <code>ubus</code> runtime +information or <code>0</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getShortName"> + + getShortName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3915 + </div> + + </div> - <h4 class="name" id="getShortName"><span class="type-signature"></span>getShortName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a short description string for this wireless network.</p> + </div> - - -<div class="description"> - <p>Get a short description string for this wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3915">line 3915</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a string describing this network, consisting of the + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string describing this network, consisting of the active operation mode, followed by either the SSID, BSSID or -internal network ID, depending on which information is available.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +internal network ID, depending on which information is available.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSignal"> + + getSignal<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3814 + </div> + + </div> - <h4 class="name" id="getSignal"><span class="type-signature"></span>getSignal<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current wireless signal.</p> + </div> - - -<div class="description"> - <p>Query the current wireless signal.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3814">line 3814</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the wireless signal in dBm as reported by <code>ubus</code> runtime -information or <code>null</code> if it cannot be determined.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">Returns the wireless signal in dBm as reported by <code>ubus</code> runtime +information or <code>null</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSignalLevel"> + + getSignalLevel<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3874 + </div> + + </div> - <h4 class="name" id="getSignalLevel"><span class="type-signature"></span>getSignalLevel<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Calculate the current signal.</p> + </div> - - -<div class="description"> - <p>Calculate the current signal.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3874">line 3874</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the calculated signal level, which is the difference between -noise and signal (SNR), divided by 5.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the calculated signal level, which is the difference between +noise and signal (SNR), divided by 5.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSignalPercent"> + + getSignalPercent<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3897 + </div> + + </div> - <h4 class="name" id="getSignalPercent"><span class="type-signature"></span>getSignalPercent<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Calculate the current signal quality percentage.</p> + </div> - - -<div class="description"> - <p>Calculate the current signal quality percentage.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3897">line 3897</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the calculated signal quality in percent. The value is + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the calculated signal quality in percent. The value is calculated from the <code>quality</code> and <code>quality_max</code> indicators reported -by <code>ubus</code> runtime state.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">number</span> - - - </dd> -</dl> - +by <code>ubus</code> runtime state.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSSID"> + + getSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3365 + </div> + + </div> - <h4 class="name" id="getSSID"><span class="type-signature"></span>getSSID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configured SSID of the wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configured SSID of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3365">line 3365</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the configured SSID value or <code>null</code> when this network is -in mesh mode.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the configured SSID value or <code>null</code> when this network is +in mesh mode.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getTXPower"> + + getTXPower<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3847 + </div> + + </div> - <h4 class="name" id="getTXPower"><span class="type-signature"></span>getTXPower<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current radio TX power.</p> + </div> - - -<div class="description"> - <p>Query the current radio TX power.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3847">line 3847</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the wireless network transmit power in dBm as reported by -<code>ubus</code> runtime information or <code>null</code> if it cannot be determined.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">Returns the wireless network transmit power in dBm as reported by +<code>ubus</code> runtime information or <code>null</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getTXPowerOffset"> + + getTXPowerOffset<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3862 + </div> + + </div> - <h4 class="name" id="getTXPowerOffset"><span class="type-signature"></span>getTXPowerOffset<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query the radio TX power offset.</p> + <div class="description"> + <p>Query the radio TX power offset.</p> <p>Some wireless radios have a fixed power offset, e.g. due to the use of external amplifiers.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3862">line 3862</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the wireless network transmit power offset in dBm as reported + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the wireless network transmit power offset in dBm as reported by <code>ubus</code> runtime information or <code>0</code> if there is no offset, or if it -cannot be determined.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">number</span> - - - </dd> -</dl> - +cannot be determined.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiDevice"> + + getWifiDevice<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3467 + </div> + + </div> - <h4 class="name" id="getWifiDevice"><span class="type-signature"></span>getWifiDevice<span class="signature">()</span><span class="type-signature"> → {null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the corresponding wifi radio device.</p> + </div> - - -<div class="description"> - <p>Get the corresponding wifi radio device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3467">line 3467</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a <code>Network.WifiDevice</code> instance representing the corresponding + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a> + + + </td> + <td class="description last">Returns a <code>Network.WifiDevice</code> instance representing the corresponding wifi radio device or <code>null</code> if the related radio device could not be -found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span> - - - </dd> -</dl> - +found.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiDeviceName"> + + getWifiDeviceName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3455 + </div> + + </div> - <h4 class="name" id="getWifiDeviceName"><span class="type-signature"></span>getWifiDeviceName<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the name of the corresponding wifi radio device.</p> + </div> - - -<div class="description"> - <p>Get the name of the corresponding wifi radio device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3455">line 3455</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the name of the radio device this network is configured on -or <code>null</code> if it cannot be determined.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the name of the radio device this network is configured on +or <code>null</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isDisabled"> + + isDisabled<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 3339 + </div> + + </div> - <h4 class="name" id="isDisabled"><span class="type-signature"></span>isDisabled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks whether this wireless network is disabled.</p> + </div> - - -<div class="description"> - <p>Checks whether this wireless network is disabled.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3339">line 3339</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> when the wireless radio is marked as disabled in <code>ubus</code> + <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 wireless radio is marked as disabled in <code>ubus</code> runtime state or when the <code>disabled</code> option is set in the corresponding -UCI configuration.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +UCI configuration.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isUp"> + + isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 3488 + </div> + + </div> - <h4 class="name" id="isUp"><span class="type-signature"></span>isUp<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Check whether the radio network is up.</p> + <div class="description"> + <p>Check whether the radio network is up.</p> <p>This function actually queries the up state of the related radio device and assumes this network to be up as well when the parent radio is up. This is due to the fact that OpenWrt does not control virtual interfaces individually but within one common hostapd instance.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3488">line 3488</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the network is up, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(opt, val)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Set the given UCI option of this network to the given value.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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 network is up, else <code>false</code>.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="set"> + + set<span class="signature">(opt, val)</span> + </h4> + + + <div class="tag-source"> + network.js, line 3327 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Set the given UCI option of this network to the given value.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>opt</code></td> - + <td class="type"> @@ -4102,21 +4797,21 @@ instance.</p> </td> - - - - <td class="description last"><p>The name of the UCI option to set.</p></td> + + <td class="description last"> + + <p>The name of the UCI option to set.</p></td> </tr> - - - + + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -4131,109 +4826,83 @@ instance.</p> </td> - - - - <td class="description last"><p>The value to set or <code>null</code> to remove the given option from the + + <td class="description last"> + + <p>The value to set or <code>null</code> to remove the given option from the configuration.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3327">line 3327</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - - - + + + + + + +</dd> + </dl> + + + + </article> -</section> - - +</section> -</div> -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Network.html b/documentation/jsapi/LuCI.Network.html index d0ab9f2c95..5b4d1e81b1 100644 --- a/documentation/jsapi/LuCI.Network.html +++ b/documentation/jsapi/LuCI.Network.html @@ -1,132 +1,1172 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Network</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Network</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Network</h1> - +<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#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#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#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#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#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#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#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.Network.html">Class: Network</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>Network</h2> - - <div class="class-description"><p>The <code>LuCI.Network</code> class combines data from multiple <code>ubus</code> apis to + Network + </h2> + + <div class="class-description"><p>The <code>LuCI.Network</code> class combines data from multiple <code>ubus</code> apis to provide an abstraction of the current network configuration state.</p> <p>It provides methods to enumerate interfaces and devices, to query current configuration details and to manipulate settings.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Network"> + + new LuCI.Network<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + network.js, line 628 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line628">line 628</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - + + + + + <h3 class="subsection-title">Classes</h3> - + <dl> <dt><a href="LuCI.Network.Device.html">Device</a></dt> <dd></dd> @@ -144,76 +1184,73 @@ current configuration details and to manipulate settings.</p></div> <dd></dd> </dl> - - - - - + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="addNetwork"> + + addNetwork<span class="signature">(name, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>}</span> + </h4> + + <div class="tag-source"> + network.js, line 884 + </div> + + </div> - <h4 class="name" id="addNetwork"><span class="type-signature"></span>addNetwork<span class="signature">(name, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Adds a new network of the given name and update it with the given + <div class="description"> + <p>Adds a new network of the given name and update it with the given uci option values.</p> <p>If a network with the given name already exist but is empty, then this function will update its option, otherwise it will do nothing.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -222,29 +1259,26 @@ this function will update its option, otherwise it will do nothing.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the network to add. Must be in the format <code>[a-zA-Z0-9_]+</code>.</p></td> + <td class="description last"> + + + + + + + <p>The name of the network to add. Must be in the format <code>[a-zA-Z0-9_]+</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> @@ -253,172 +1287,155 @@ this function will update its option, otherwise it will do nothing.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An object of uci option values to set on the new network or to + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An object of uci option values to set on the new network or to update in an existing, empty network.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line884">line 884</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to the <code>Protocol</code> subclass instance + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)> + + + </td> + <td class="description last">Returns a promise resolving to the <code>Protocol</code> subclass instance describing the added network or resolving to <code>null</code> if the name was invalid or if a non-empty network of the given name already -existed.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)></span> - - - </dd> -</dl> - +existed.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="addWifiNetwork"> + + addWifiNetwork<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1352 + </div> + + </div> - <h4 class="name" id="addWifiNetwork"><span class="type-signature"></span>addWifiNetwork<span class="signature">(options)</span><span class="type-signature"> → {Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Adds a new wireless network to the configuration and sets its options + <div class="description"> + <p>Adds a new wireless network to the configuration and sets its options to the provided values.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> @@ -427,162 +1444,148 @@ to the provided values.</p> </td> - - - - <td class="description last"><p>The options to set for the newly added wireless network. This object + + <td class="description last"> + + <p>The options to set for the newly added wireless network. This object must at least contain a <code>device</code> property which is set to the radio name the new network belongs to.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1352">line 1352</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to a <code>WifiNetwork</code> instance describing + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)> + + + </td> + <td class="description last">Returns a promise resolving to a <code>WifiNetwork</code> instance describing the newly added wireless network or <code>null</code> if the given options -were invalid or if the associated radio device could not be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)></span> - - - </dd> -</dl> - +were invalid or if the associated radio device could not be found.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="deleteNetwork"> + + deleteNetwork<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<boolean>}</span> + </h4> + + <div class="tag-source"> + network.js, line 962 + </div> + + </div> - <h4 class="name" id="deleteNetwork"><span class="type-signature"></span>deleteNetwork<span class="signature">(name)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Deletes the given network and its references from the network and + <div class="description"> + <p>Deletes the given network and its references from the network and firewall configuration.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -591,159 +1594,145 @@ firewall configuration.</p> </td> - - - - <td class="description last"><p>The name of the network to delete.</p></td> + + <td class="description last"> + + <p>The name of the network to delete.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line962">line 962</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to either <code>true</code> if the network and -references to it were successfully deleted from the configuration or -<code>false</code> if the given network could not be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<boolean></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="deleteWifiNetwork"><span class="type-signature"></span>deleteWifiNetwork<span class="signature">(netname)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> - - - - -<div class="description"> - <p>Deletes the given wireless network from the configuration.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<boolean> + + + </td> + <td class="description last">Returns a promise resolving to either <code>true</code> if the network and +references to it were successfully deleted from the configuration or +<code>false</code> if the given network could not be found.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="deleteWifiNetwork"> + + deleteWifiNetwork<span class="signature">(netname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<boolean>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1390 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Deletes the given wireless network from the configuration.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>netname</code></td> - + <td class="type"> @@ -752,275 +1741,251 @@ references to it were successfully deleted from the configuration or </td> - - - - <td class="description last"><p>The name of the network to remove. This may be either a + + <td class="description last"> + + <p>The name of the network to remove. This may be either a network ID in the form <code>radio#.network#</code> or a Linux network device name like <code>wlan0</code> which is resolved to the corresponding configuration section through <code>ubus</code> runtime information.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1390">line 1390</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to <code>true</code> if the wireless network has been + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<boolean> + + + </td> + <td class="description last">Returns a promise resolving to <code>true</code> if the wireless network has been successfully deleted from the configuration or <code>false</code> if it could not -be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<boolean></span> - - - </dd> -</dl> - +be found.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="flushCache"> + + flushCache<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Object>}</span> + </h4> + + <div class="tag-source"> + network.js, line 728 + </div> + + </div> - <h4 class="name" id="flushCache"><span class="type-signature"></span>flushCache<span class="signature">()</span><span class="type-signature"> → {Promise.<Object>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Flushes the local network state cache and fetches updated information + <div class="description"> + <p>Flushes the local network state cache and fetches updated information from the remote <code>ubus</code> apis.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line728">line 728</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to the internal network state object.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<Object></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<Object> + + + </td> + <td class="description last">Returns a promise resolving to the internal network state object.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="formatWifiEncryption"> + + formatWifiEncryption<span class="signature">(encryption)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 719 + </div> + + </div> - <h4 class="name" id="formatWifiEncryption"><span class="type-signature"></span>formatWifiEncryption<span class="signature">(encryption)</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Converts a given <a href="LuCI.Network.html#.WifiEncryption"><code>encryption entry</code></a> + <div class="description"> + <p>Converts a given <a href="LuCI.Network.html#.WifiEncryption"><code>encryption entry</code></a> into a human readable string such as <code>mixed WPA/WPA2 PSK (TKIP, CCMP)</code> or <code>WPA3 SAE (CCMP)</code>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>encryption</code></td> - + <td class="type"> @@ -1029,162 +1994,148 @@ or <code>WPA3 SAE (CCMP)</code>.</p> </td> - - - - <td class="description last"><p>The wireless encryption entry to convert.</p></td> + + <td class="description last"> + + <p>The wireless encryption entry to convert.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line719">line 719</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the description string for the given encryption entry or -<code>null</code> if the given entry was invalid.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getDevice"><span class="type-signature"></span>getDevice<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(null|<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>)>}</span></h4> - - - - -<div class="description"> - <p>Get a <a href="LuCI.Network.Device.html"><code>Device</code></a> instance describing the -given network device.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the description string for the given encryption entry or +<code>null</code> if the given entry was invalid.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDevice"> + + getDevice<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>)>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1087 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Get a <a href="LuCI.Network.Device.html"><code>Device</code></a> instance describing the +given network device.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -1193,495 +2144,451 @@ given network device.</p> </td> - - - - <td class="description last"><p>The name of the network device to get, e.g. <code>eth0</code> or <code>br-lan</code>.</p></td> + + <td class="description last"> + + <p>The name of the network device to get, e.g. <code>eth0</code> or <code>br-lan</code>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1087">line 1087</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to the <code>Device</code> instance describing + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<(null|<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>)> + + + </td> + <td class="description last">Returns a promise resolving to the <code>Device</code> instance describing the network device or <code>null</code> if the given device name could not -be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<(null|<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>)></span> - - - </dd> -</dl> - +be found.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDevices"> + + getDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1110 + </div> + + </div> - <h4 class="name" id="getDevices"><span class="type-signature"></span>getDevices<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a sorted list of all found network devices.</p> + </div> - - -<div class="description"> - <p>Get a sorted list of all found network devices.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1110">line 1110</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to a sorted array of <code>Device</code> class -instances describing the network devices found on the system.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>> + + + </td> + <td class="description last">Returns a promise resolving to a sorted array of <code>Device</code> class +instances describing the network devices found on the system.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDSLModemType"> + + getDSLModemType<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|string)>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1594 + </div> + + </div> - <h4 class="name" id="getDSLModemType"><span class="type-signature"></span>getDSLModemType<span class="signature">()</span><span class="type-signature"> → {Promise.<(null|string)>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Queries the internal DSL modem type from board information.</p> + </div> - - -<div class="description"> - <p>Queries the internal DSL modem type from board information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1594">line 1594</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to the type of the internal modem -(e.g. <code>vdsl</code>) or to <code>null</code> if no internal modem is present.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<(null|string)></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<(null|string)> + + + </td> + <td class="description last">Returns a promise resolving to the type of the internal modem +(e.g. <code>vdsl</code>) or to <code>null</code> if no internal modem is present.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getHostHints"> + + getHostHints<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1611 + </div> + + </div> - <h4 class="name" id="getHostHints"><span class="type-signature"></span>getHostHints<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Queries aggregated information about known hosts.</p> + <div class="description"> + <p>Queries aggregated information about known hosts.</p> <p>This function aggregates information from various sources such as DHCP lease databases, ARP and IPv6 neighbour entries, wireless association list etc. and returns a <a href="LuCI.Network.Hosts.html"><code>Hosts</code></a> class instance describing the found hosts.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1611">line 1611</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a <code>Hosts</code> instance describing host known on the system.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<<a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getIfnameOf"><span class="type-signature"></span>getIfnameOf<span class="signature">(obj)</span><span class="type-signature"> → {null|string}</span></h4> - - - - -<div class="description"> - <p>Obtains the the network device name of the given object.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<<a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>> + + + </td> + <td class="description last">Returns a <code>Hosts</code> instance describing host known on the system.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIfnameOf"> + + getIfnameOf<span class="signature">(obj)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1583 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Obtains the the network device name of the given object.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>obj</code></td> - + <td class="type"> @@ -1702,162 +2609,148 @@ class instance describing the found hosts.</p> </td> - - - - <td class="description last"><p>The object to get the device name from.</p></td> + + <td class="description last"> + + <p>The object to get the device name from.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1583">line 1583</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a string containing the device name or <code>null</code> if the given -object could not be converted to a name.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getNetwork"><span class="type-signature"></span>getNetwork<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>}</span></h4> - - - - -<div class="description"> - <p>Get a <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> instance describing -the network with the given name.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns a string containing the device name or <code>null</code> if the given +object could not be converted to a name.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetwork"> + + getNetwork<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 921 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Get a <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> instance describing +the network with the given name.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -1866,276 +2759,250 @@ the network with the given name.</p> </td> - - - - <td class="description last"><p>The logical interface name of the network get, e.g. <code>lan</code> or <code>wan</code>.</p></td> + + <td class="description last"> + + <p>The logical interface name of the network get, e.g. <code>lan</code> or <code>wan</code>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line921">line 921</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to a + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)> + + + </td> + <td class="description last">Returns a promise resolving to a <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass instance describing -the network or <code>null</code> if the network did not exist.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)></span> - - - </dd> -</dl> - +the network or <code>null</code> if the network did not exist.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetworks"> + + getNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 946 + </div> + + </div> - <h4 class="name" id="getNetworks"><span class="type-signature"></span>getNetworks<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Gets an array containing all known networks.</p> + </div> - - -<div class="description"> - <p>Gets an array containing all known networks.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line946">line 946</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to a name-sorted array of -<a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass instances -describing all known networks.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getProtocol"><span class="type-signature"></span>getProtocol<span class="signature">(protoname, netname<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span></h4> - - - - -<div class="description"> - <p>Instantiates the given <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> backend, -optionally using the given network name.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>> + + + </td> + <td class="description last">Returns a promise resolving to a name-sorted array of +<a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass instances +describing all known networks.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getProtocol"> + + getProtocol<span class="signature">(protoname, <span class="optional">netname</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 750 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Instantiates the given <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> backend, +optionally using the given network name.</p> + </div> + - <tbody> + + + + + +<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>protoname</code></td> - + <td class="type"> @@ -2144,33 +3011,30 @@ optionally using the given network name.</p> </td> - - <td class="attributes"> - - - - - - </td> - - <td class="default"> </td> - - <td class="description last"><p>The protocol backend to use, e.g. <code>static</code> or <code>dhcp</code>.</p></td> + + <td class="description last"> + + + + + + + <p>The protocol backend to use, e.g. <code>static</code> or <code>dhcp</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>netname</code></td> - + <td class="type"> @@ -2179,19 +3043,7 @@ optionally using the given network name.</p> </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - <td class="default"> @@ -2199,612 +3051,567 @@ optionally using the given network name.</p> </td> - - <td class="description last"><p>The network name to use for the instantiated protocol. This should be + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The network name to use for the instantiated protocol. This should be usually set to one of the interfaces described in /etc/config/network but it is allowed to omit it, e.g. to query protocol capabilities without the need for an existing interface.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line750">line 750</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the instantiated protocol backend class or <code>null</code> if the given -protocol isn't known.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> + + + </td> + <td class="description last">Returns the instantiated protocol backend class or <code>null</code> if the given +protocol isn't known.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getProtocols"> + + getProtocols<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 765 + </div> + + </div> - <h4 class="name" id="getProtocols"><span class="type-signature"></span>getProtocols<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Obtains instances of all known <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> + <div class="description"> + <p>Obtains instances of all known <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> backend classes.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line765">line 765</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of protocol class instances.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>> + + + </td> + <td class="description last">Returns an array of protocol class instances.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSwitchTopologies"> + + getSwitchTopologies<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Object.<string, <a href="LuCI.Network.html#.SwitchTopology">LuCI.Network.SwitchTopology</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1538 + </div> + + </div> - <h4 class="name" id="getSwitchTopologies"><span class="type-signature"></span>getSwitchTopologies<span class="signature">()</span><span class="type-signature"> → {Promise.<Object.<string, <a href="LuCI.Network.html#.SwitchTopology">LuCI.Network.SwitchTopology</a>>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Returns the topologies of all swconfig switches found on the system.</p> + </div> - - -<div class="description"> - <p>Returns the topologies of all swconfig switches found on the system.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1538">line 1538</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to an object containing the topologies + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<Object.<string, <a href="LuCI.Network.html#.SwitchTopology">LuCI.Network.SwitchTopology</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an object containing the topologies of each switch. The object keys correspond to the name of the switches such as <code>switch0</code>, the values are <a href="LuCI.Network.html#.SwitchTopology"><code>SwitchTopology</code></a> objects describing -the layout.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Object.<string, <a href="LuCI.Network.html#.SwitchTopology">LuCI.Network.SwitchTopology</a>>></span> - - - </dd> -</dl> - +the layout.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWAN6Networks"> + + getWAN6Networks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1493 + </div> + + </div> - <h4 class="name" id="getWAN6Networks"><span class="type-signature"></span>getWAN6Networks<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get IPv6 wan networks.</p> + <div class="description"> + <p>Get IPv6 wan networks.</p> <p>This function looks up all networks having a default <code>::/0</code> route and returns them as array.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1493">line 1493</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an array of <code>Protocol</code> subclass -instances describing the found IPv6 default route interfaces.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an array of <code>Protocol</code> subclass +instances describing the found IPv6 default route interfaces.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWANNetworks"> + + getWANNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1472 + </div> + + </div> - <h4 class="name" id="getWANNetworks"><span class="type-signature"></span>getWANNetworks<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get IPv4 wan networks.</p> + <div class="description"> + <p>Get IPv4 wan networks.</p> <p>This function looks up all networks having a default <code>0.0.0.0/0</code> route and returns them as array.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1472">line 1472</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an array of <code>Protocol</code> subclass -instances describing the found default route interfaces.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getWifiDevice"><span class="type-signature"></span>getWifiDevice<span class="signature">(devname)</span><span class="type-signature"> → {Promise.<(null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>)>}</span></h4> - - - - -<div class="description"> - <p>Get a <a href="LuCI.Network.WifiDevice.html"><code>WifiDevice</code></a> instance describing -the given wireless radio.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an array of <code>Protocol</code> subclass +instances describing the found default route interfaces.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiDevice"> + + getWifiDevice<span class="signature">(devname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>)>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1240 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Get a <a href="LuCI.Network.WifiDevice.html"><code>WifiDevice</code></a> instance describing +the given wireless radio.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>devname</code></td> - + <td class="type"> @@ -2813,274 +3620,250 @@ the given wireless radio.</p> </td> - - - - <td class="description last"><p>The configuration name of the wireless radio to lookup, e.g. <code>radio0</code> + + <td class="description last"> + + <p>The configuration name of the wireless radio to lookup, e.g. <code>radio0</code> for the first mac80211 phy on the system.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1240">line 1240</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to the <code>WifiDevice</code> instance describing + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<(null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>)> + + + </td> + <td class="description last">Returns a promise resolving to the <code>WifiDevice</code> instance describing the underlying radio device or <code>null</code> if the wireless radio could not -be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<(null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>)></span> - - - </dd> -</dl> - +be found.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiDevices"> + + getWifiDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1260 + </div> + + </div> - <h4 class="name" id="getWifiDevices"><span class="type-signature"></span>getWifiDevices<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Obtain a list of all configured radio devices.</p> + </div> - - -<div class="description"> - <p>Obtain a list of all configured radio devices.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1260">line 1260</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to an array of <code>WifiDevice</code> instances + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an array of <code>WifiDevice</code> instances describing the wireless radios configured in the system. The order of the array corresponds to the order of the radios in -the configuration.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>>></span> - - - </dd> -</dl> - +the configuration.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiNetwork"> + + getWifiNetwork<span class="signature">(netname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span> + </h4> + + <div class="tag-source"> + network.js, line 1289 + </div> + + </div> - <h4 class="name" id="getWifiNetwork"><span class="type-signature"></span>getWifiNetwork<span class="signature">(netname)</span><span class="type-signature"> → {Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get a <a href="LuCI.Network.WifiNetwork.html"><code>WifiNetwork</code></a> instance describing + <div class="description"> + <p>Get a <a href="LuCI.Network.WifiNetwork.html"><code>WifiNetwork</code></a> instance describing the given wireless network.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>netname</code></td> - + <td class="type"> @@ -3089,166 +3872,152 @@ the given wireless network.</p> </td> - - - - <td class="description last"><p>The name of the wireless network to lookup. This may be either an uci + + <td class="description last"> + + <p>The name of the wireless network to lookup. This may be either an uci configuration section ID, a network ID in the form <code>radio#.network#</code> or a Linux network device name like <code>wlan0</code> which is resolved to the corresponding configuration section through <code>ubus</code> runtime information.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1289">line 1289</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to the <code>WifiNetwork</code> instance describing + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)> + + + </td> + <td class="description last">Returns a promise resolving to the <code>WifiNetwork</code> instance describing the wireless network or <code>null</code> if the corresponding network could not -be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)></span> - - - </dd> -</dl> - +be found.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isIgnoredDevice"> + + isIgnoredDevice<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 1223 + </div> + + </div> - <h4 class="name" id="isIgnoredDevice"><span class="type-signature"></span>isIgnoredDevice<span class="signature">(name)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Test if a given network device name is in the list of patterns for + <div class="description"> + <p>Test if a given network device name is in the list of patterns for device names to ignore.</p> <p>Ignored device names are usually Linux network devices which are spawned implicitly by kernel modules such as <code>tunl0</code> or <code>hwsim0</code> and which are unsuitable for use in network configuration.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -3257,162 +4026,146 @@ and which are unsuitable for use in network configuration.</p> </td> - - - - <td class="description last"><p>The device name to test.</p></td> + + <td class="description last"> + + <p>The device name to test.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1223">line 1223</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the given name is in the ignore pattern list, -else returns <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="maskToPrefix"><span class="type-signature"></span>maskToPrefix<span class="signature">(netmask, v6<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {null|number}</span></h4> - - - - -<div class="description"> - <p>Converts the given netmask to a prefix size in bits.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> if the given name is in the ignore pattern list, +else returns <code>false</code>.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="maskToPrefix"> + + maskToPrefix<span class="signature">(netmask, <span class="optional">v6</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + + <div class="tag-source"> + network.js, line 664 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Converts the given netmask to a prefix size in bits.</p> + </div> + - <tbody> + + + + + +<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>netmask</code></td> - + <td class="type"> @@ -3421,33 +4174,30 @@ else returns <code>false</code>.</p> </td> - - - <td class="attributes"> - - - - - - </td> - <td class="default"> </td> - - <td class="description last"><p>The netmask to convert into a bit count.</p></td> + + <td class="description last"> + + + + + + + <p>The netmask to convert into a bit count.</p></td> </tr> - - - + + + <tr> <td class="name"><code>v6</code></td> - + <td class="type"> @@ -3456,19 +4206,7 @@ else returns <code>false</code>.</p> </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - <td class="default"> @@ -3476,162 +4214,155 @@ else returns <code>false</code>.</p> </td> - - <td class="description last"><p>Whether to parse the given netmask as IPv4 (<code>false</code>) or IPv6 (<code>true</code>) + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Whether to parse the given netmask as IPv4 (<code>false</code>) or IPv6 (<code>true</code>) address.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line664">line 664</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the number of prefix bits contained in the netmask or <code>null</code> -if the given netmask value was invalid.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="prefixToMask"><span class="type-signature"></span>prefixToMask<span class="signature">(bits, v6<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {null|string}</span></h4> - - - - -<div class="description"> - <p>Converts the given prefix size in bits to a netmask.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">Returns the number of prefix bits contained in the netmask or <code>null</code> +if the given netmask value was invalid.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="prefixToMask"> + + prefixToMask<span class="signature">(bits, <span class="optional">v6</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 646 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Converts the given prefix size in bits to a netmask.</p> + </div> + - <tbody> + + + + + +<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>bits</code></td> - + <td class="type"> @@ -3640,33 +4371,30 @@ if the given netmask value was invalid.</p> </td> - - - <td class="attributes"> - - - - - - </td> - <td class="default"> </td> - - <td class="description last"><p>The prefix size in bits.</p></td> + + <td class="description last"> + + + + + + + <p>The prefix size in bits.</p></td> </tr> - - - + + + <tr> <td class="name"><code>v6</code></td> - + <td class="type"> @@ -3675,19 +4403,7 @@ if the given netmask value was invalid.</p> </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - <td class="default"> @@ -3695,160 +4411,155 @@ if the given netmask value was invalid.</p> </td> - - <td class="description last"><p>Whether to convert the bits value into an IPv4 netmask (<code>false</code>) or + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Whether to convert the bits value into an IPv4 netmask (<code>false</code>) or an IPv6 netmask (<code>true</code>).</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line646">line 646</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a string containing the netmask corresponding to the bit count + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns a string containing the netmask corresponding to the bit count or <code>null</code> when the given amount of bits exceeds the maximum possible -value of <code>32</code> for IPv4 or <code>128</code> for IPv6.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - +value of <code>32</code> for IPv4 or <code>128</code> for IPv6.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="registerErrorCode"> + + registerErrorCode<span class="signature">(code, message)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 853 + </div> + + </div> - <h4 class="name" id="registerErrorCode"><span class="type-signature"></span>registerErrorCode<span class="signature">(code, message)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Registers a new human readable translation string for a <code>Protocol</code> + <div class="description"> + <p>Registers a new human readable translation string for a <code>Protocol</code> error code.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>code</code></td> - + <td class="type"> @@ -3857,22 +4568,22 @@ error code.</p> </td> - - - - <td class="description last"><p>The <code>ubus</code> protocol error code to register a translation for, e.g. + + <td class="description last"> + + <p>The <code>ubus</code> protocol error code to register a translation for, e.g. <code>NO_DEVICE</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>message</code></td> - + <td class="type"> @@ -3881,160 +4592,146 @@ error code.</p> </td> - - - - <td class="description last"><p>The message to use as translation for the given protocol error code.</p></td> + + <td class="description last"> + + <p>The message to use as translation for the given protocol error code.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line853">line 853</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> if the error code description has been added or <code>false</code> + <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> if the error code description has been added or <code>false</code> if either the arguments were invalid or if there already was a -description for the given code.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +description for the given code.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="registerPatternVirtual"> + + registerPatternVirtual<span class="signature">(pat)</span> + </h4> + + <div class="tag-source"> + network.js, line 833 + </div> + + </div> - <h4 class="name" id="registerPatternVirtual"><span class="type-signature"></span>registerPatternVirtual<span class="signature">(pat)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Registers a new regular expression pattern to recognize + <div class="description"> + <p>Registers a new regular expression pattern to recognize virtual interfaces.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>pat</code></td> - + <td class="type"> @@ -4043,140 +4740,119 @@ virtual interfaces.</p> </td> - - - - <td class="description last"><p>A <code>RegExp</code> instance to match a virtual interface name + + <td class="description last"> + + <p>A <code>RegExp</code> instance to match a virtual interface name such as <code>6in4-wan</code> or <code>tun0</code>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line833">line 833</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="registerProtocol"> + + registerProtocol<span class="signature">(protoname, methods)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 792 + </div> + + </div> - <h4 class="name" id="registerProtocol"><span class="type-signature"></span>registerProtocol<span class="signature">(protoname, methods)</span><span class="type-signature"> → {<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Registers a new <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass + <div class="description"> + <p>Registers a new <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass with the given methods and returns the resulting subclass value.</p> <p>This functions internally calls <a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a> on the <code>Network.Protocol</code> base class.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>protoname</code></td> - + <td class="type"> @@ -4185,21 +4861,21 @@ base class.</p> </td> - - - - <td class="description last"><p>The name of the new protocol to register.</p></td> + + <td class="description last"> + + <p>The name of the new protocol to register.</p></td> </tr> - - - + + + <tr> <td class="name"><code>methods</code></td> - + <td class="type"> @@ -4208,158 +4884,144 @@ base class.</p> </td> - - - - <td class="description last"><p>The member methods and values of the new <code>Protocol</code> subclass to + + <td class="description last"> + + <p>The member methods and values of the new <code>Protocol</code> subclass to be passed to <a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line792">line 792</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the new <code>Protocol</code> subclass.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="renameNetwork"><span class="type-signature"></span>renameNetwork<span class="signature">(oldName, newName)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> - - - - -<div class="description"> - <p>Rename the given network and its references to a new name.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> + + + </td> + <td class="description last">Returns the new <code>Protocol</code> subclass.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="renameNetwork"> + + renameNetwork<span class="signature">(oldName, newName)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<boolean>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1026 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Rename the given network and its references to a new name.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>oldName</code></td> - + <td class="type"> @@ -4368,21 +5030,21 @@ be passed to <a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a>.< </td> - - - - <td class="description last"><p>The current name of the network.</p></td> + + <td class="description last"> + + <p>The current name of the network.</p></td> </tr> - - - + + + <tr> <td class="name"><code>newName</code></td> - + <td class="type"> @@ -4391,171 +5053,147 @@ be passed to <a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a>.< </td> - - - - <td class="description last"><p>The name to rename the network to, must be in the format + + <td class="description last"> + + <p>The name to rename the network to, must be in the format <code>[a-z-A-Z0-9_]+</code>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1026">line 1026</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to either <code>true</code> if the network was + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<boolean> + + + </td> + <td class="description last">Returns a promise resolving to either <code>true</code> if the network was successfully renamed or <code>false</code> if the new name was invalid, if a network with the new name already exists or if the network to -rename could not be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<boolean></span> - - - </dd> -</dl> - +rename could not be found.</td> + </tr> + </tbody> +</table> - - - - - + + +</dd> + </dl> + + <h3 class="subsection-title">Type Definitions</h3> - + <dl> -<h4 class="name" id=".SwitchTopology">SwitchTopology</h4> - - - - -<div class="description"> - <p>Describes an swconfig switch topology by specifying the CPU +<dt> + <div class="nameContainer"> + <h4 class="name" id=".SwitchTopology">LuCI.Network.SwitchTopology<span class="type-signature type object.<string, (object|array)>">Object.<string, (Object|Array)></span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>Describes an swconfig switch topology by specifying the CPU connections and external port labels of a switch.</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object.<string, (Object|Array)></span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - + </div> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>netdevs</code></td> - + <td class="type"> @@ -4564,24 +5202,24 @@ connections and external port labels of a switch.</p> </td> - - - + + + <td class="description last"><p>The <code>netdevs</code> property points to an object describing the CPU port connections of the switch. The numeric key of the enclosed object is the port number, the value contains the Linux network device name the port is hardwired to.</p></td> </tr> - - - + + + <tr> <td class="name"><code>ports</code></td> - + <td class="type"> @@ -4590,11 +5228,11 @@ port is hardwired to.</p></td> </td> - - - + + + <td class="description last"><p>The <code>ports</code> property points to an array describing the populated ports of the switch in the external label order. Each array item is an object containg the following keys:</p> @@ -4606,119 +5244,91 @@ an object containg the following keys:</p> function (CPU ports only)</li> </ul></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line1504">line 1504</a> - </li></ul></dd> - - - + </dl> - - - - + + +</dd> -<h4 class="name" id=".WifiEncryption">WifiEncryption</h4> - - - - -<div class="description"> - <p>An encryption entry describes active wireless encryption settings +<dt> + <div class="nameContainer"> + <h4 class="name" id=".WifiEncryption">LuCI.Network.WifiEncryption<span class="type-signature type object.<string, (boolean|array.<(number|string)>)>">Object.<string, (boolean|Array.<(number|string)>)></span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>An encryption entry describes active wireless encryption settings such as the used key management protocols, active ciphers and protocol versions.</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object.<string, (boolean|Array.<(number|string)>)></span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - + </div> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Argument</th> + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>enabled</code></td> - + <td class="type"> @@ -4727,29 +5337,29 @@ protocol versions.</p> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Specifies whether any kind of encryption, such as <code>WEP</code> or <code>WPA</code> is enabled. If set to <code>false</code>, then no encryption is active and the corresponding network is open.</p></td> </tr> - - - + + + <tr> <td class="name"><code>wep</code></td> - + <td class="type"> @@ -4758,31 +5368,31 @@ corresponding network is open.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>When the <code>wep</code> property exists, the network uses WEP encryption. In this case, the property is set to an array of active WEP modes which might be either <code>open</code>, <code>shared</code> or both.</p></td> </tr> - - - + + + <tr> <td class="name"><code>wpa</code></td> - + <td class="type"> @@ -4791,32 +5401,32 @@ which might be either <code>open</code>, <code>shared</code> or both.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>When the <code>wpa</code> property exists, the network uses WPA security. In this case, the property is set to an array containing the WPA protocol versions used, e.g. <code>[ 1, 2 ]</code> for WPA/WPA2 mixed mode or <code>[ 3 ]</code> for WPA3-SAE.</p></td> </tr> - - - + + + <tr> <td class="name"><code>authentication</code></td> - + <td class="type"> @@ -4825,33 +5435,33 @@ protocol versions used, e.g. <code>[ 1, 2 ]</code> for WPA/WPA2 mixed mode or </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The <code>authentication</code> property only applies to WPA encryption and is defined when the <code>wpa</code> property is set as well. It points to an array of active authentication suites used by the network, e.g. <code>[ "psk" ]</code> for a WPA(2)-PSK network or <code>[ "psk", "sae" ]</code> for mixed WPA2-PSK/WPA3-SAE encryption.</p></td> </tr> - - - + + + <tr> <td class="name"><code>ciphers</code></td> - + <td class="type"> @@ -4860,137 +5470,109 @@ mixed WPA2-PSK/WPA3-SAE encryption.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>If either WEP or WPA encryption is active, then the <code>ciphers</code> property will be set to an array describing the active encryption ciphers used by the network, e.g. <code>[ "tkip", "ccmp" ]</code> for a WPA/WPA2-PSK mixed network or <code>[ "wep-40", "wep-104" ]</code> for an WEP network.</p></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line666">line 666</a> - </li></ul></dd> - - - + </dl> - - - - + + +</dd> -<h4 class="name" id=".WifiPeerEntry">WifiPeerEntry</h4> - - - - -<div class="description"> - <p>A wireless peer entry describes the properties of a remote wireless +<dt> + <div class="nameContainer"> + <h4 class="name" id=".WifiPeerEntry">LuCI.Network.WifiPeerEntry<span class="type-signature type object.<string, (boolean|number|string|luci.network.wifirateentry)>">Object.<string, (boolean|number|string|<a href="LuCI.Network.html#.WifiRateEntry">LuCI.Network.WifiRateEntry</a>)></span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>A wireless peer entry describes the properties of a remote wireless peer associated with a local network.</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object.<string, (boolean|number|string|<a href="LuCI.Network.html#.WifiRateEntry">LuCI.Network.WifiRateEntry</a>)></span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - + </div> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Argument</th> + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>mac</code></td> - + <td class="type"> @@ -4999,27 +5581,27 @@ peer associated with a local network.</p> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The MAC address (BSSID).</p></td> </tr> - - - + + + <tr> <td class="name"><code>signal</code></td> - + <td class="type"> @@ -5028,27 +5610,27 @@ peer associated with a local network.</p> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The received signal strength.</p></td> </tr> - - - + + + <tr> <td class="name"><code>signal_avg</code></td> - + <td class="type"> @@ -5057,29 +5639,29 @@ peer associated with a local network.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The average signal strength if supported by the driver.</p></td> </tr> - - - + + + <tr> <td class="name"><code>noise</code></td> - + <td class="type"> @@ -5088,30 +5670,30 @@ peer associated with a local network.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The current noise floor of the radio. May be <code>0</code> or absent if not supported by the driver.</p></td> </tr> - - - + + + <tr> <td class="name"><code>inactive</code></td> - + <td class="type"> @@ -5120,28 +5702,28 @@ supported by the driver.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The amount of milliseconds the peer has been inactive, e.g. due to powersave.</p></td> </tr> - - - + + + <tr> <td class="name"><code>connected_time</code></td> - + <td class="type"> @@ -5150,27 +5732,27 @@ to powersave.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The amount of milliseconds the peer is associated to this network.</p></td> </tr> - - - + + + <tr> <td class="name"><code>thr</code></td> - + <td class="type"> @@ -5179,30 +5761,30 @@ to powersave.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The estimated throughput of the peer, May be <code>0</code> or absent if not supported by the driver.</p></td> </tr> - - - + + + <tr> <td class="name"><code>authorized</code></td> - + <td class="type"> @@ -5211,27 +5793,27 @@ supported by the driver.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Specifies whether the peer is authorized to associate to this network.</p></td> </tr> - - - + + + <tr> <td class="name"><code>authenticated</code></td> - + <td class="type"> @@ -5240,27 +5822,27 @@ supported by the driver.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Specifies whether the peer completed authentication to this network.</p></td> </tr> - - - + + + <tr> <td class="name"><code>preamble</code></td> - + <td class="type"> @@ -5269,27 +5851,27 @@ supported by the driver.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The preamble mode used by the peer. May be <code>long</code> or <code>short</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>wme</code></td> - + <td class="type"> @@ -5298,27 +5880,27 @@ supported by the driver.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Specifies whether the peer supports WME/WMM capabilities.</p></td> </tr> - - - + + + <tr> <td class="name"><code>mfp</code></td> - + <td class="type"> @@ -5327,27 +5909,27 @@ supported by the driver.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Specifies whether management frame protection is active.</p></td> </tr> - - - + + + <tr> <td class="name"><code>tdls</code></td> - + <td class="type"> @@ -5356,27 +5938,27 @@ supported by the driver.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Specifies whether TDLS is active.</p></td> </tr> - - - + + + <tr> <td class="name"><code>mesh llid</code></td> - + <td class="type"> @@ -5385,30 +5967,30 @@ supported by the driver.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The mesh LLID, may be <code>0</code> or absent if not applicable or supported by the driver.</p></td> </tr> - - - + + + <tr> <td class="name"><code>mesh plid</code></td> - + <td class="type"> @@ -5417,30 +5999,30 @@ by the driver.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The mesh PLID, may be <code>0</code> or absent if not applicable or supported by the driver.</p></td> </tr> - - - + + + <tr> <td class="name"><code>mesh plink</code></td> - + <td class="type"> @@ -5449,19 +6031,19 @@ by the driver.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The mesh peer link state description, may be an empty string (<code>''</code>) or absent if not applicable or supported by the driver.</p> <p>The following states are known:</p> @@ -5476,14 +6058,14 @@ or absent if not applicable or supported by the driver.</p> <li><code>UNKNOWN</code></li> </ul></td> </tr> - - - + + + <tr> <td class="name"><code>mesh local PS</code></td> - + <td class="type"> @@ -5492,19 +6074,19 @@ or absent if not applicable or supported by the driver.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The local powersafe mode for the peer link, may be an empty string (<code>''</code>) or absent if not applicable or supported by the driver.</p> @@ -5516,14 +6098,14 @@ the driver.</p> <li><code>UNKNOWN</code></li> </ul></td> </tr> - - - + + + <tr> <td class="name"><code>mesh peer PS</code></td> - + <td class="type"> @@ -5532,19 +6114,19 @@ the driver.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The remote powersafe mode for the peer link, may be an empty string (<code>''</code>) or absent if not applicable or supported by the driver.</p> @@ -5556,14 +6138,14 @@ the driver.</p> <li><code>UNKNOWN</code></li> </ul></td> </tr> - - - + + + <tr> <td class="name"><code>mesh non-peer PS</code></td> - + <td class="type"> @@ -5572,19 +6154,19 @@ the driver.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The powersafe mode for all non-peer neigbours, may be an empty string (<code>''</code>) or absent if not applicable or supported by the driver.</p> <p>The following modes are known:</p> @@ -5595,14 +6177,14 @@ string (<code>''</code>) or absent if not applicable or supported by the driver. <li><code>UNKNOWN</code></li> </ul></td> </tr> - - - + + + <tr> <td class="name"><code>rx</code></td> - + <td class="type"> @@ -5611,27 +6193,27 @@ string (<code>''</code>) or absent if not applicable or supported by the driver. </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Describes the receiving wireless rate from the peer.</p></td> </tr> - - - + + + <tr> <td class="name"><code>tx</code></td> - + <td class="type"> @@ -5640,131 +6222,103 @@ string (<code>''</code>) or absent if not applicable or supported by the driver. </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Describes the transmitting wireless rate to the peer.</p></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3581">line 3581</a> - </li></ul></dd> - - - + </dl> - - - - + + +</dd> -<h4 class="name" id=".WifiRateEntry">WifiRateEntry</h4> - - - - -<div class="description"> - <p>A wireless rate entry describes the properties of a wireless +<dt> + <div class="nameContainer"> + <h4 class="name" id=".WifiRateEntry">LuCI.Network.WifiRateEntry<span class="type-signature type object.<string, (boolean|number)>">Object.<string, (boolean|number)></span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>A wireless rate entry describes the properties of a wireless transmission rate to or from a peer.</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object.<string, (boolean|number)></span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - + </div> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Argument</th> + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>drop_misc</code></td> - + <td class="type"> @@ -5773,31 +6327,31 @@ transmission rate to or from a peer.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The amount of received misc. packages that have been dropped, e.g. due to corruption or missing authentication. Only applicable to receiving rates.</p></td> </tr> - - - + + + <tr> <td class="name"><code>packets</code></td> - + <td class="type"> @@ -5806,27 +6360,27 @@ receiving rates.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The amount of packets that have been received or sent.</p></td> </tr> - - - + + + <tr> <td class="name"><code>bytes</code></td> - + <td class="type"> @@ -5835,27 +6389,27 @@ receiving rates.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The amount of bytes that have been received or sent.</p></td> </tr> - - - + + + <tr> <td class="name"><code>failed</code></td> - + <td class="type"> @@ -5864,30 +6418,30 @@ receiving rates.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The amount of failed tranmission attempts. Only applicable to transmit rates.</p></td> </tr> - - - + + + <tr> <td class="name"><code>retries</code></td> - + <td class="type"> @@ -5896,30 +6450,30 @@ transmit rates.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The amount of retried transmissions. Only applicable to transmit rates.</p></td> </tr> - - - + + + <tr> <td class="name"><code>is_ht</code></td> - + <td class="type"> @@ -5928,27 +6482,27 @@ rates.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Specifies whether this rate is an HT (IEEE 802.11n) rate.</p></td> </tr> - - - + + + <tr> <td class="name"><code>is_vht</code></td> - + <td class="type"> @@ -5957,27 +6511,27 @@ rates.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>Specifies whether this rate is an VHT (IEEE 802.11ac) rate.</p></td> </tr> - - - + + + <tr> <td class="name"><code>mhz</code></td> - + <td class="type"> @@ -5986,27 +6540,27 @@ rates.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The channel width in MHz used for the transmission.</p></td> </tr> - - - + + + <tr> <td class="name"><code>rate</code></td> - + <td class="type"> @@ -6015,27 +6569,27 @@ rates.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The bitrate in bit/s of the transmission.</p></td> </tr> - - - + + + <tr> <td class="name"><code>mcs</code></td> - + <td class="type"> @@ -6044,30 +6598,30 @@ rates.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The MCS index of the used transmission rate. Only applicable to HT or VHT rates.</p></td> </tr> - - - + + + <tr> <td class="name"><code>40mhz</code></td> - + <td class="type"> @@ -6076,33 +6630,33 @@ HT or VHT rates.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>Specifies whether the tranmission rate used 40MHz wide channel. Only applicable to HT or VHT rates.</p> <p>Note: this option exists for backwards compatibility only and its use is discouraged. The <code>mhz</code> field should be used instead to determine the channel width.</p></td> </tr> - - - + + + <tr> <td class="name"><code>short_gi</code></td> - + <td class="type"> @@ -6111,30 +6665,30 @@ determine the channel width.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>Specifies whether a short guard interval is used for the transmission. Only applicable to HT or VHT rates.</p></td> </tr> - - - + + + <tr> <td class="name"><code>nss</code></td> - + <td class="type"> @@ -6143,132 +6697,104 @@ Only applicable to HT or VHT rates.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>Specifies the number of spatial streams used by the transmission. Only applicable to VHT rates.</p></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3691">line 3691</a> - </li></ul></dd> - - - + </dl> - - - - + + +</dd> -<h4 class="name" id=".WifiScanResult">WifiScanResult</h4> - - - - -<div class="description"> - <p>A wireless scan result object describes a neighbouring wireless +<dt> + <div class="nameContainer"> + <h4 class="name" id=".WifiScanResult">LuCI.Network.WifiScanResult<span class="type-signature type object.<string, (number|string|luci.network.wifiencryption)>">Object.<string, (number|string|<a href="LuCI.Network.html#.WifiEncryption">LuCI.Network.WifiEncryption</a>)></span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>A wireless scan result object describes a neighbouring wireless network found in the vincinity.</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object.<string, (number|string|<a href="LuCI.Network.html#.WifiEncryption">LuCI.Network.WifiEncryption</a>)></span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - + </div> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>ssid</code></td> - + <td class="type"> @@ -6277,21 +6803,21 @@ network found in the vincinity.</p> </td> - - - + + + <td class="description last"><p>The SSID / Mesh ID of the network.</p></td> </tr> - - - + + + <tr> <td class="name"><code>bssid</code></td> - + <td class="type"> @@ -6300,21 +6826,21 @@ network found in the vincinity.</p> </td> - - - + + + <td class="description last"><p>The BSSID if the network.</p></td> </tr> - - - + + + <tr> <td class="name"><code>mode</code></td> - + <td class="type"> @@ -6323,21 +6849,21 @@ network found in the vincinity.</p> </td> - - - + + + <td class="description last"><p>The operation mode of the network (<code>Master</code>, <code>Ad-Hoc</code>, <code>Mesh Point</code>).</p></td> </tr> - - - + + + <tr> <td class="name"><code>channel</code></td> - + <td class="type"> @@ -6346,21 +6872,21 @@ network found in the vincinity.</p> </td> - - - + + + <td class="description last"><p>The wireless channel of the network.</p></td> </tr> - - - + + + <tr> <td class="name"><code>signal</code></td> - + <td class="type"> @@ -6369,21 +6895,21 @@ network found in the vincinity.</p> </td> - - - + + + <td class="description last"><p>The received signal strength of the network in dBm.</p></td> </tr> - - - + + + <tr> <td class="name"><code>quality</code></td> - + <td class="type"> @@ -6392,22 +6918,22 @@ network found in the vincinity.</p> </td> - - - + + + <td class="description last"><p>The numeric quality level of the signal, can be used in conjunction with <code>quality_max</code> to calculate a quality percentage.</p></td> </tr> - - - + + + <tr> <td class="name"><code>quality_max</code></td> - + <td class="type"> @@ -6416,22 +6942,22 @@ with <code>quality_max</code> to calculate a quality percentage.</p></td> </td> - - - + + + <td class="description last"><p>The maximum possible quality level of the signal, can be used in conjunction with <code>quality</code> to calculate a quality percentage.</p></td> </tr> - - - + + + <tr> <td class="name"><code>encryption</code></td> - + <td class="type"> @@ -6440,90 +6966,67 @@ conjunction with <code>quality</code> to calculate a quality percentage.</p></td </td> - - - + + + <td class="description last"><p>The encryption used by the wireless network.</p></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3105">line 3105</a> - </li></ul></dd> - - - + </dl> + + +</dd> - - - - - + </dl> + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> - -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Poll.html b/documentation/jsapi/LuCI.Poll.html index 195fdc991b..a00c9a3acb 100644 --- a/documentation/jsapi/LuCI.Poll.html +++ b/documentation/jsapi/LuCI.Poll.html @@ -1,307 +1,1336 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Poll</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Poll</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Poll</h1> - +<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#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#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#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#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#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#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#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.Poll.html">Class: Poll</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>Poll</h2> - - <div class="class-description"><p>The <code>Poll</code> class allows registering and unregistering poll actions, + Poll + </h2> + + <div class="class-description"><p>The <code>Poll</code> class allows registering and unregistering poll actions, as well as starting, stopping and querying the state of the polling loop.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Poll"> + + new LuCI.Poll<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 999 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line999">line 999</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="active"> + + active<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1150 + </div> + + </div> - <h4 class="name" id="active"><span class="type-signature"></span>active<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Test whether the polling loop is running.</p> + </div> - - -<div class="description"> - <p>Test whether the polling loop is running.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1150">line 1150</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <ul> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last"><ul> <li>Returns <code>true</code> if polling is active, else <code>false</code>.</li> -</ul> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +</ul></td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="add"> + + add<span class="signature">(fn, interval)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1023 + </div> + + </div> - <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(fn, interval)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Add a new operation to the polling loop. If the polling loop is not + <div class="description"> + <p>Add a new operation to the polling loop. If the polling loop is not already started at this point, it will be implicitely started.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>fn</code></td> - + <td class="type"> @@ -310,21 +1339,21 @@ already started at this point, it will be implicitely started.</p> </td> - - - - <td class="description last"><p>The function to invoke on each poll interval.</p></td> + + <td class="description last"> + + <p>The function to invoke on each poll interval.</p></td> </tr> - - - + + + <tr> <td class="name"><code>interval</code></td> - + <td class="type"> @@ -333,78 +1362,55 @@ already started at this point, it will be implicitely started.</p> </td> - - - - <td class="description last"><p>The poll interval in seconds.</p></td> + + <td class="description last"> + + <p>The poll interval in seconds.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1023">line 1023</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -412,7 +1418,6 @@ already started at this point, it will be implicitely started.</p> <p>Throws <code>TypeError</code> when an invalid interval was passed.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -426,95 +1431,103 @@ already started at this point, it will be implicitely started.</p> </dd> </dl> </dt> - <dd></dd> </dl> - - - -<h5>Returns:</h5> - -<div class="param-desc"> - <p>Returns <code>true</code> if the function has been added or <code>false</code> if it -already is registered.</p> -</div> - + + + <h5>Returns:</h5> + -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if the function has been added or <code>false</code> if it +already is registered.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="remove"> + + remove<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1064 + </div> + + </div> - <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(fn)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Remove an operation from the polling loop. If no further operatons + <div class="description"> + <p>Remove an operation from the polling loop. If no further operatons are registered, the polling loop is implicitely stopped.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>fn</code></td> - + <td class="type"> @@ -523,78 +1536,55 @@ are registered, the polling loop is implicitely stopped.</p> </td> - - - - <td class="description last"><p>The function to remove.</p></td> + + <td class="description last"> + + <p>The function to remove.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1064">line 1064</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -602,7 +1592,6 @@ are registered, the polling loop is implicitely stopped.</p> <p>Throws <code>TypeError</code> when the given argument isn't a function.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -616,291 +1605,274 @@ are registered, the polling loop is implicitely stopped.</p> </dd> </dl> </dt> - <dd></dd> </dl> - - - -<h5>Returns:</h5> - -<div class="param-desc"> - <p>Returns <code>true</code> if the function has been removed or <code>false</code> if it -wasn't found.</p> -</div> - + + + <h5>Returns:</h5> + -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if the function has been removed or <code>false</code> if it +wasn't found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="start"> + + start<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1090 + </div> + + </div> - <h4 class="name" id="start"><span class="type-signature"></span>start<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>(Re)start the polling loop. Dispatches a custom <code>poll-start</code> event + <div class="description"> + <p>(Re)start the polling loop. Dispatches a custom <code>poll-start</code> event to the <code>document</code> object upon successful start.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1090">line 1090</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if polling has been started (or if no functions -where registered) or <code>false</code> when the polling loop already runs.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if polling has been started (or if no functions +where registered) or <code>false</code> when the polling loop already runs.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="stop"> + + stop<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1115 + </div> + + </div> - <h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Stop the polling loop. Dispatches a custom <code>poll-stop</code> event + <div class="description"> + <p>Stop the polling loop. Dispatches a custom <code>poll-stop</code> event to the <code>document</code> object upon successful stop.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1115">line 1115</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if polling has been stopped or <code>false</code> if it din't -run to begin with.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if polling has been stopped or <code>false</code> if it din't +run to begin with.</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> - -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Request.html b/documentation/jsapi/LuCI.Request.html index 2028b406fc..530bf9a033 100644 --- a/documentation/jsapi/LuCI.Request.html +++ b/documentation/jsapi/LuCI.Request.html @@ -1,203 +1,1242 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Request</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Request</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Request</h1> - +<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#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#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#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#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#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#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#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.Request.html">Class: Request</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>Request</h2> - - <div class="class-description"><p>The <code>Request</code> class allows initiating HTTP requests and provides utilities + Request + </h2> + + <div class="class-description"><p>The <code>Request</code> class allows initiating HTTP requests and provides utilities for dealing with responses.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Request"> + + new LuCI.Request<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 569 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line569">line 569</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - + + + + + <h3 class="subsection-title">Classes</h3> - + <dl> <dt><a href="LuCI.Request.poll.html">poll</a></dt> <dd></dd> </dl> - - - - - + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="addInterceptor"> + + addInterceptor<span class="signature">(interceptorFn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Request.html#.interceptorFn">LuCI.Request.interceptorFn</a>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 844 + </div> + + </div> - <h4 class="name" id="addInterceptor"><span class="type-signature"></span>addInterceptor<span class="signature">(interceptorFn)</span><span class="type-signature"> → {<a href="LuCI.Request.html#.interceptorFn">LuCI.Request.interceptorFn</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Register an HTTP response interceptor function. Interceptor + <div class="description"> + <p>Register an HTTP response interceptor function. Interceptor functions are useful to perform default actions on incoming HTTP responses, such as checking for expired authentication or for implementing request retries before returning a failure.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>interceptorFn</code></td> - + <td class="type"> @@ -206,157 +1245,143 @@ implementing request retries before returning a failure.</p> </td> - - - - <td class="description last"><p>The interceptor function to register.</p></td> + + <td class="description last"> + + <p>The interceptor function to register.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line844">line 844</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The registered function.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type"><a href="LuCI.Request.html#.interceptorFn">LuCI.Request.interceptorFn</a></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="expandURL"><span class="type-signature"></span>expandURL<span class="signature">(url)</span><span class="type-signature"> → {string}</span></h4> - - - - -<div class="description"> - <p>Turn the given relative URL into an absolute URL if necessary.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.Request.html#.interceptorFn">LuCI.Request.interceptorFn</a> + + + </td> + <td class="description last">The registered function.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="expandURL"> + + expandURL<span class="signature">(url)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 586 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Turn the given relative URL into an absolute URL if necessary.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -365,160 +1390,144 @@ implementing request retries before returning a failure.</p> </td> - - - - <td class="description last"><p>The URL to convert.</p></td> + + <td class="description last"> + + <p>The URL to convert.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line586">line 586</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The absolute URL derived from the given one, or the original URL -if it already was absolute.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(target, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="LuCI.Response.html">LuCI.Response</a>>}</span></h4> - - - - -<div class="description"> - <p>Initiate an HTTP GET request to the given target.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">The absolute URL derived from the given one, or the original URL +if it already was absolute.</td> + </tr> + + </tbody> +</table> + + + + +</dd> - <th>Attributes</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(target, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.Response.html">LuCI.Response</a>>}</span> + </h4> + - + <div class="tag-source"> + luci.js, line 797 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Initiate an HTTP GET request to the given target.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>target</code></td> - + <td class="type"> @@ -527,29 +1536,26 @@ if it already was absolute.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request.</p></td> + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> @@ -558,169 +1564,150 @@ if it already was absolute.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional options to configure the request.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional options to configure the request.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line797">line 797</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The resulting HTTP response.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<<a href="LuCI.Response.html">LuCI.Response</a>></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="post"><span class="type-signature"></span>post<span class="signature">(target, data<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="LuCI.Response.html">LuCI.Response</a>>}</span></h4> - - - - -<div class="description"> - <p>Initiate an HTTP POST request to the given target.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<<a href="LuCI.Response.html">LuCI.Response</a>> + + + </td> + <td class="description last">The resulting HTTP response.</td> + </tr> + + </tbody> +</table> + + + + +</dd> - <th>Attributes</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="post"> + + post<span class="signature">(target, <span class="optional">data</span>, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.Response.html">LuCI.Response</a>>}</span> + </h4> + - + <div class="tag-source"> + luci.js, line 818 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Initiate an HTTP POST request to the given target.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>target</code></td> - + <td class="type"> @@ -729,29 +1716,26 @@ if it already was absolute.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request.</p></td> + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -760,31 +1744,28 @@ if it already was absolute.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The request data to send, see <a href="LuCI.Request.html#.RequestOptions"><code>LuCI.Request.RequestOptions</code></a> for details.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The request data to send, see <a href="LuCI.Request.html#.RequestOptions"><code>LuCI.Request.RequestOptions</code></a> for details.</p></td> </tr> - - - + + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> @@ -793,169 +1774,152 @@ if it already was absolute.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional options to configure the request.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional options to configure the request.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line818">line 818</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The resulting HTTP response.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<<a href="LuCI.Response.html">LuCI.Response</a>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<<a href="LuCI.Response.html">LuCI.Response</a>> + + + </td> + <td class="description last">The resulting HTTP response.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="removeInterceptor"> + + removeInterceptor<span class="signature">(interceptorFn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 863 + </div> + + </div> - <h4 class="name" id="removeInterceptor"><span class="type-signature"></span>removeInterceptor<span class="signature">(interceptorFn)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Remove an HTTP response interceptor function. The passed function + <div class="description"> + <p>Remove an HTTP response interceptor function. The passed function value must be the very same value that was used to register the function.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>interceptorFn</code></td> - + <td class="type"> @@ -964,159 +1928,143 @@ function.</p> </td> - - - - <td class="description last"><p>The interceptor function to remove.</p></td> + + <td class="description last"> + + <p>The interceptor function to remove.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line863">line 863</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if any function has been removed, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="request"><span class="type-signature"></span>request<span class="signature">(target, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="LuCI.Response.html">LuCI.Response</a>>}</span></h4> - - - - -<div class="description"> - <p>Initiate an HTTP request to the given target.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> if any function has been removed, else <code>false</code>.</td> + </tr> + + </tbody> +</table> + + + + +</dd> - <th>Attributes</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="request"> + + request<span class="signature">(target, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.Response.html">LuCI.Response</a>>}</span> + </h4> + - + <div class="tag-source"> + luci.js, line 648 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Initiate an HTTP request to the given target.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>target</code></td> - + <td class="type"> @@ -1125,29 +2073,26 @@ function.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request.</p></td> + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> @@ -1156,174 +2101,157 @@ function.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional options to configure the request.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional options to configure the request.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line648">line 648</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The resulting HTTP response.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<<a href="LuCI.Response.html">LuCI.Response</a>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<<a href="LuCI.Response.html">LuCI.Response</a>> + + + </td> + <td class="description last">The resulting HTTP response.</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + <h3 class="subsection-title">Type Definitions</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".interceptorFn"> + + LuCI.Request.interceptorFn<span class="signature">(res)</span> + </h4> + + <div class="tag-source"> + luci.js, line 822 + </div> + + </div> - <h4 class="name" id=".interceptorFn"><span class="type-signature"></span>interceptorFn<span class="signature">(res)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Interceptor functions are invoked whenever an HTTP reply is received, in the order + <div class="description"> + <p>Interceptor functions are invoked whenever an HTTP reply is received, in the order these functions have been registered.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>res</code></td> - + <td class="type"> @@ -1332,138 +2260,107 @@ these functions have been registered.</p> </td> - - - - <td class="description last"><p>The HTTP response object</p></td> + + <td class="description last"> + + <p>The HTTP response object</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line822">line 822</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> -<h4 class="name" id=".RequestOptions">RequestOptions</h4> - - - - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object</span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".RequestOptions">LuCI.Request.RequestOptions<span class="type-signature type object">Object</span> </h4> + </div> + + +</dt> +<dd> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - <th>Default</th> + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Argument</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>method</code></td> - + <td class="type"> @@ -1472,17 +2369,17 @@ these functions have been registered.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> @@ -1490,17 +2387,17 @@ these functions have been registered.</p> </td> - + <td class="description last"><p>The HTTP method to use, e.g. <code>GET</code> or <code>POST</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>query</code></td> - + <td class="type"> @@ -1509,34 +2406,34 @@ these functions have been registered.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> </td> - + <td class="description last"><p>Query string data to append to the URL. Non-string values of the given object will be converted to JSON.</p></td> </tr> - - - + + + <tr> <td class="name"><code>cache</code></td> - + <td class="type"> @@ -1545,17 +2442,17 @@ given object will be converted to JSON.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> @@ -1563,17 +2460,17 @@ given object will be converted to JSON.</p></td> </td> - + <td class="description last"><p>Specifies whether the HTTP response may be retrieved from cache.</p></td> </tr> - - - + + + <tr> <td class="name"><code>username</code></td> - + <td class="type"> @@ -1582,33 +2479,33 @@ given object will be converted to JSON.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> </td> - + <td class="description last"><p>Provides a username for HTTP basic authentication.</p></td> </tr> - - - + + + <tr> <td class="name"><code>password</code></td> - + <td class="type"> @@ -1617,33 +2514,33 @@ given object will be converted to JSON.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> </td> - + <td class="description last"><p>Provides a password for HTTP basic authentication.</p></td> </tr> - - - + + + <tr> <td class="name"><code>timeout</code></td> - + <td class="type"> @@ -1652,33 +2549,33 @@ given object will be converted to JSON.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> </td> - + <td class="description last"><p>Specifies the request timeout in seconds.</p></td> </tr> - - - + + + <tr> <td class="name"><code>credentials</code></td> - + <td class="type"> @@ -1687,17 +2584,17 @@ given object will be converted to JSON.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> @@ -1705,17 +2602,17 @@ given object will be converted to JSON.</p></td> </td> - + <td class="description last"><p>Whether to include credentials such as cookies in the request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>content</code></td> - + <td class="type"> @@ -1724,37 +2621,37 @@ given object will be converted to JSON.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> </td> - + <td class="description last"><p>Specifies the HTTP message body to send along with the request. If the value is a function, it is invoked and the return value used as content, if it is a FormData instance, it is used as-is, if it is an object, it will be converted to JSON, in all other cases it is converted to a string.</p></td> </tr> - - - + + + <tr> <td class="name"><code>header</code></td> - + <td class="type"> @@ -1763,33 +2660,33 @@ cases it is converted to a string.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> </td> - + <td class="description last"><p>Specifies HTTP headers to set for the request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>progress</code></td> - + <td class="type"> @@ -1798,103 +2695,80 @@ cases it is converted to a string.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - + <td class="default"> </td> - + <td class="description last"><p>An optional request callback function which receives ProgressEvent instances as sole argument during the HTTP request transfer.</p></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line593">line 593</a> - </li></ul></dd> - - - + </dl> + + +</dd> - - - - - + </dl> + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> - -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Request.poll.html b/documentation/jsapi/LuCI.Request.poll.html index 06c700dc4f..656f91152b 100644 --- a/documentation/jsapi/LuCI.Request.poll.html +++ b/documentation/jsapi/LuCI.Request.poll.html @@ -1,285 +1,1305 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: poll</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: poll</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: poll</h1> - +<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#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#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#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#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#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#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#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.Request.poll.html">Class: poll</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Request.html">.Request</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Request.html">.Request</a>.</span>poll</h2> - - <div class="class-description"><p>The <code>Request.poll</code> class provides some convience wrappers around + poll + </h2> + + <div class="class-description"><p>The <code>Request.poll</code> class provides some convience wrappers around <a href="LuCI.Poll.html"><code>LuCI.Poll</code></a> mainly to simplify registering repeating HTTP request calls as polling functions.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="poll"> + + new LuCI.Request.poll<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 881 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line881">line 881</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="active"> + + active<span class="signature">()</span> + </h4> + + <div class="tag-source"> + luci.js, line 985 + </div> + + </div> - <h4 class="name" id="active"><span class="type-signature"></span>active<span class="signature">()</span><span class="type-signature"></span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Alias for <code>LuCI.Poll.active()</code>.</p> + </div> - - -<div class="description"> - <p>Alias for <code>LuCI.Poll.active()</code>.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line985">line 985</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="add"> + + add<span class="signature">(interval, url, <span class="optional">options</span>, <span class="optional">callback</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{function}</span> + </h4> + + <div class="tag-source"> + luci.js, line 924 + </div> + + </div> - <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(interval, url, options<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {function}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Register a repeating HTTP request with an optional callback + <div class="description"> + <p>Register a repeating HTTP request with an optional callback to invoke whenever a response for the request is received.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>interval</code></td> - + <td class="type"> @@ -288,29 +1308,26 @@ to invoke whenever a response for the request is received.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The poll interval in seconds.</p></td> + <td class="description last"> + + + + + + + <p>The poll interval in seconds.</p></td> </tr> - - - + + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -319,29 +1336,26 @@ to invoke whenever a response for the request is received.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request on each poll.</p></td> + <td class="description last"> + + + + + + + <p>The URL to request on each poll.</p></td> </tr> - - - + + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> @@ -350,31 +1364,28 @@ to invoke whenever a response for the request is received.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional options to configure the request.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional options to configure the request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>callback</code></td> - + <td class="type"> @@ -383,89 +1394,63 @@ to invoke whenever a response for the request is received.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p><a href="LuCI.Request.poll.html#~callbackFn"><code>Callback</code></a> function to + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p><a href="LuCI.Request.poll.html#~callbackFn"><code>Callback</code></a> function to invoke for each HTTP reply.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line924">line 924</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -473,7 +1458,6 @@ invoke for each HTTP reply.</p></td> <p>Throws <code>TypeError</code> when an invalid interval was passed.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -487,95 +1471,103 @@ invoke for each HTTP reply.</p></td> </dd> </dl> </dt> - <dd></dd> </dl> - - - -<h5>Returns:</h5> - -<div class="param-desc"> - <p>Returns the internally created poll function.</p> -</div> - + + + <h5>Returns:</h5> + -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">function</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + function + + + </td> + <td class="description last">Returns the internally created poll function.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="remove"> + + remove<span class="signature">(entry)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 961 + </div> + + </div> - <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(entry)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Remove a polling request that has been previously added using <code>add()</code>. + <div class="description"> + <p>Remove a polling request that has been previously added using <code>add()</code>. This function is essentially a wrapper around <code>LuCI.Poll.remove()</code>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>entry</code></td> - + <td class="type"> @@ -584,341 +1576,293 @@ This function is essentially a wrapper around </td> - - - - <td class="description last"><p>The poll function returned by <a href="LuCI.Request.poll.html#add"><code>add()</code></a>.</p></td> + + <td class="description last"> + + <p>The poll function returned by <a href="LuCI.Request.poll.html#add"><code>add()</code></a>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line961">line 961</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if any function has been removed, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if any function has been removed, else <code>false</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="start"> + + start<span class="signature">()</span> + </h4> + + <div class="tag-source"> + luci.js, line 969 + </div> + + </div> - <h4 class="name" id="start"><span class="type-signature"></span>start<span class="signature">()</span><span class="type-signature"></span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Alias for <code>LuCI.Poll.start()</code>.</p> + </div> - - -<div class="description"> - <p>Alias for <code>LuCI.Poll.start()</code>.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line969">line 969</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="stop"> + + stop<span class="signature">()</span> + </h4> + + <div class="tag-source"> + luci.js, line 977 + </div> + + </div> - <h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"></span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Alias for <code>LuCI.Poll.stop()</code>.</p> + </div> - - -<div class="description"> - <p>Alias for <code>LuCI.Poll.stop()</code>.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line977">line 977</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - - - + + + + + + +</dd> + </dl> + + <h3 class="subsection-title">Type Definitions</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="~callbackFn"> + + callbackFn<span class="signature">(res, data, duration)</span> + </h4> + + <div class="tag-source"> + luci.js, line 882 + </div> + + </div> - <h4 class="name" id="~callbackFn"><span class="type-signature"></span>callbackFn<span class="signature">(res, data, duration)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The callback function is invoked whenever an HTTP reply to a + <div class="description"> + <p>The callback function is invoked whenever an HTTP reply to a polled request is received or when the polled request timed out.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>res</code></td> - + <td class="type"> @@ -927,21 +1871,21 @@ out.</p> </td> - - - - <td class="description last"><p>The HTTP response object.</p></td> + + <td class="description last"> + + <p>The HTTP response object.</p></td> </tr> - - - + + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -950,22 +1894,22 @@ out.</p> </td> - - - - <td class="description last"><p>The response JSON if the response could be parsed as such, + + <td class="description last"> + + <p>The response JSON if the response could be parsed as such, else <code>null</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>duration</code></td> - + <td class="type"> @@ -974,106 +1918,80 @@ else <code>null</code>.</p></td> </td> - - - - <td class="description last"><p>The total duration of the request in milliseconds.</p></td> + + <td class="description last"> + + <p>The total duration of the request in milliseconds.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line882">line 882</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + + +</dd> - - - - - - - - - - - - - - - - - + </dl> + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> - -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.Response.html b/documentation/jsapi/LuCI.Response.html index fea8f79d99..a7398ef507 100644 --- a/documentation/jsapi/LuCI.Response.html +++ b/documentation/jsapi/LuCI.Response.html @@ -1,631 +1,1506 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Response</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: Response</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: Response</h1> - +<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#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#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#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#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#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#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#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.Response.html">Class: Response</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>Response</h2> - - <div class="class-description"><p>The <code>Response</code> class is an internal utility class representing HTTP responses.</p></div> - + Response + </h2> + + <div class="class-description"><p>The <code>Response</code> class is an internal utility class representing HTTP responses.</p></div> -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Response"> + + new LuCI.Response<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 377 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line377">line 377</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - + + + + + <h3 class="subsection-title">Members</h3> - + <dl> -<h4 class="name" id="duration"><span class="type-signature"></span>duration<span class="type-signature"> :number</span></h4> - - - - -<div class="description"> - <p>The total duration of the HTTP request in milliseconds</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">number</span> - - - </li> - </ul> - - - - - +<dt> + <div class="nameContainer"> + <h4 class="name" id="duration">duration<span class="type-signature type number">number</span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>The total duration of the HTTP request in milliseconds</p> + </div> + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line416">line 416</a> - </li></ul></dd> - - - + + </dl> - - - - + + +</dd> -<h4 class="name" id="headers"><span class="type-signature"></span>headers<span class="type-signature"> :<a href="LuCI.Headers.html">LuCI.Headers</a></span></h4> - - - - -<div class="description"> - <p>The HTTP headers of the response</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type"><a href="LuCI.Headers.html">LuCI.Headers</a></span> - - - </li> - </ul> - - - - - +<dt> + <div class="nameContainer"> + <h4 class="name" id="headers">headers<span class="type-signature type luci.headers"><a href="LuCI.Headers.html">LuCI.Headers</a></span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>The HTTP headers of the response</p> + </div> + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line407">line 407</a> - </li></ul></dd> - - - + + </dl> - - - - + + +</dd> -<h4 class="name" id="ok"><span class="type-signature"></span>ok<span class="type-signature"> :boolean</span></h4> - - - - -<div class="description"> - <p>Describes whether the response is successful (status codes <code>200..299</code>) or not</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">boolean</span> - - - </li> - </ul> - - - - - +<dt> + <div class="nameContainer"> + <h4 class="name" id="ok">ok<span class="type-signature type boolean">boolean</span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>Describes whether the response is successful (status codes <code>200..299</code>) or not</p> + </div> + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line380">line 380</a> - </li></ul></dd> - - - + + </dl> - - - - + + +</dd> -<h4 class="name" id="status"><span class="type-signature"></span>status<span class="type-signature"> :number</span></h4> - - - - -<div class="description"> - <p>The numeric HTTP status code of the response</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">number</span> - - - </li> - </ul> - - - - - +<dt> + <div class="nameContainer"> + <h4 class="name" id="status">status<span class="type-signature type number">number</span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>The numeric HTTP status code of the response</p> + </div> + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line389">line 389</a> - </li></ul></dd> - - - + + </dl> - - - - + + +</dd> -<h4 class="name" id="statusText"><span class="type-signature"></span>statusText<span class="type-signature"> :string</span></h4> - - - - -<div class="description"> - <p>The HTTP status description message of the response</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">string</span> - - - </li> - </ul> - - - - - +<dt> + <div class="nameContainer"> + <h4 class="name" id="statusText">statusText<span class="type-signature type string">string</span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>The HTTP status description message of the response</p> + </div> + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line398">line 398</a> - </li></ul></dd> - - - + + </dl> - - - - + + +</dd> -<h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"> :string</span></h4> - - - - -<div class="description"> - <p>The final URL of the request, i.e. after following redirects.</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">string</span> - - - </li> - </ul> - - - - - +<dt> + <div class="nameContainer"> + <h4 class="name" id="url">url<span class="type-signature type string">string</span> </h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>The final URL of the request, i.e. after following redirects.</p> + </div> + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line425">line 425</a> - </li></ul></dd> - - - + + </dl> - - - - - - + +</dd> + </dl> + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="clone"> + + clone<span class="signature">(<span class="optional">content</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Response.html">LuCI.Response</a>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 465 + </div> + + </div> - <h4 class="name" id="clone"><span class="type-signature"></span>clone<span class="signature">(content<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="LuCI.Response.html">LuCI.Response</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Clones the given response object, optionally overriding the content + <div class="description"> + <p>Clones the given response object, optionally overriding the content of the cloned instance.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>content</code></td> - + <td class="type"> @@ -634,200 +1509,164 @@ of the cloned instance.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Override the content of the cloned response. Object values will be + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Override the content of the cloned response. Object values will be treated as JSON response data, all other types will be converted using <code>String()</code> and treated as response text.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line465">line 465</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The cloned <code>Response</code> instance.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type"><a href="LuCI.Response.html">LuCI.Response</a></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + <a href="LuCI.Response.html">LuCI.Response</a> + + + </td> + <td class="description last">The cloned <code>Response</code> instance.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="json"> + + json<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span> + </h4> + + <div class="tag-source"> + luci.js, line 486 + </div> + + </div> - <h4 class="name" id="json"><span class="type-signature"></span>json<span class="signature">()</span><span class="type-signature"> → {*}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Access the response content as JSON data.</p> + </div> - - -<div class="description"> - <p>Access the response content as JSON data.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line486">line 486</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -835,7 +1674,6 @@ using <code>String()</code> and treated as response text.</p></td> <p>Throws <code>SyntaxError</code> if the content isn't valid JSON.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -849,176 +1687,169 @@ using <code>String()</code> and treated as response text.</p></td> </dd> </dl> </dt> - <dd></dd> </dl> - - - -<h5>Returns:</h5> - -<div class="param-desc"> - <p>The parsed JSON data.</p> -</div> - + + + <h5>Returns:</h5> + -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">*</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + * + + + </td> + <td class="description last">The parsed JSON data.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="text"> + + text<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 501 + </div> + + </div> - <h4 class="name" id="text"><span class="type-signature"></span>text<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Access the response content as string.</p> + </div> - - -<div class="description"> - <p>Access the response content as string.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line501">line 501</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The response content.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">The response content.</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> - -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.XHR.html b/documentation/jsapi/LuCI.XHR.html index b82f2a0fb5..5a17dfa855 100644 --- a/documentation/jsapi/LuCI.XHR.html +++ b/documentation/jsapi/LuCI.XHR.html @@ -1,509 +1,1492 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: XHR</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: XHR</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: XHR</h1> - +<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#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#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#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#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#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#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#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.XHR.html">Class: XHR</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>XHR<span class="signature">()</span><span class="type-signature"></span></h2> - - <div class="class-description"><p>The <code>LuCI.XHR</code> class is a legacy compatibility shim for the + XHR + </h2> + + <div class="class-description"><p>The <code>LuCI.XHR</code> class is a legacy compatibility shim for the functionality formerly provided by <code>xhr.js</code>. It is registered as global <code>window.XHR</code> symbol for compatibility with legacy code.</p> <p>New code should use <a href="LuCI.Request.html"><code>LuCI.Request</code></a> instead to implement HTTP request handling.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="XHR"> + + new LuCI.XHR<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 2943 + </div> + </div> - <h2>Constructor</h2> +</dt> +<dd> + - <h4 class="name" id="XHR"><span class="type-signature"></span>new XHR<span class="signature">()</span><span class="type-signature"></span></h4> - - - - - - - - - - - - - - - - + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2943">line 2943</a> - </li></ul></dd> - - - </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="abort"> + + abort<span class="signature">()</span> + </h4> + + <div class="tag-source"> + luci.js, line 3046 + </div> + + </div> - <h4 class="name" id="abort"><span class="type-signature"></span>abort<span class="signature">()</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Ignored for backwards compatibility.</p> + <div class="description"> + <p>Ignored for backwards compatibility.</p> <p>This function does nothing.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3046">line 3046</a> - </li></ul></dd> - - - </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="busy"> + + busy<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 3035 + </div> + + </div> - <h4 class="name" id="busy"><span class="type-signature"></span>busy<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks the running state of the request.</p> + </div> - - -<div class="description"> - <p>Checks the running state of the request.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3035">line 3035</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the request is still running or <code>false</code> if it -already completed.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if the request is still running or <code>false</code> if it +already completed.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="cancel"> + + cancel<span class="signature">()</span> + </h4> + + <div class="tag-source"> + luci.js, line 3022 + </div> + + </div> - <h4 class="name" id="cancel"><span class="type-signature"></span>cancel<span class="signature">()</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Cancels a running request.</p> + <div class="description"> + <p>Cancels a running request.</p> <p>This function does not actually cancel the underlying <code>XMLHTTPRequest</code> request but it sets a flag which prevents the invocation of the callback function when the request eventually finishes or timed out.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3022">line 3022</a> - </li></ul></dd> - - - </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(url, <span class="optional">data</span>, <span class="optional">callback</span>, <span class="optional">timeout</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<null>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2978 + </div> + + </div> - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(url, data<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>, timeout<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<null>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>This function is a legacy wrapper around + <div class="description"> + <p>This function is a legacy wrapper around <a href="LuCI.html#get"><code>LuCI.get()</code></a>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -512,29 +1495,26 @@ finishes or timed out.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request</p></td> + <td class="description last"> + + + + + + + <p>The URL to request</p></td> </tr> - - - + + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -543,31 +1523,28 @@ finishes or timed out.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional query string data</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional query string data</p></td> </tr> - - - + + + <tr> <td class="name"><code>callback</code></td> - + <td class="type"> @@ -576,31 +1553,28 @@ finishes or timed out.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Callback function to invoke on completion</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Callback function to invoke on completion</p></td> </tr> - - - + + + <tr> <td class="name"><code>timeout</code></td> - + <td class="type"> @@ -609,168 +1583,153 @@ finishes or timed out.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Request timeout to use</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Request timeout to use</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2978">line 2978</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<null></span> - - - </dd> </dl> - - - - - - - + - <h4 class="name" id="post"><span class="type-signature"></span>post<span class="signature">(url, data<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>, timeout<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<null>}</span></h4> - - - - -<div class="description"> - <p>This function is a legacy wrapper around -<a href="LuCI.html#post"><code>LuCI.post()</code></a>.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<null> + + + </td> + <td class="description last"></td> + </tr> + + </tbody> +</table> + + + + +</dd> - <th>Attributes</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="post"> + + post<span class="signature">(url, <span class="optional">data</span>, <span class="optional">callback</span>, <span class="optional">timeout</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<null>}</span> + </h4> + - + <div class="tag-source"> + luci.js, line 3005 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>This function is a legacy wrapper around +<a href="LuCI.html#post"><code>LuCI.post()</code></a>.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -779,29 +1738,26 @@ finishes or timed out.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request</p></td> + <td class="description last"> + + + + + + + <p>The URL to request</p></td> </tr> - - - + + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -810,31 +1766,28 @@ finishes or timed out.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional data to append to the request body.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional data to append to the request body.</p></td> </tr> - - - + + + <tr> <td class="name"><code>callback</code></td> - + <td class="type"> @@ -843,31 +1796,28 @@ finishes or timed out.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Callback function to invoke on completion</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Callback function to invoke on completion</p></td> </tr> - - - + + + <tr> <td class="name"><code>timeout</code></td> - + <td class="type"> @@ -876,199 +1826,167 @@ finishes or timed out.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Request timeout to use</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Request timeout to use</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3005">line 3005</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<null></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<null> + + + </td> + <td class="description last"></td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="send_form"> + + send_form<span class="signature">()</span> + </h4> + + <div class="tag-source"> + luci.js, line 3061 + </div> + + </div> - <h4 class="name" id="send_form"><span class="type-signature"></span>send_form<span class="signature">()</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Existing for backwards compatibility.</p> + <div class="description"> + <p>Existing for backwards compatibility.</p> <p>This function simply throws an <code>InternalError</code> when invoked.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3061">line 3061</a> - </li></ul></dd> - - - </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -1077,7 +1995,6 @@ finishes or timed out.</p> when invoked.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -1091,44 +2008,40 @@ when invoked.</p> </dd> </dl> </dt> - <dd></dd> </dl> - - - - - - - - + + + +</dd> + </dl> + + + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> - -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.dom.html b/documentation/jsapi/LuCI.dom.html index b98c8f0a66..8412eb3025 100644 --- a/documentation/jsapi/LuCI.dom.html +++ b/documentation/jsapi/LuCI.dom.html @@ -1,195 +1,1232 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: dom</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: dom</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: dom</h1> - +<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#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#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#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#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#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#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#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.dom.html">Class: dom</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>dom</h2> - - <div class="class-description"><p>The <code>dom</code> class provides convenience method for creating and + dom + </h2> + + <div class="class-description"><p>The <code>dom</code> class provides convenience method for creating and manipulating DOM elements.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="dom"> + + new LuCI.dom<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 2065 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2065">line 2065</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="append"> + + append<span class="signature">(node, <span class="optional">children</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node|null}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2216 + </div> + + </div> - <h4 class="name" id="append"><span class="type-signature"></span>append<span class="signature">(node, children<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Node|null}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Appends the given children data to the given node.</p> + </div> - - -<div class="description"> - <p>Appends the given children data to the given node.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -198,29 +1235,26 @@ manipulating DOM elements.</p></div> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The <code>Node</code> argument to append the children to.</p></td> + <td class="description last"> + + + + + + + <p>The <code>Node</code> argument to append the children to.</p></td> </tr> - - - + + + <tr> <td class="name"><code>children</code></td> - + <td class="type"> @@ -229,22 +1263,19 @@ manipulating DOM elements.</p></div> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The childrens to append to the given node.</p> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The childrens to append to the given node.</p> <p>When <code>children</code> is an array, then each item of the array will be either appended as child element or text node, depending on whether the item is a DOM <code>Node</code> instance or @@ -262,157 +1293,141 @@ appended to the given <code>node</code>.</p> converted to a string and appened to the <code>innerHTML</code> property of the given <code>node</code>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2216">line 2216</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the last children <code>Node</code> appended to the node or <code>null</code> -if either the <code>node</code> argument was no valid DOM <code>node</code> or if the -<code>children</code> was <code>null</code> or didn't result in further DOM nodes.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Node</span> -| - -<span class="param-type">null</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="attr"><span class="type-signature"></span>attr<span class="signature">(node, key, val<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Sets attributes or registers event listeners on element nodes.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Node + | + + null + + + </td> + <td class="description last">Returns the last children <code>Node</code> appended to the node or <code>null</code> +if either the <code>node</code> argument was no valid DOM <code>node</code> or if the +<code>children</code> was <code>null</code> or didn't result in further DOM nodes.</td> + </tr> + + </tbody> +</table> + + + + +</dd> - <th>Attributes</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="attr"> + + attr<span class="signature">(node, key, <span class="optional">val</span>)</span> + </h4> + - + <div class="tag-source"> + luci.js, line 2331 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Sets attributes or registers event listeners on element nodes.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -421,31 +1436,28 @@ if either the <code>node</code> argument was no valid DOM <code>node</code> or i </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The <code>Node</code> argument to set the attributes or add the event + <td class="description last"> + + + + + + + <p>The <code>Node</code> argument to set the attributes or add the event listeners for. When the given <code>node</code> value is not a valid DOM <code>Node</code>, the function returns and does nothing.</p></td> </tr> - - - + + + <tr> <td class="name"><code>key</code></td> - + <td class="type"> @@ -457,32 +1469,29 @@ DOM <code>Node</code>, the function returns and does nothing.</p></td> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>Specifies either the attribute or event handler name to use, + <td class="description last"> + + + + + + + <p>Specifies either the attribute or event handler name to use, or an object containing multiple key, value pairs which are each added to the node as either attribute or event handler, depending on the respective value.</p></td> </tr> - - - + + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -491,22 +1500,19 @@ depending on the respective value.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Specifies the attribute value or event handler function to add. + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Specifies the attribute value or event handler function to add. If the <code>key</code> parameter is an <code>Object</code>, this parameter will be ignored.</p> <p>When <code>val</code> is of type function, it will be registered as event @@ -519,133 +1525,112 @@ as attribute name.</p> to the given <code>node</code> as-is, with the underlying <code>setAttribute()</code> call implicitely turning it into a string.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2331">line 2331</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="bindClassInstance"> + + bindClassInstance<span class="signature">(node, inst)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Class}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2565 + </div> + + </div> - <h4 class="name" id="bindClassInstance"><span class="type-signature"></span>bindClassInstance<span class="signature">(node, inst)</span><span class="type-signature"> → {Class}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Binds the given class instance ot the specified DOM <code>Node</code>.</p> + <div class="description"> + <p>Binds the given class instance ot the specified DOM <code>Node</code>.</p> <p>This function uses the <code>dom.data()</code> facility to attach the passed instance of a Class to a node. This is needed for complex widget elements or similar where the corresponding class instance responsible for the element must be retrieved from DOM nodes obtained by <code>querySelector()</code> or similar means.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -654,21 +1639,21 @@ from DOM nodes obtained by <code>querySelector()</code> or similar means.</p> </td> - - - - <td class="description last"><p>The DOM <code>Node</code> instance to bind the class to.</p></td> + + <td class="description last"> + + <p>The DOM <code>Node</code> instance to bind the class to.</p></td> </tr> - - - + + + <tr> <td class="name"><code>inst</code></td> - + <td class="type"> @@ -677,78 +1662,55 @@ from DOM nodes obtained by <code>querySelector()</code> or similar means.</p> </td> - - - - <td class="description last"><p>The Class instance to bind to the node.</p></td> + + <td class="description last"> + + <p>The Class instance to bind to the node.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2565">line 2565</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -757,7 +1719,6 @@ from DOM nodes obtained by <code>querySelector()</code> or similar means.</p> a valid Class instance.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -771,97 +1732,103 @@ a valid Class instance.</p> </dd> </dl> </dt> - <dd></dd> </dl> - - - -<h5>Returns:</h5> - -<div class="param-desc"> - <p>Returns the bound class instance.</p> -</div> - + + + <h5>Returns:</h5> + -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Class</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Class + + + </td> + <td class="description last">Returns the bound class instance.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="callClassMethod"> + + callClassMethod<span class="signature">(node, method, params)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*|null}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2619 + </div> + + </div> - <h4 class="name" id="callClassMethod"><span class="type-signature"></span>callClassMethod<span class="signature">(node, method, …params)</span><span class="type-signature"> → {*|null}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Finds a bound class instance on the given node itself or the + <div class="description"> + <p>Finds a bound class instance on the given node itself or the first bound instance on its closest parent node and invokes the specified method name on the found class instance.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -870,29 +1837,26 @@ the specified method name on the found class instance.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The DOM <code>Node</code> instance to start from.</p></td> + <td class="description last"> + + + + + + + <p>The DOM <code>Node</code> instance to start from.</p></td> </tr> - - - + + + <tr> <td class="name"><code>method</code></td> - + <td class="type"> @@ -901,29 +1865,26 @@ the specified method name on the found class instance.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the method to invoke on the found class instance.</p></td> + <td class="description last"> + + + + + + + <p>The name of the method to invoke on the found class instance.</p></td> </tr> - - - + + + <tr> <td class="name"><code>params</code></td> - + <td class="type"> @@ -932,178 +1893,159 @@ the specified method name on the found class instance.</p> </td> - - <td class="attributes"> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>Additional arguments to pass to the invoked method as-is.</p></td> + <td class="description last"> + + + + + + <span class="repeatable">repeatable</span> + + + <p>Additional arguments to pass to the invoked method as-is.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2619">line 2619</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the return value of the invoked method if a class + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + * + | + + null + + + </td> + <td class="description last">Returns the return value of the invoked method if a class instance and method has been found. Returns <code>null</code> if either no bound class instance could be found, or if the found -instance didn't have the requested <code>method</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">*</span> -| - -<span class="param-type">null</span> - - - </dd> -</dl> - +instance didn't have the requested <code>method</code>.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="content"> + + content<span class="signature">(node, <span class="optional">children</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node|null}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2283 + </div> + + </div> - <h4 class="name" id="content"><span class="type-signature"></span>content<span class="signature">(node, children<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Node|null}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Replaces the content of the given node with the given children.</p> + <div class="description"> + <p>Replaces the content of the given node with the given children.</p> <p>This function first removes any children of the given DOM <code>Node</code> and then adds the given given children following the rules outlined below.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -1112,29 +2054,26 @@ rules outlined below.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The <code>Node</code> argument to replace the children of.</p></td> + <td class="description last"> + + + + + + + <p>The <code>Node</code> argument to replace the children of.</p></td> </tr> - - - + + + <tr> <td class="name"><code>children</code></td> - + <td class="type"> @@ -1143,22 +2082,19 @@ rules outlined below.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The childrens to replace into the given node.</p> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The childrens to replace into the given node.</p> <p>When <code>children</code> is an array, then each item of the array will be either appended as child element or text node, depending on whether the item is a DOM <code>Node</code> instance or @@ -1176,162 +2112,146 @@ appended to the given <code>node</code>.</p> converted to a string and appened to the <code>innerHTML</code> property of the given <code>node</code>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2283">line 2283</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the last children <code>Node</code> appended to the node or <code>null</code> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Node + | + + null + + + </td> + <td class="description last">Returns the last children <code>Node</code> appended to the node or <code>null</code> if either the <code>node</code> argument was no valid DOM <code>node</code> or if the -<code>children</code> was <code>null</code> or didn't result in further DOM nodes.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Node</span> -| - -<span class="param-type">null</span> - - - </dd> -</dl> - +<code>children</code> was <code>null</code> or didn't result in further DOM nodes.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="create"> + + create<span class="signature">(html, <span class="optional">attr</span>, <span class="optional">data</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2409 + </div> + + </div> - <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(html, attr<span class="signature-attributes">opt</span>, data<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Node}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Creates a new DOM <code>Node</code> from the given <code>html</code>, <code>attr</code> and + <div class="description"> + <p>Creates a new DOM <code>Node</code> from the given <code>html</code>, <code>attr</code> and <code>data</code> parameters.</p> <p>This function has multiple signatures, it can be either invoked in the form <code>create(html[, attr[, data]])</code> or in the form <code>create(html[, data])</code>. The used variant is determined from the type of the second argument.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>html</code></td> - + <td class="type"> @@ -1340,20 +2260,17 @@ type of the second argument.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>Describes the node to create.</p> + <td class="description last"> + + + + + + + <p>Describes the node to create.</p> <p>When the value of <code>html</code> is of type array, a <code>DocumentFragment</code> node is created and each item of the array is first converted to a DOM <code>Node</code> by passing it through <code>create()</code> and then added @@ -1366,14 +2283,14 @@ be passed to <code>dom.parse()</code> and the resulting value is used.</p> to <code>document.createElement()</code> for creating a new DOM <code>Node</code> of the given name.</p></td> </tr> - - - + + + <tr> <td class="name"><code>attr</code></td> - + <td class="type"> @@ -1382,33 +2299,30 @@ the given name.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Specifies an Object of key, value pairs to set as attributes + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Specifies an Object of key, value pairs to set as attributes or event handlers on the created node. Refer to <a href="LuCI.dom.html#attr"><code>dom.attr()</code></a> for details.</p></td> </tr> - - - + + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -1417,89 +2331,63 @@ or event handlers on the created node. Refer to </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Specifies children to append to the newly created element. + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Specifies children to append to the newly created element. Refer to <a href="LuCI.dom.html#append"><code>dom.append()</code></a> for details.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2409">line 2409</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -1511,7 +2399,6 @@ in <code>html</code> contains characters which are not legal in DOM element names, such as spaces.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -1525,55 +2412,68 @@ element names, such as spaces.</p> </dd> </dl> </dt> - <dd></dd> </dl> - - - -<h5>Returns:</h5> - -<div class="param-desc"> - <p>Returns the newly created <code>Node</code>.</p> -</div> - + + + <h5>Returns:</h5> + -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Node</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Node + + + </td> + <td class="description last">Returns the newly created <code>Node</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="data"> + + data<span class="signature">(node, <span class="optional">key</span>, <span class="optional">val</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2485 + </div> + + </div> - <h4 class="name" id="data"><span class="type-signature"></span>data<span class="signature">(node, key<span class="signature-attributes">opt</span>, val<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Attaches or detaches arbitrary data to and from a DOM <code>Node</code>.</p> + <div class="description"> + <p>Attaches or detaches arbitrary data to and from a DOM <code>Node</code>.</p> <p>This function is useful to attach non-string values or runtime data that is not serializable to DOM nodes. To decouple data from the DOM, values are not added directly to nodes, but @@ -1594,46 +2494,39 @@ Clears any data associated with the node.</li> <li><code>dom.data(node, key, null)</code> - Clears the given key associated with the node.</li> </ul> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -1642,29 +2535,26 @@ Clears the given key associated with the node.</li> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The DOM <code>Node</code> instance to set or retrieve the data for.</p></td> + <td class="description last"> + + + + + + + <p>The DOM <code>Node</code> instance to set or retrieve the data for.</p></td> </tr> - - - + + + <tr> <td class="name"><code>key</code></td> - + <td class="type"> @@ -1676,32 +2566,29 @@ Clears the given key associated with the node.</li> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>This is either a string specifying the key to retrieve, or + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>This is either a string specifying the key to retrieve, or <code>null</code> to unset the entire node data.</p></td> </tr> - - - + + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -1713,169 +2600,152 @@ Clears the given key associated with the node.</li> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>This is either a non-<code>null</code> value to set for a given key or + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>This is either a non-<code>null</code> value to set for a given key or <code>null</code> to remove the given <code>key</code> from the specified node.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2485">line 2485</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the get or set value, or <code>null</code> when no value could -be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">*</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="elem"><span class="type-signature"></span>elem<span class="signature">(e)</span><span class="type-signature"> → {boolean}</span></h4> - - - - -<div class="description"> - <p>Tests whether the given argument is a valid DOM <code>Node</code>.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + * + + + </td> + <td class="description last">Returns the get or set value, or <code>null</code> when no value could +be found.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="elem"> + + elem<span class="signature">(e)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 2079 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Tests whether the given argument is a valid DOM <code>Node</code>.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>e</code></td> - + <td class="type"> @@ -1884,158 +2754,144 @@ be found.</p> </td> - - - - <td class="description last"><p>The value to test.</p></td> + + <td class="description last"> + + <p>The value to test.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2079">line 2079</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the value is a DOM <code>Node</code>, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="findClassInstance"><span class="type-signature"></span>findClassInstance<span class="signature">(node)</span><span class="type-signature"> → {Class|null}</span></h4> - - - - -<div class="description"> - <p>Finds a bound class instance on the given node itself or the -first bound instance on its closest parent node.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> if the value is a DOM <code>Node</code>, else <code>false</code>.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="findClassInstance"> + + findClassInstance<span class="signature">(node)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Class|null}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 2585 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Finds a bound class instance on the given node itself or the +first bound instance on its closest parent node.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -2044,167 +2900,151 @@ first bound instance on its closest parent node.</p> </td> - - - - <td class="description last"><p>The DOM <code>Node</code> instance to start from.</p></td> + + <td class="description last"> + + <p>The DOM <code>Node</code> instance to start from.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2585">line 2585</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the founds class instance if any or <code>null</code> if no bound -class could be found on the node itself or any of its parents.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Class</span> -| - -<span class="param-type">null</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Class + | + + null + + + </td> + <td class="description last">Returns the founds class instance if any or <code>null</code> if no bound +class could be found on the node itself or any of its parents.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isEmpty"> + + isEmpty<span class="signature">(node, <span class="optional">ignoreFn</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2665 + </div> + + </div> - <h4 class="name" id="isEmpty"><span class="type-signature"></span>isEmpty<span class="signature">(node, ignoreFn<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Tests whether a given DOM <code>Node</code> instance is empty or appears + <div class="description"> + <p>Tests whether a given DOM <code>Node</code> instance is empty or appears empty.</p> <p>Any element child nodes which have the CSS class <code>hidden</code> set or for which the optionally passed <code>ignoreFn</code> callback function returns <code>false</code> are ignored.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -2213,29 +3053,26 @@ returns <code>false</code> are ignored.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The DOM <code>Node</code> instance to test.</p></td> + <td class="description last"> + + + + + + + <p>The DOM <code>Node</code> instance to test.</p></td> </tr> - - - + + + <tr> <td class="name"><code>ignoreFn</code></td> - + <td class="type"> @@ -2244,176 +3081,157 @@ returns <code>false</code> are ignored.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Specifies an optional function which is invoked for each child + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Specifies an optional function which is invoked for each child node to decide whether the child node should be ignored or not.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2665">line 2665</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> if the node does not have any children or if + <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> if the node does not have any children or if any children node either has a <code>hidden</code> CSS class or a <code>false</code> -result when testing it using the given <code>ignoreFn</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +result when testing it using the given <code>ignoreFn</code>.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="matches"> + + matches<span class="signature">(node, <span class="optional">selector</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2140 + </div> + + </div> - <h4 class="name" id="matches"><span class="type-signature"></span>matches<span class="signature">(node, selector<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Tests whether a given <code>Node</code> matches the given query selector.</p> + <div class="description"> + <p>Tests whether a given <code>Node</code> matches the given query selector.</p> <p>This function is a convenience wrapper around the standard <code>Node.matches("selector")</code> function with the added benefit that the <code>node</code> argument may be a non-<code>Node</code> value, in which case this function simply returns <code>false</code>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -2422,29 +3240,26 @@ this function simply returns <code>false</code>.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The <code>Node</code> argument to test the selector against.</p></td> + <td class="description last"> + + + + + + + <p>The <code>Node</code> argument to test the selector against.</p></td> </tr> - - - + + + <tr> <td class="name"><code>selector</code></td> - + <td class="type"> @@ -2453,176 +3268,157 @@ this function simply returns <code>false</code>.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The query selector expression to test against the given node.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The query selector expression to test against the given node.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2140">line 2140</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> if the given node matches the specified selector + <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> if the given node matches the specified selector or <code>false</code> when the node argument is no valid DOM <code>Node</code> or the -selector didn't match.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +selector didn't match.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="parent"> + + parent<span class="signature">(node, <span class="optional">selector</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node|null}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2167 + </div> + + </div> - <h4 class="name" id="parent"><span class="type-signature"></span>parent<span class="signature">(node, selector<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Node|null}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Returns the closest parent node that matches the given query + <div class="description"> + <p>Returns the closest parent node that matches the given query selector expression.</p> <p>This function is a convenience wrapper around the standard <code>Node.closest("selector")</code> function with the added benefit that the <code>node</code> argument may be a non-<code>Node</code> value, in which case this function simply returns <code>null</code>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -2631,29 +3427,26 @@ this function simply returns <code>null</code>.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The <code>Node</code> argument to find the closest parent for.</p></td> + <td class="description last"> + + + + + + + <p>The <code>Node</code> argument to find the closest parent for.</p></td> </tr> - - - + + + <tr> <td class="name"><code>selector</code></td> - + <td class="type"> @@ -2662,172 +3455,155 @@ this function simply returns <code>null</code>.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The query selector expression to test against each parent.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The query selector expression to test against each parent.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2167">line 2167</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the closest parent node matching the selector or -<code>null</code> when the node argument is no valid DOM <code>Node</code> or the -selector didn't match any parent.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Node</span> -| - -<span class="param-type">null</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="parse"><span class="type-signature"></span>parse<span class="signature">(s)</span><span class="type-signature"> → {Node}</span></h4> - - - - -<div class="description"> - <p>Parses a given string as HTML and returns the first child node.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Node + | + + null + + + </td> + <td class="description last">Returns the closest parent node matching the selector or +<code>null</code> when the node argument is no valid DOM <code>Node</code> or the +selector didn't match any parent.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="parse"> + + parse<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 2098 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Parses a given string as HTML and returns the first child node.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>s</code></td> - + <td class="type"> @@ -2836,170 +3612,156 @@ selector didn't match any parent.</p> </td> - - - - <td class="description last"><p>A string containing an HTML fragment to parse. Note that only + + <td class="description last"> + + <p>A string containing an HTML fragment to parse. Note that only the first result of the resulting structure is returned, so an input value of <code><div>foo</div> <div>bar</div></code> will only return the first <code>div</code> element node.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2098">line 2098</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the first DOM <code>Node</code> extracted from the HTML fragment or -<code>null</code> on parsing failures or if no element could be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Node</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Node + + + </td> + <td class="description last">Returns the first DOM <code>Node</code> extracted from the HTML fragment or +<code>null</code> on parsing failures or if no element could be found.</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + <h3 class="subsection-title">Type Definitions</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="~ignoreCallbackFn"> + + ignoreCallbackFn<span class="signature">(node)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2628 + </div> + + </div> - <h4 class="name" id="~ignoreCallbackFn"><span class="type-signature"></span>ignoreCallbackFn<span class="signature">(node)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The ignore callback function is invoked by <code>isEmpty()</code> for each + <div class="description"> + <p>The ignore callback function is invoked by <code>isEmpty()</code> for each child node to decide whether to ignore a child node or not.</p> <p>When this function returns <code>false</code>, the node passed to it is ignored, else not.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>node</code></td> - + <td class="type"> @@ -3008,128 +3770,109 @@ ignored, else not.</p> </td> - - - - <td class="description last"><p>The child node to test.</p></td> + + <td class="description last"> + + <p>The child node to test.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2628">line 2628</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Boolean indicating whether to ignore the node or not.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> - - - - - + <tr> + <td class="type"> + + boolean + + + </td> + <td class="description last">Boolean indicating whether to ignore the node or not.</td> + </tr> + </tbody> +</table> -</article> + + +</dd> -</section> + </dl> + + + + +</article> +</section> -</div> -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.fs.html b/documentation/jsapi/LuCI.fs.html index abae649cbe..cfc0dc9cef 100644 --- a/documentation/jsapi/LuCI.fs.html +++ b/documentation/jsapi/LuCI.fs.html @@ -1,156 +1,1200 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: fs</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: fs</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: fs</h1> - +<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#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#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#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#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#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#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#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.fs.html">Class: fs</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>fs</h2> - - <div class="class-description"><p>Provides high level utilities to wrap file system related RPC calls. + fs + </h2> + + <div class="class-description"><p>Provides high level utilities to wrap file system related RPC calls. To import the class in views, use <code>'require fs'</code>, to import it in external JavaScript, use <code>L.require("fs").then(...)</code>.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="fs"> + + new LuCI.fs<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + fs.js, line 111 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line111">line 111</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="exec"> + + exec<span class="signature">(command, <span class="optional">params</span>, <span class="optional">env</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.fs.html#.FileExecResult">LuCI.fs.FileExecResult</a>>}</span> + </h4> + + <div class="tag-source"> + fs.js, line 232 + </div> + + </div> - <h4 class="name" id="exec"><span class="type-signature"></span>exec<span class="signature">(command, params<span class="signature-attributes">opt</span>, env<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="LuCI.fs.html#.FileExecResult">LuCI.fs.FileExecResult</a>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Execute the specified command, optionally passing params and + <div class="description"> + <p>Execute the specified command, optionally passing params and environment variables.</p> <p>Note: The <code>command</code> must be either the path to an executable, or a basename without arguments in which case it will be searched @@ -158,46 +1202,39 @@ in $PATH. If specified, the values given in <code>params</code> will be passed as arguments to the command.</p> <p>The key/value pairs in the optional <code>env</code> table are translated to <code>setenv()</code> calls prior to running the command.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>command</code></td> - + <td class="type"> @@ -206,29 +1243,26 @@ as arguments to the command.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The command to invoke.</p></td> + <td class="description last"> + + + + + + + <p>The command to invoke.</p></td> </tr> - - - + + + <tr> <td class="name"><code>params</code></td> - + <td class="type"> @@ -237,31 +1271,28 @@ as arguments to the command.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The arguments to pass to the command.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The arguments to pass to the command.</p></td> </tr> - - - + + + <tr> <td class="name"><code>env</code></td> - + <td class="type"> @@ -270,172 +1301,155 @@ as arguments to the command.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Environment variables to set.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Environment variables to set.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line232">line 232</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an object describing the execution -results or rejecting with an error stating the failure reason.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<<a href="LuCI.fs.html#.FileExecResult">LuCI.fs.FileExecResult</a>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<<a href="LuCI.fs.html#.FileExecResult">LuCI.fs.FileExecResult</a>> + + + </td> + <td class="description last">Returns a promise resolving to an object describing the execution +results or rejecting with an error stating the failure reason.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="lines"> + + lines<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<string>>}</span> + </h4> + + <div class="tag-source"> + fs.js, line 281 + </div> + + </div> - <h4 class="name" id="lines"><span class="type-signature"></span>lines<span class="signature">(path)</span><span class="type-signature"> → {Promise.<Array.<string>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Read the contents of the given file, split it into lines, trim + <div class="description"> + <p>Read the contents of the given file, split it into lines, trim leading and trailing white space of each line and return the resulting array.</p> <p>This function is guaranteed to not reject its promises, on failure, an empty array will be returned.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>path</code></td> - + <td class="type"> @@ -444,158 +1458,144 @@ an empty array will be returned.</p> </td> - - - - <td class="description last"><p>The file path to read.</p></td> + + <td class="description last"> + + <p>The file path to read.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line281">line 281</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an array containing the stripped lines -of the given file or <code>[]</code> on failure.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Array.<string>></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">(path)</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>>}</span></h4> - - - - -<div class="description"> - <p>Obtains a listing of the specified directory.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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 an array containing the stripped lines +of the given file or <code>[]</code> on failure.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="list"> + + list<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>>}</span> + </h4> + + + <div class="tag-source"> + fs.js, line 132 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Obtains a listing of the specified directory.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>path</code></td> - + <td class="type"> @@ -604,159 +1604,145 @@ of the given file or <code>[]</code> on failure.</p> </td> - - - - <td class="description last"><p>The directory path to list.</p></td> + + <td class="description last"> + + <p>The directory path to list.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line132">line 132</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an array of stat detail objects or -rejecting with an error stating the failure reason.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Array.<<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="read"><span class="type-signature"></span>read<span class="signature">(path)</span><span class="type-signature"> → {Promise.<string>}</span></h4> - - - - -<div class="description"> - <p>Read the contents of the given file and return them. -Note: this function is unsuitable for obtaining binary data.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an array of stat detail objects or +rejecting with an error stating the failure reason.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="read"> + + read<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<string>}</span> + </h4> + + + <div class="tag-source"> + fs.js, line 161 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Read the contents of the given file and return them. +Note: this function is unsuitable for obtaining binary data.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>path</code></td> - + <td class="type"> @@ -765,158 +1751,144 @@ Note: this function is unsuitable for obtaining binary data.</p> </td> - - - - <td class="description last"><p>The file path to read.</p></td> + + <td class="description last"> + + <p>The file path to read.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line161">line 161</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to a string containing the file contents or -rejecting with an error stating the failure reason.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<string></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(The)</span><span class="type-signature"> → {Promise.<number>}</span></h4> - - - - -<div class="description"> - <p>Unlink the given file.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<string> + + + </td> + <td class="description last">Returns a promise resolving to a string containing the file contents or +rejecting with an error stating the failure reason.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="remove"> + + remove<span class="signature">(The)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<number>}</span> + </h4> + + + <div class="tag-source"> + fs.js, line 203 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Unlink the given file.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>The</code></td> - + <td class="type"> @@ -925,158 +1897,144 @@ rejecting with an error stating the failure reason.</p> </td> - - - - <td class="description last"><p>file path to remove.</p></td> + + <td class="description last"> + + <p>file path to remove.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line203">line 203</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to <code>0</code> or rejecting with an error stating -the failure reason.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<number></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="stat"><span class="type-signature"></span>stat<span class="signature">(path)</span><span class="type-signature"> → {Promise.<<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>}</span></h4> - - - - -<div class="description"> - <p>Return file stat information on the specified path.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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 to <code>0</code> or rejecting with an error stating +the failure reason.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="stat"> + + stat<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>}</span> + </h4> + + + <div class="tag-source"> + fs.js, line 146 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Return file stat information on the specified path.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>path</code></td> - + <td class="type"> @@ -1085,164 +2043,150 @@ the failure reason.</p> </td> - - - - <td class="description last"><p>The filesystem path to stat.</p></td> + + <td class="description last"> + + <p>The filesystem path to stat.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line146">line 146</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to a stat detail object or -rejecting with an error stating the failure reason.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>> + + + </td> + <td class="description last">Returns a promise resolving to a stat detail object or +rejecting with an error stating the failure reason.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="trimmed"> + + trimmed<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<string>}</span> + </h4> + + <div class="tag-source"> + fs.js, line 260 + </div> + + </div> - <h4 class="name" id="trimmed"><span class="type-signature"></span>trimmed<span class="signature">(path)</span><span class="type-signature"> → {Promise.<string>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Read the contents of the given file, trim leading and trailing white + <div class="description"> + <p>Read the contents of the given file, trim leading and trailing white space and return the trimmed result. In case of errors, return an empty string instead.</p> <p>Note: this function is useful to read single-value files in <code>/sys</code> or <code>/proc</code>.</p> <p>This function is guaranteed to not reject its promises, on failure, an empty string will be returned.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>path</code></td> - + <td class="type"> @@ -1251,164 +2195,148 @@ an empty string will be returned.</p> </td> - - - - <td class="description last"><p>The file path to read.</p></td> + + <td class="description last"> + + <p>The file path to read.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line260">line 260</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to the file contents or the empty string -on failure.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<string> + + + </td> + <td class="description last">Returns a promise resolving to the file contents or the empty string +on failure.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="write"> + + write<span class="signature">(path, <span class="optional">data</span>, <span class="optional">mode</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<number>}</span> + </h4> + + <div class="tag-source"> + fs.js, line 187 + </div> + + </div> - <h4 class="name" id="write"><span class="type-signature"></span>write<span class="signature">(path, data<span class="signature-attributes">opt</span>, mode<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<number>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Write the given data to the specified file path. + <div class="description"> + <p>Write the given data to the specified file path. If the specified file path does not exist, it will be created, given sufficient permissions.</p> <p>Note: <code>data</code> will be converted to a string using <code>String(data)</code> or to <code>''</code> when it is <code>null</code>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>path</code></td> - + <td class="type"> @@ -1417,29 +2345,26 @@ sufficient permissions.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The file path to write to.</p></td> + <td class="description last"> + + + + + + + <p>The file path to write to.</p></td> </tr> - - - + + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -1448,32 +2373,29 @@ sufficient permissions.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The file data to write. If it is null, it will be set to an empty + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The file data to write. If it is null, it will be set to an empty string.</p></td> </tr> - - - + + + <tr> <td class="name"><code>mode</code></td> - + <td class="type"> @@ -1482,175 +2404,148 @@ string.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The permissions to use on file creation. Default is 420 (0644).</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The permissions to use on file creation. Default is 420 (0644).</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line187">line 187</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to <code>0</code> or rejecting with an error stating -the failure reason.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<number></span> - - - </dd> + + </dl> - - - - - - - <h3 class="subsection-title">Type Definitions</h3> - - - -<h4 class="name" id=".FileExecResult">FileExecResult</h4> - - - - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object</span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> + + + + + <h5>Returns:</h5> + -<table class="props"> + +<table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> - - - <th>Attributes</th> - - - - <th class="last">Description</th> </tr> </thead> - <tbody> + <tr> + + <td class="type"> + + Promise.<number> + + + </td> + <td class="description last">Returns a promise resolving to <code>0</code> or rejecting with an error stating +the failure reason.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + </dl> + + + + <h3 class="subsection-title">Type Definitions</h3> + + <dl> + +<dt> + <div class="nameContainer"> + <h4 class="name" id=".FileExecResult">LuCI.fs.FileExecResult<span class="type-signature type object">Object</span> </h4> + </div> + + +</dt> +<dd> + + + +<dl class="details"> + + + <h5 class="subsection-title">Properties:</h5> + + <dl> + +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Argument</th> + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>code</code></td> - + <td class="type"> @@ -1659,27 +2554,27 @@ the failure reason.</p> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The exit code of the invoked command</p></td> </tr> - - - + + + <tr> <td class="name"><code>stdout</code></td> - + <td class="type"> @@ -1688,29 +2583,29 @@ the failure reason.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The stdout produced by the command, if any</p></td> </tr> - - - + + + <tr> <td class="name"><code>stderr</code></td> - + <td class="type"> @@ -1719,126 +2614,98 @@ the failure reason.</p> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>The stderr produced by the command, if any</p></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line20">line 20</a> - </li></ul></dd> - - - + </dl> - - - - + + +</dd> -<h4 class="name" id=".FileStatEntry">FileStatEntry</h4> - - - - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object</span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".FileStatEntry">LuCI.fs.FileStatEntry<span class="type-signature type object">Object</span> </h4> + </div> + + +</dt> +<dd> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -1847,21 +2714,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Name of the directory entry</p></td> </tr> - - - + + + <tr> <td class="name"><code>type</code></td> - + <td class="type"> @@ -1870,21 +2737,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Type of the entry, one of <code>block</code>, <code>char</code>, <code>directory</code>, <code>fifo</code>, <code>symlink</code>, <code>file</code>, <code>socket</code> or <code>unknown</code></p></td> </tr> - - - + + + <tr> <td class="name"><code>size</code></td> - + <td class="type"> @@ -1893,21 +2760,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Size in bytes</p></td> </tr> - - - + + + <tr> <td class="name"><code>mode</code></td> - + <td class="type"> @@ -1916,21 +2783,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Access permissions</p></td> </tr> - - - + + + <tr> <td class="name"><code>atime</code></td> - + <td class="type"> @@ -1939,21 +2806,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Last access time in seconds since epoch</p></td> </tr> - - - + + + <tr> <td class="name"><code>mtime</code></td> - + <td class="type"> @@ -1962,21 +2829,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Last modification time in seconds since epoch</p></td> </tr> - - - + + + <tr> <td class="name"><code>ctime</code></td> - + <td class="type"> @@ -1985,21 +2852,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Last change time in seconds since epoch</p></td> </tr> - - - + + + <tr> <td class="name"><code>inode</code></td> - + <td class="type"> @@ -2008,21 +2875,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Inode number</p></td> </tr> - - - + + + <tr> <td class="name"><code>uid</code></td> - + <td class="type"> @@ -2031,21 +2898,21 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Numeric owner id</p></td> </tr> - - - + + + <tr> <td class="name"><code>gid</code></td> - + <td class="type"> @@ -2054,90 +2921,67 @@ the failure reason.</p> </td> - - - + + + <td class="description last"><p>Numeric group id</p></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line4">line 4</a> - </li></ul></dd> - - - + </dl> + + +</dd> - - - - - + </dl> + + </article> -</section> - +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.html b/documentation/jsapi/LuCI.html index 44f899b352..68e2042c51 100644 --- a/documentation/jsapi/LuCI.html +++ b/documentation/jsapi/LuCI.html @@ -1,94 +1,1141 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: LuCI</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: LuCI</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: LuCI</h1> - +<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#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#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#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#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#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#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#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.html">Class: LuCI</h1> + <section> - + <header> + <h2> + LuCI + </h2> - <h2><span class="attribs"><span class="type-signature"></span></span>LuCI<span class="signature">(env)</span><span class="type-signature"></span></h2> - - <div class="class-description"><p>This is the LuCI base class. It is automatically instantiated and + <div class="class-description"><p>This is the LuCI base class. It is automatically instantiated and accessible using the global <code>L</code> variable.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="LuCI"> + + new LuCI<span class="signature">(env)</span> + </h4> + + <div class="tag-source"> + luci.js, line 1 + </div> + + </div> - <h2>Constructor</h2> +</dt> +<dd> + - <h4 class="name" id="LuCI"><span class="type-signature"></span>new LuCI<span class="signature">(env)</span><span class="type-signature"></span></h4> - - - - - - - - - - - - - <h5>Parameters:</h5> + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>env</code></td> - + <td class="type"> @@ -97,92 +1144,70 @@ accessible using the global <code>L</code> variable.</p></div> </td> - - - - <td class="description last"><p>The environment settings to use for the LuCI runtime.</p></td> + + <td class="description last"> + + <p>The environment settings to use for the LuCI runtime.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1">line 1</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - + + + + + <h3 class="subsection-title">Classes</h3> - + <dl> <dt><a href="LuCI.Class.html">Class</a></dt> <dd></dd> @@ -221,141 +1246,121 @@ accessible using the global <code>L</code> variable.</p></div> <dd></dd> </dl> - - - - <h3 class="subsection-title">Members</h3> - + <dl> -<h4 class="name" id="env"><span class="type-signature"></span>env<span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>The <code>env</code> object holds environment settings used by LuCI, such +<dt> + <div class="nameContainer"> + <h4 class="name" id="env">env</h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>The <code>env</code> object holds environment settings used by LuCI, such as request timeouts, base URLs etc.</p> -</div> - - - - - - - + </div> + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1657">line 1657</a> - </li></ul></dd> - - - + + </dl> - - - - - - + +</dd> + </dl> + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="bind"> + + bind<span class="signature">(fn, self, <span class="optional">args</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{function}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1340 + </div> + + </div> - <h4 class="name" id="bind"><span class="type-signature"></span>bind<span class="signature">(fn, self, …args<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {function}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Return a bound function using the given <code>self</code> as <code>this</code> context + <div class="description"> + <p>Return a bound function using the given <code>self</code> as <code>this</code> context and any further arguments as parameters to the bound function.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>fn</code></td> - + <td class="type"> @@ -364,29 +1369,26 @@ and any further arguments as parameters to the bound function.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The function to bind.</p></td> + <td class="description last"> + + + + + + + <p>The function to bind.</p></td> </tr> - - - + + + <tr> <td class="name"><code>self</code></td> - + <td class="type"> @@ -395,29 +1397,26 @@ and any further arguments as parameters to the bound function.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The value to bind as <code>this</code> context to the specified function.</p></td> + <td class="description last"> + + + + + + + <p>The value to bind as <code>this</code> context to the specified function.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -426,176 +1425,157 @@ and any further arguments as parameters to the bound function.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>Zero or more variable arguments which are bound to the function + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Zero or more variable arguments which are bound to the function as parameters.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1340">line 1340</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the bound function.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">function</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="error"><span class="type-signature"></span>error<span class="signature">(type<span class="signature-attributes">opt</span>, fmt<span class="signature-attributes">opt</span>, …args<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>A wrapper around <a href="LuCI.html#raise"><code>raise()</code></a> which also renders -the error either as modal overlay when <code>ui.js</code> is already loaed -or directly into the view body.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + function + + + </td> + <td class="description last">Returns the bound function.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="error"> + + error<span class="signature">(<span class="optional">type</span>, <span class="optional">fmt</span>, <span class="optional">args</span>)</span> + </h4> + + + <div class="tag-source"> + luci.js, line 1300 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>A wrapper around <a href="LuCI.html#raise"><code>raise()</code></a> which also renders +the error either as modal overlay when <code>ui.js</code> is already loaed +or directly into the view body.</p> + </div> + - <tbody> + + + + + +<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>type</code></td> - + <td class="type"> @@ -607,19 +1587,7 @@ or directly into the view body.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -627,18 +1595,27 @@ or directly into the view body.</p> </td> - - <td class="description last"><p>Either a string specifying the type of the error to throw or an + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Either a string specifying the type of the error to throw or an existing <code>Error</code> instance to copy.</p></td> </tr> - - - + + + <tr> <td class="name"><code>fmt</code></td> - + <td class="type"> @@ -647,19 +1624,7 @@ existing <code>Error</code> instance to copy.</p></td> </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - <td class="default"> @@ -667,18 +1632,27 @@ existing <code>Error</code> instance to copy.</p></td> </td> - - <td class="description last"><p>A format string which is used to form the error message, together + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>A format string which is used to form the error message, together with all subsequent optional arguments.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -687,94 +1661,68 @@ with all subsequent optional arguments.</p></td> </td> - - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - <td class="default"> </td> - - <td class="description last"><p>Zero or more variable arguments to the supplied format string.</p></td> + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Zero or more variable arguments to the supplied format string.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1300">line 1300</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -784,7 +1732,6 @@ appended to the message and the type set to the given type argument or copied from the given error instance.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -798,75 +1745,74 @@ argument or copied from the given error instance.</p> </dd> </dl> </dt> - <dd></dd> </dl> + - - - - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(url, <span class="optional">args</span>, cb)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<null>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1918 + </div> + + </div> - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(url, args<span class="signature-attributes">opt</span>, cb)</span><span class="type-signature"> → {Promise.<null>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Issues a GET request to the given url and invokes the specified + <div class="description"> + <p>Issues a GET request to the given url and invokes the specified callback function. The function is a wrapper around <a href="LuCI.Request.html#request"><code>Request.request()</code></a>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -875,29 +1821,26 @@ callback function. The function is a wrapper around </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request.</p></td> + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -906,31 +1849,28 @@ callback function. The function is a wrapper around </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional query string arguments to append to the URL.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional query string arguments to append to the URL.</p></td> </tr> - - - + + + <tr> <td class="name"><code>cb</code></td> - + <td class="type"> @@ -939,286 +1879,257 @@ callback function. The function is a wrapper around </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The callback function to invoke when the request finishes.</p></td> + <td class="description last"> + + + + + + + <p>The callback function to invoke when the request finishes.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1918">line 1918</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to <code>null</code> when concluded.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<null></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<null> + + + </td> + <td class="description last">Returns a promise resolving to <code>null</code> when concluded.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="halt"> + + halt<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2040 + </div> + + </div> - <h4 class="name" id="halt"><span class="type-signature"></span>halt<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Deprecated wrapper around <code>Poll.stop()</code>.</p> + </div> - - -<div class="description"> - <p>Deprecated wrapper around <code>Poll.stop()</code>.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2040">line 2040</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the polling loop has been stopped or <code>false</code> -when it didn't run to begin with.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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 polling loop has been stopped or <code>false</code> +when it didn't run to begin with.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="hasSystemFeature"> + + hasSystemFeature<span class="signature">(feature, <span class="optional">subfeature</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean|null}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1574 + </div> + + </div> - <h4 class="name" id="hasSystemFeature"><span class="type-signature"></span>hasSystemFeature<span class="signature">(feature, subfeature<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean|null}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Test whether a particular system feature is available, such as + <div class="description"> + <p>Test whether a particular system feature is available, such as hostapd SAE support or an installed firewall. The features are queried once at the beginning of the LuCI session and cached in <code>SessionStorage</code> throughout the lifetime of the associated tab or browser window.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>feature</code></td> - + <td class="type"> @@ -1227,30 +2138,27 @@ browser window.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The feature to test. For detailed list of known feature flags, + <td class="description last"> + + + + + + + <p>The feature to test. For detailed list of known feature flags, see <code>/modules/luci-base/root/usr/libexec/rpcd/luci</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>subfeature</code></td> - + <td class="type"> @@ -1259,179 +2167,160 @@ see <code>/modules/luci-base/root/usr/libexec/rpcd/luci</code>.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Some feature classes like <code>hostapd</code> provide sub-feature flags, + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Some feature classes like <code>hostapd</code> provide sub-feature flags, such as <code>sae</code> or <code>11w</code> support. The <code>subfeature</code> argument can be used to query these.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1574">line 1574</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Return <code>true</code> if the queried feature (and sub-feature) is available + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + | + + null + + + </td> + <td class="description last">Return <code>true</code> if the queried feature (and sub-feature) is available or <code>false</code> if the requested feature isn't present or known. Return <code>null</code> when a sub-feature was queried for a feature which -has no sub-features.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> -| - -<span class="param-type">null</span> - - - </dd> -</dl> - +has no sub-features.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isObject"> + + isObject<span class="signature">(<span class="optional">val</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1765 + </div> + + </div> - <h4 class="name" id="isObject"><span class="type-signature"></span>isObject<span class="signature">(val<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Tests whether the passed argument is a JavaScript object. + <div class="description"> + <p>Tests whether the passed argument is a JavaScript object. This function is meant to be an object counterpart to the standard <code>Array.isArray()</code> function.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -1440,283 +2329,254 @@ standard <code>Array.isArray()</code> function.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The value to test</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The value to test</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1765">line 1765</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the given value is of type object and -not <code>null</code>, else returns <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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> if the given value is of type object and +not <code>null</code>, else returns <code>false</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="location"> + + location<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1745 + </div> + + </div> - <h4 class="name" id="location"><span class="type-signature"></span>location<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Return the complete URL path to the current view.</p> + </div> - - -<div class="description"> - <p>Return the complete URL path to the current view.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1745">line 1745</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the URL path to the current view.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the URL path to the current view.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="path"> + + path<span class="signature">(<span class="optional">prefix</span>, <span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1679 + </div> + + </div> - <h4 class="name" id="path"><span class="type-signature"></span>path<span class="signature">(prefix<span class="signature-attributes">opt</span>, parts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Construct a relative URL path from the given prefix and parts. + <div class="description"> + <p>Construct a relative URL path from the given prefix and parts. The resulting URL is guaranteed to only contain the characters <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well as <code>/</code> for the path separator.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>prefix</code></td> - + <td class="type"> @@ -1725,32 +2585,29 @@ as <code>/</code> for the path separator.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The prefix to join the given parts with. If the <code>prefix</code> is + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The prefix to join the given parts with. If the <code>prefix</code> is omitted, it defaults to an empty string.</p></td> </tr> - - - + + + <tr> <td class="name"><code>parts</code></td> - + <td class="type"> @@ -1759,174 +2616,155 @@ omitted, it defaults to an empty string.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An array of parts to join into an URL path. Parts may contain + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An array of parts to join into an URL path. Parts may contain slashes and any of the other characters mentioned above.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1679">line 1679</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Return the joined URL path.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="poll"><span class="type-signature"></span>poll<span class="signature">(interval, url, args<span class="signature-attributes">opt</span>, cb, post<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {function}</span></h4> - - - - -<div class="description"> - <p>Register a polling HTTP request that invokes the specified -callback function. The function is a wrapper around -<a href="LuCI.Request.poll.html#add"><code>Request.poll.add()</code></a>.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Return the joined URL path.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="poll"> + + poll<span class="signature">(interval, url, <span class="optional">args</span>, cb, <span class="optional">post</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{function}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 1988 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Register a polling HTTP request that invokes the specified +callback function. The function is a wrapper around +<a href="LuCI.Request.poll.html#add"><code>Request.poll.add()</code></a>.</p> + </div> + - <tbody> + + + + + +<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>interval</code></td> - + <td class="type"> @@ -1935,35 +2773,32 @@ callback function. The function is a wrapper around </td> - - - <td class="attributes"> - - - - - - </td> - <td class="default"> </td> - - <td class="description last"><p>The poll interval to use. If set to a value less than or equal + + <td class="description last"> + + + + + + + <p>The poll interval to use. If set to a value less than or equal to <code>0</code>, it will default to the global poll interval configured in <code>LuCI.env.pollinterval</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -1972,33 +2807,30 @@ in <code>LuCI.env.pollinterval</code>.</p></td> </td> - - <td class="attributes"> - - - - - - </td> - - <td class="default"> </td> - - <td class="description last"><p>The URL to request.</p></td> + + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -2007,37 +2839,34 @@ in <code>LuCI.env.pollinterval</code>.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> </td> - - <td class="description last"><p>Specifies additional arguments for the request. For GET requests, + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Specifies additional arguments for the request. For GET requests, the arguments are appended to the URL as query string, for POST requests, they'll be added to the request body.</p></td> </tr> - - - + + + <tr> <td class="name"><code>cb</code></td> - + <td class="type"> @@ -2046,33 +2875,30 @@ requests, they'll be added to the request body.</p></td> </td> - - - <td class="attributes"> - - - - - - </td> - <td class="default"> </td> - - <td class="description last"><p>The callback function to invoke whenever a request finishes.</p></td> + + <td class="description last"> + + + + + + + <p>The callback function to invoke whenever a request finishes.</p></td> </tr> - - - + + + <tr> <td class="name"><code>post</code></td> - + <td class="type"> @@ -2081,19 +2907,7 @@ requests, they'll be added to the request body.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -2101,169 +2915,162 @@ requests, they'll be added to the request body.</p></td> </td> - - <td class="description last"><p>When set to <code>false</code> or not specified, poll requests will be made + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>When set to <code>false</code> or not specified, poll requests will be made using the GET method. When set to <code>true</code>, POST requests will be issued. In case of POST requests, the request body will contain an argument <code>token</code> with the current value of <code>LuCI.env.token</code> by default, regardless of the parameters specified with <code>args</code>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1988">line 1988</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the internally created function that has been passed to + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + function + + + </td> + <td class="description last">Returns the internally created function that has been passed to <a href="LuCI.Request.poll.html#add"><code>Request.poll.add()</code></a>. This value can be passed to <code>Poll.remove()</code> to remove the -polling request.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">function</span> - - - </dd> -</dl> - +polling request.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="post"> + + post<span class="signature">(url, <span class="optional">args</span>, cb)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<null>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1946 + </div> + + </div> - <h4 class="name" id="post"><span class="type-signature"></span>post<span class="signature">(url, args<span class="signature-attributes">opt</span>, cb)</span><span class="type-signature"> → {Promise.<null>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Issues a POST request to the given url and invokes the specified + <div class="description"> + <p>Issues a POST request to the given url and invokes the specified callback function. The function is a wrapper around <a href="LuCI.Request.html#request"><code>Request.request()</code></a>. The request is sent using <code>application/x-www-form-urlencoded</code> encoding and will contain a field <code>token</code> with the current value of <code>LuCI.env.token</code> by default.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -2272,29 +3079,26 @@ by default.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request.</p></td> + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -2303,31 +3107,28 @@ by default.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional post arguments to append to the request body.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional post arguments to append to the request body.</p></td> </tr> - - - + + + <tr> <td class="name"><code>cb</code></td> - + <td class="type"> @@ -2336,173 +3137,154 @@ by default.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The callback function to invoke when the request finishes.</p></td> + <td class="description last"> + + + + + + + <p>The callback function to invoke when the request finishes.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1946">line 1946</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to <code>null</code> when concluded.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<null></span> - - - </dd> </dl> - - - - - - - + - <h4 class="name" id="raise"><span class="type-signature"></span>raise<span class="signature">(type<span class="signature-attributes">opt</span>, fmt<span class="signature-attributes">opt</span>, …args<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Captures the current stack trace and throws an error of the -specified type as a new exception. Also logs the exception as -error to the debug console if it is available.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<null> + + + </td> + <td class="description last">Returns a promise resolving to <code>null</code> when concluded.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="raise"> + + raise<span class="signature">(<span class="optional">type</span>, <span class="optional">fmt</span>, <span class="optional">args</span>)</span> + </h4> + + <div class="tag-source"> + luci.js, line 1234 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Captures the current stack trace and throws an error of the +specified type as a new exception. Also logs the exception as +error to the debug console if it is available.</p> + </div> + - <tbody> + + + + + +<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>type</code></td> - + <td class="type"> @@ -2514,19 +3296,7 @@ error to the debug console if it is available.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -2534,18 +3304,27 @@ error to the debug console if it is available.</p> </td> - - <td class="description last"><p>Either a string specifying the type of the error to throw or an + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Either a string specifying the type of the error to throw or an existing <code>Error</code> instance to copy.</p></td> </tr> - - - + + + <tr> <td class="name"><code>fmt</code></td> - + <td class="type"> @@ -2554,19 +3333,7 @@ existing <code>Error</code> instance to copy.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -2574,18 +3341,27 @@ existing <code>Error</code> instance to copy.</p></td> </td> - - <td class="description last"><p>A format string which is used to form the error message, together + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>A format string which is used to form the error message, together with all subsequent optional arguments.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -2594,94 +3370,68 @@ with all subsequent optional arguments.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - - <td class="default"> </td> - - <td class="description last"><p>Zero or more variable arguments to the supplied format string.</p></td> + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Zero or more variable arguments to the supplied format string.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1234">line 1234</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -2691,7 +3441,6 @@ appended to the message and the type set to the given type argument or copied from the given error instance.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2705,74 +3454,75 @@ argument or copied from the given error instance.</p> </dd> </dl> </dt> - <dd></dd> </dl> + - - - - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="require"> + + require<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<LuCI#Class>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1379 + </div> + + </div> - <h4 class="name" id="require"><span class="type-signature"></span>require<span class="signature">(name)</span><span class="type-signature"> → {Promise.<LuCI#Class>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Load an additional LuCI JavaScript class and its dependencies, + <div class="description"> + <p>Load an additional LuCI JavaScript class and its dependencies, instantiate it and return the resulting class instance. Each class is only loaded once. Subsequent attempts to load the same class will return the already instantiated class.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -2781,81 +3531,58 @@ class will return the already instantiated class.</p> </td> - - - - <td class="description last"><p>The name of the class to load in dotted notation. Dots will + + <td class="description last"> + + <p>The name of the class to load in dotted notation. Dots will be replaced by spaces and joined with the runtime-determined base URL of LuCI.js to form an absolute URL to load the class file from.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1379">line 1379</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> -<ul> - <li> + + + + <h5>Throws:</h5> + <ul> + <li> <dl> <dt> @@ -2864,7 +3591,6 @@ file from.</p></td> circular dependencies.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2878,12 +3604,11 @@ circular dependencies.</p> </dd> </dl> </dt> - <dd></dd> </dl> </li> - - <li> + + <li> <dl> <dt> @@ -2892,7 +3617,6 @@ circular dependencies.</p> call failed.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2906,12 +3630,11 @@ call failed.</p> </dd> </dl> </dt> - <dd></dd> </dl> </li> - - <li> + + <li> <dl> <dt> @@ -2920,7 +3643,6 @@ call failed.</p> be interpreted by <code>eval</code>.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2934,12 +3656,11 @@ be interpreted by <code>eval</code>.</p> </dd> </dl> </dt> - <dd></dd> </dl> </li> - - <li> + + <li> <dl> <dt> @@ -2949,7 +3670,6 @@ interpreted, but when invoking its code did not yield a valid class instance.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2963,94 +3683,102 @@ class instance.</p> </dd> </dl> </dt> - <dd></dd> </dl> </li> - </ul> - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the instantiated class.</p> -</div> - + </ul> + + + <h5>Returns:</h5> + -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<LuCI#Class></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<LuCI#Class> + + + </td> + <td class="description last">Returns the instantiated class.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="resolveDefault"> + + resolveDefault<span class="signature">(value, defvalue)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1873 + </div> + + </div> - <h4 class="name" id="resolveDefault"><span class="type-signature"></span>resolveDefault<span class="signature">(value, defvalue)</span><span class="type-signature"> → {Promise.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Returns a promise resolving with either the given value or or with + <div class="description"> + <p>Returns a promise resolving with either the given value or or with the given default in case the input value is a rejecting promise.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>value</code></td> - + <td class="type"> @@ -3059,21 +3787,21 @@ the given default in case the input value is a rejecting promise.</p> </td> - - - - <td class="description last"><p>The value to resolve the promise with.</p></td> + + <td class="description last"> + + <p>The value to resolve the promise with.</p></td> </tr> - - - + + + <tr> <td class="name"><code>defvalue</code></td> - + <td class="type"> @@ -3082,165 +3810,149 @@ the given default in case the input value is a rejecting promise.</p> </td> - - - - <td class="description last"><p>The default value to resolve the promise with in case the given + + <td class="description last"> + + <p>The default value to resolve the promise with in case the given input value is a rejecting promise.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1873">line 1873</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a new promise resolving either to the given input value or -to the given default value on error.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<*></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<*> + + + </td> + <td class="description last">Returns a new promise resolving either to the given input value or +to the given default value on error.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="resource"> + + resource<span class="signature">(<span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1732 + </div> + + </div> - <h4 class="name" id="resource"><span class="type-signature"></span>resource<span class="signature">(parts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Construct an URL path relative to the global static resource path + <div class="description"> + <p>Construct an URL path relative to the global static resource path of the LuCI ui (usually <code>/luci-static/resources</code>).</p> <p>The resulting URL is guaranteed to only contain the characters <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well as <code>/</code> for the path separator.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>parts</code></td> - + <td class="type"> @@ -3249,284 +3961,255 @@ as <code>/</code> for the path separator.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An array of parts to join into an URL path. Parts may contain + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An array of parts to join into an URL path. Parts may contain slashes and any of the other characters mentioned above.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1732">line 1732</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the resulting URL path.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the resulting URL path.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="run"> + + run<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2053 + </div> + + </div> - <h4 class="name" id="run"><span class="type-signature"></span>run<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Deprecated wrapper around <code>Poll.start()</code>.</p> + </div> - - -<div class="description"> - <p>Deprecated wrapper around <code>Poll.start()</code>.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2053">line 2053</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the polling loop has been started or <code>false</code> -when it was already running.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> </dl> - - - - - - - + - <h4 class="name" id="sortedKeys"><span class="type-signature"></span>sortedKeys<span class="signature">(obj, key<span class="signature-attributes">opt</span>, sortmode<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<string>}</span></h4> - - - - -<div class="description"> - <p>Return an array of sorted object keys, optionally sorted by -a different key or a different sorting mode.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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 polling loop has been started or <code>false</code> +when it was already running.</td> + </tr> + + </tbody> +</table> + + + + +</dd> - <th>Attributes</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="sortedKeys"> + + sortedKeys<span class="signature">(obj, <span class="optional">key</span>, <span class="optional">sortmode</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> + </h4> + - + <div class="tag-source"> + luci.js, line 1794 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Return an array of sorted object keys, optionally sorted by +a different key or a different sorting mode.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>obj</code></td> - + <td class="type"> @@ -3535,30 +4218,27 @@ a different key or a different sorting mode.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The object to extract the keys from. If the given value is + <td class="description last"> + + + + + + + <p>The object to extract the keys from. If the given value is not an object, the function will return an empty array.</p></td> </tr> - - - + + + <tr> <td class="name"><code>key</code></td> - + <td class="type"> @@ -3567,34 +4247,31 @@ not an object, the function will return an empty array.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Specifies the key to order by. This is mainly useful for + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Specifies the key to order by. This is mainly useful for nested objects of objects or objects of arrays when sorting shall not be performed by the primary object keys but by some other key pointing to a value within the nested values.</p></td> </tr> - - - + + + <tr> <td class="name"><code>sortmode</code></td> - + <td class="type"> @@ -3603,169 +4280,152 @@ some other key pointing to a value within the nested values.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>May be either <code>addr</code> or <code>num</code> to override the natural + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>May be either <code>addr</code> or <code>num</code> to override the natural lexicographic sorting with a sorting suitable for IP/MAC style addresses or numeric values respectively.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1794">line 1794</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array containing the sorted keys of the given object.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<string></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">(entry)</span><span class="type-signature"> → {boolean}</span></h4> - - - - -<div class="description"> - <p>Deprecated wrapper around <code>Poll.remove()</code>.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array containing the sorted keys of the given object.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="stop"> + + stop<span class="signature">(entry)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 2027 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Deprecated wrapper around <code>Poll.remove()</code>.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>entry</code></td> - + <td class="type"> @@ -3774,165 +4434,151 @@ addresses or numeric values respectively.</p></td> </td> - - - - <td class="description last"><p>The polling function to remove.</p></td> + + <td class="description last"> + + <p>The polling function to remove.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2027">line 2027</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the function has been removed or <code>false</code> if -it could not be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <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 function has been removed or <code>false</code> if +it could not be found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="toArray"> + + toArray<span class="signature">(val)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1839 + </div> + + </div> - <h4 class="name" id="toArray"><span class="type-signature"></span>toArray<span class="signature">(val)</span><span class="type-signature"> → {Array.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Converts the given value to an array. If the given value is of + <div class="description"> + <p>Converts the given value to an array. If the given value is of type array, it is returned as-is, values of type object are returned as one-element array containing the object, empty strings and <code>null</code> values are returned as empty array, all other values are converted using <code>String()</code>, trimmed, split on white space and returned as array.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -3941,163 +4587,147 @@ space and returned as array.</p> </td> - - - - <td class="description last"><p>The value to convert into an array.</p></td> + + <td class="description last"> + + <p>The value to convert into an array.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1839">line 1839</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the resulting array.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<*></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<*> + + + </td> + <td class="description last">Returns the resulting array.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="url"> + + url<span class="signature">(<span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1710 + </div> + + </div> - <h4 class="name" id="url"><span class="type-signature"></span>url<span class="signature">(parts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Construct an URL pathrelative to the script path of the server + <div class="description"> + <p>Construct an URL pathrelative to the script path of the server side LuCI application (usually <code>/cgi-bin/luci</code>).</p> <p>The resulting URL is guaranteed to only contain the characters <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well as <code>/</code> for the path separator.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>parts</code></td> - + <td class="type"> @@ -4106,176 +4736,159 @@ as <code>/</code> for the path separator.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An array of parts to join into an URL path. Parts may contain + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An array of parts to join into an URL path. Parts may contain slashes and any of the other characters mentioned above.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1710">line 1710</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the resulting URL path.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the resulting URL path.</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + <h3 class="subsection-title">Type Definitions</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".requestCallbackFn"> + + LuCI.requestCallbackFn<span class="signature">(xhr, data, duration)</span> + </h4> + + <div class="tag-source"> + luci.js, line 1877 + </div> + + </div> - <h4 class="name" id=".requestCallbackFn"><span class="type-signature"></span>requestCallbackFn<span class="signature">(xhr, data, duration)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The request callback function is invoked whenever an HTTP + <div class="description"> + <p>The request callback function is invoked whenever an HTTP reply to a request made using the <code>L.get()</code>, <code>L.post()</code> or <code>L.poll()</code> function is timed out or received successfully.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>xhr</code></td> - + <td class="type"> @@ -4284,21 +4897,21 @@ reply to a request made using the <code>L.get()</code>, <code>L.post()</code> or </td> - - - - <td class="description last"><p>The XMLHTTPRequest instance used to make the request.</p></td> + + <td class="description last"> + + <p>The XMLHTTPRequest instance used to make the request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -4307,22 +4920,22 @@ reply to a request made using the <code>L.get()</code>, <code>L.post()</code> or </td> - - - - <td class="description last"><p>The response JSON if the response could be parsed as such, + + <td class="description last"> + + <p>The response JSON if the response could be parsed as such, else <code>null</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>duration</code></td> - + <td class="type"> @@ -4331,106 +4944,80 @@ else <code>null</code>.</p></td> </td> - - - - <td class="description last"><p>The total duration of the request in milliseconds.</p></td> + + <td class="description last"> + + <p>The total duration of the request in milliseconds.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1877">line 1877</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + + +</dd> - - - - - - - - - - - - - - - - - + </dl> + + </article> -</section> - +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.rpc.html b/documentation/jsapi/LuCI.rpc.html index 9d548f3ad3..557b972376 100644 --- a/documentation/jsapi/LuCI.rpc.html +++ b/documentation/jsapi/LuCI.rpc.html @@ -1,193 +1,1232 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: rpc</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: rpc</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: rpc</h1> - +<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#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#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#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#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#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#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#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.rpc.html">Class: rpc</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>rpc</h2> - - <div class="class-description"><p>The <code>LuCI.rpc</code> class provides high level ubus JSON-RPC abstractions + rpc + </h2> + + <div class="class-description"><p>The <code>LuCI.rpc</code> class provides high level ubus JSON-RPC abstractions and means for listing and invoking remove RPC methods.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="rpc"> + + new LuCI.rpc<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + rpc.js, line 8 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line8">line 8</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="addInterceptor"> + + addInterceptor<span class="signature">(interceptorFn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.rpc.html#~interceptorFn">LuCI.rpc~interceptorFn</a>}</span> + </h4> + + <div class="tag-source"> + rpc.js, line 454 + </div> + + </div> - <h4 class="name" id="addInterceptor"><span class="type-signature"></span>addInterceptor<span class="signature">(interceptorFn)</span><span class="type-signature"> → {<a href="LuCI.rpc.html#~interceptorFn">LuCI.rpc~interceptorFn</a>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Registers a new interceptor function.</p> + </div> - - -<div class="description"> - <p>Registers a new interceptor function.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>interceptorFn</code></td> - + <td class="type"> @@ -196,158 +1235,144 @@ and means for listing and invoking remove RPC methods.</p></div> </td> - - - - <td class="description last"><p>The inteceptor function to register.</p></td> + + <td class="description last"> + + <p>The inteceptor function to register.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line454">line 454</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the given function value.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type"><a href="LuCI.rpc.html#~interceptorFn">LuCI.rpc~interceptorFn</a></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="declare"><span class="type-signature"></span>declare<span class="signature">(options)</span><span class="type-signature"> → {<a href="LuCI.rpc.html#~invokeFn">LuCI.rpc~invokeFn</a>}</span></h4> - - - - -<div class="description"> - <p>Describes a remote RPC call procedure and returns a function -implementing it.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.rpc.html#~interceptorFn">LuCI.rpc~interceptorFn</a> + + + </td> + <td class="description last">Returns the given function value.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="declare"> + + declare<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.rpc.html#~invokeFn">LuCI.rpc~invokeFn</a>}</span> + </h4> + + + <div class="tag-source"> + rpc.js, line 292 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Describes a remote RPC call procedure and returns a function +implementing it.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> @@ -356,381 +1381,347 @@ implementing it.</p> </td> - - - - <td class="description last"><p>If any object names are given, this function will return the method + + <td class="description last"> + + <p>If any object names are given, this function will return the method signatures of each given object.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line292">line 292</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a new function implementing the method call described in -<code>options</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type"><a href="LuCI.rpc.html#~invokeFn">LuCI.rpc~invokeFn</a></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + <a href="LuCI.rpc.html#~invokeFn">LuCI.rpc~invokeFn</a> + + + </td> + <td class="description last">Returns a new function implementing the method call described in +<code>options</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getBaseURL"> + + getBaseURL<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + rpc.js, line 367 + </div> + + </div> - <h4 class="name" id="getBaseURL"><span class="type-signature"></span>getBaseURL<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Returns the current RPC base URL.</p> + </div> - - -<div class="description"> - <p>Returns the current RPC base URL.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line367">line 367</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the RPC URL endpoint to issue requests against.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the RPC URL endpoint to issue requests against.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSessionID"> + + getSessionID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + rpc.js, line 346 + </div> + + </div> - <h4 class="name" id="getSessionID"><span class="type-signature"></span>getSessionID<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Returns the current RPC session id.</p> + </div> - - -<div class="description"> - <p>Returns the current RPC session id.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line346">line 346</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the 32 byte session ID string used for authenticating remote -requests.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="getStatusText"><span class="type-signature"></span>getStatusText<span class="signature">(statusCode)</span><span class="type-signature"> → {string}</span></h4> - - - - -<div class="description"> - <p>Translates a numeric <code>ubus</code> error code into a human readable -description.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the 32 byte session ID string used for authenticating remote +requests.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getStatusText"> + + getStatusText<span class="signature">(statusCode)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + rpc.js, line 391 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Translates a numeric <code>ubus</code> error code into a human readable +description.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>statusCode</code></td> - + <td class="type"> @@ -739,119 +1730,110 @@ description.</p> </td> - - - - <td class="description last"><p>The numeric status code.</p></td> + + <td class="description last"> + + <p>The numeric status code.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line391">line 391</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the textual description of the code.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the textual description of the code.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="list"> + + list<span class="signature">(<span class="optional">objectNames</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(Array.<string>|Object.<string, Object.<string, Object.<string, string>>>)>}</span> + </h4> + + <div class="tag-source"> + rpc.js, line 140 + </div> + + </div> - <h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">(…objectNames<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(Array.<string>|Object.<string, Object.<string, Object.<string, string>>>)>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Lists available remote ubus objects or the method signatures of + <div class="description"> + <p>Lists available remote ubus objects or the method signatures of specific objects.</p> <p>This function has two signatures and is sensitive to the number of arguments passed to it:</p> @@ -861,46 +1843,39 @@ Returns an array containing the names of all remote <code>ubus</code> objects</l <li><code>list("objname", ...)</code> Returns method signatures for each given <code>ubus</code> object name.</li> </ul> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>objectNames</code></td> - + <td class="type"> @@ -909,173 +1884,156 @@ Returns method signatures for each given <code>ubus</code> object name.</li> </td> - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>If any object names are given, this function will return the method + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>If any object names are given, this function will return the method signatures of each given object.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line140">line 140</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>When invoked without arguments, this function will return a promise + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<(Array.<string>|Object.<string, Object.<string, Object.<string, string>>>)> + + + </td> + <td class="description last">When invoked without arguments, this function will return a promise resolving to an array of <code>ubus</code> object names. When invoked with one or more arguments, a promise resolving to an object describing the method -signatures of each requested <code>ubus</code> object name will be returned.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<(Array.<string>|Object.<string, Object.<string, Object.<string, string>>>)></span> - - - </dd> -</dl> - +signatures of each requested <code>ubus</code> object name will be returned.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="removeInterceptor"> + + removeInterceptor<span class="signature">(interceptorFn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + rpc.js, line 470 + </div> + + </div> - <h4 class="name" id="removeInterceptor"><span class="type-signature"></span>removeInterceptor<span class="signature">(interceptorFn)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Removes a registered interceptor function.</p> + </div> - - -<div class="description"> - <p>Removes a registered interceptor function.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>interceptorFn</code></td> - + <td class="type"> @@ -1084,158 +2042,144 @@ signatures of each requested <code>ubus</code> object name will be returned.</p> </td> - - - - <td class="description last"><p>The inteceptor function to remove.</p></td> + + <td class="description last"> + + <p>The inteceptor function to remove.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line470">line 470</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the given function has been removed or <code>false</code> -if it has not been found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="setBaseURL"><span class="type-signature"></span>setBaseURL<span class="signature">(sid)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Set the RPC base URL to use.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> if the given function has been removed or <code>false</code> +if it has not been found.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="setBaseURL"> + + setBaseURL<span class="signature">(sid)</span> + </h4> + + + <div class="tag-source"> + rpc.js, line 377 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Set the RPC base URL to use.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>sid</code></td> - + <td class="type"> @@ -1244,135 +2188,114 @@ if it has not been found.</p> </td> - - - - <td class="description last"><p>Sets the RPC URL endpoint to issue requests against.</p></td> + + <td class="description last"> + + <p>Sets the RPC URL endpoint to issue requests against.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line377">line 377</a> - </li></ul></dd> - - - + + </dl> - - - - - - - - - - - - - - - - - - - - - + + - <h4 class="name" id="setSessionID"><span class="type-signature"></span>setSessionID<span class="signature">(sid)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Set the RPC session id to use.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + +</dd> -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - <th>Type</th> - + +<dt> + <div class="nameContainer"> + <h4 class="name" id="setSessionID"> + + setSessionID<span class="signature">(sid)</span> + </h4> + - + <div class="tag-source"> + rpc.js, line 357 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Set the RPC session id to use.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>sid</code></td> - + <td class="type"> @@ -1381,143 +2304,112 @@ if it has not been found.</p> </td> - - - - <td class="description last"><p>Sets the 32 byte session ID string used for authenticating remote + + <td class="description last"> + + <p>Sets the 32 byte session ID string used for authenticating remote requests.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line357">line 357</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - - - + + + + + + +</dd> + </dl> + + <h3 class="subsection-title">Type Definitions</h3> - + <dl> -<h4 class="name" id=".DeclareOptions">DeclareOptions</h4> - - - - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object</span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".DeclareOptions">LuCI.rpc.DeclareOptions<span class="type-signature type object">Object</span> </h4> + </div> + + +</dt> +<dd> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Argument</th> + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>object</code></td> - + <td class="type"> @@ -1526,27 +2418,27 @@ requests.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The name of the remote <code>ubus</code> object to invoke.</p></td> </tr> - - - + + + <tr> <td class="name"><code>method</code></td> - + <td class="type"> @@ -1555,27 +2447,27 @@ requests.</p></td> </td> - + <td class="attributes"> - + </td> - - + + <td class="description last"><p>The name of the remote <code>ubus</code> method to invoke.</p></td> </tr> - - - + + + <tr> <td class="name"><code>params</code></td> - + <td class="type"> @@ -1584,19 +2476,19 @@ requests.</p></td> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>Lists the named parameters expected by the remote <code>ubus</code> RPC method. The arguments passed to the resulting generated method call function will be mapped to named parameters in the order they appear in this @@ -1617,14 +2509,14 @@ argument to the remote procedure and the filter function will be invoked with <code>filterFn(reply, [ "foo" ], "bar", "baz")</code></li> </ul></td> </tr> - - - + + + <tr> <td class="name"><code>expect</code></td> - + <td class="type"> @@ -1633,19 +2525,19 @@ invoked with <code>filterFn(reply, [ "foo" ], "bar", "b </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>Describes the expected return data structure. The given object is supposed to contain a single key selecting the value to use from the returned <code>ubus</code> reply object. The value of the sole key within @@ -1677,14 +2569,14 @@ a key <code>success</code> with a boolean value. If the reply does not contain be returned as default instead.</li> </ul></td> </tr> - - - + + + <tr> <td class="name"><code>filter</code></td> - + <td class="type"> @@ -1693,131 +2585,111 @@ be returned as default instead.</li> </td> - + <td class="attributes"> <optional><br> - + </td> - - + + <td class="description last"><p>Specfies an optional filter function which is invoked to transform the received reply data before it is returned to the caller.</p></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line160">line 160</a> - </li></ul></dd> - - - + </dl> - - - - + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="~filterFn"> + + filterFn<span class="signature">(data, args, extraArgs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span> + </h4> + + <div class="tag-source"> + rpc.js, line 231 + </div> + + </div> - <h4 class="name" id="~filterFn"><span class="type-signature"></span>filterFn<span class="signature">(data, args, …extraArgs)</span><span class="type-signature"> → {*}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The filter function is invoked to transform a received <code>ubus</code> RPC call + <div class="description"> + <p>The filter function is invoked to transform a received <code>ubus</code> RPC call reply before returning it to the caller.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -1826,31 +2698,28 @@ reply before returning it to the caller.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The received <code>ubus</code> reply data or a subset of it as described in the + <td class="description last"> + + + + + + + <p>The received <code>ubus</code> reply data or a subset of it as described in the <code>expect</code> option of the RPC call declaration. In case of remote call errors, <code>data</code> is numeric <code>ubus</code> error code instead.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -1859,29 +2728,26 @@ errors, <code>data</code> is numeric <code>ubus</code> error code instead.</p></ </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The arguments the RPC method has been invoked with.</p></td> + <td class="description last"> + + + + + + + <p>The arguments the RPC method has been invoked with.</p></td> </tr> - - - + + + <tr> <td class="name"><code>extraArgs</code></td> - + <td class="type"> @@ -1890,131 +2756,119 @@ errors, <code>data</code> is numeric <code>ubus</code> error code instead.</p></ </td> - - <td class="attributes"> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>All extraneous arguments passed to the RPC method exceeding the number + <td class="description last"> + + + + + + <span class="repeatable">repeatable</span> + + + <p>All extraneous arguments passed to the RPC method exceeding the number of arguments describes in the RPC call declaration.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line231">line 231</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>The return value of the filter function will be returned to the caller -of the RPC method as-is.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">*</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + * + + + </td> + <td class="description last">The return value of the filter function will be returned to the caller +of the RPC method as-is.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="~interceptorFn"> + + interceptorFn<span class="signature">(msg, req)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<*>|*}</span> + </h4> + + <div class="tag-source"> + rpc.js, line 408 + </div> + + </div> - <h4 class="name" id="~interceptorFn"><span class="type-signature"></span>interceptorFn<span class="signature">(msg, req)</span><span class="type-signature"> → {Promise.<*>|*}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Registered interceptor functions are invoked before the standard reply + <div class="description"> + <p>Registered interceptor functions are invoked before the standard reply parsing and handling logic.</p> <p>By returning rejected promises, interceptor functions can cause the invocation function to fail, regardless of the received reply.</p> @@ -2023,44 +2877,39 @@ rewrite received replies before they're processed by the standard response handling code.</p> <p>A common use case for such functions is to detect failing RPC replies due to expired authentication in order to trigger a new login.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>msg</code></td> - + <td class="type"> @@ -2069,24 +2918,24 @@ due to expired authentication in order to trigger a new login.</p> </td> - - - - <td class="description last"><p>The unprocessed, JSON decoded remote RPC method call reply.</p> + + <td class="description last"> + + <p>The unprocessed, JSON decoded remote RPC method call reply.</p> <p>Since interceptors run before the standard parsing logic, the reply data is not verified for correctness or filtered according to <code>expect</code> and <code>filter</code> specifications in the declarations.</p></td> </tr> - - - + + + <tr> <td class="name"><code>req</code></td> - + <td class="type"> @@ -2095,173 +2944,157 @@ data is not verified for correctness or filtered according to </td> - - - - <td class="description last"><p>The related request object which is an extended variant of the + + <td class="description last"> + + <p>The related request object which is an extended variant of the declaration object, allowing access to internals of the invocation function such as <code>filter</code>, <code>expect</code> or <code>params</code> values.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line408">line 408</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Interceptor functions may return a promise to defer response + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<*> + | + + * + + + </td> + <td class="description last">Interceptor functions may return a promise to defer response processing until some delayed work completed. Any values the returned -promise resolves to are ignored.</p> -<p>When the returned promise rejects with an error, the invocation -function will fail too, forwarding the error to the caller.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<*></span> -| - -<span class="param-type">*</span> - - - </dd> -</dl> - +promise resolves to are ignored. +When the returned promise rejects with an error, the invocation +function will fail too, forwarding the error to the caller.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="~invokeFn"> + + invokeFn<span class="signature">(params)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<*>}</span> + </h4> + + <div class="tag-source"> + rpc.js, line 254 + </div> + + </div> - <h4 class="name" id="~invokeFn"><span class="type-signature"></span>invokeFn<span class="signature">(…params)</span><span class="type-signature"> → {Promise.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The generated invocation function is returned by + <div class="description"> + <p>The generated invocation function is returned by <a href="LuCI.rpc.html#declare"><code>rpc.declare()</code></a> and encapsulates a single RPC method call.</p> <p>Calling this function will execute a remote <code>ubus</code> HTTP call request using the arguments passed to it as arguments and return a promise resolving to the received reply values.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>params</code></td> - + <td class="type"> @@ -2270,145 +3103,123 @@ resolving to the received reply values.</p> </td> - - <td class="attributes"> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>The parameters to pass to the remote procedure call. The given + <td class="description last"> + + + + + + <span class="repeatable">repeatable</span> + + + <p>The parameters to pass to the remote procedure call. The given positional arguments will be named to named RPC parameters according to the names specified in the <code>params</code> array of the method declaration.</p> <p>Any additional parameters exceeding the amount of arguments in the <code>params</code> declaration are passed as private extra arguments to the declared filter function.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line254">line 254</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a promise resolving to the result data of the remote <code>ubus</code> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<*> + + + </td> + <td class="description last">Returns a promise resolving to the result data of the remote <code>ubus</code> RPC method invocation, optionally substituted and filtered according -to the <code>expect</code> and <code>filter</code> declarations.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<*></span> - - - </dd> -</dl> - +to the <code>expect</code> and <code>filter</code> declarations.</td> + </tr> + </tbody> +</table> + + + +</dd> - - - - + </dl> + + </article> -</section> - - +</section> -</div> -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.uci.html b/documentation/jsapi/LuCI.uci.html index 8a0e3e98f9..32e34eacb1 100644 --- a/documentation/jsapi/LuCI.uci.html +++ b/documentation/jsapi/LuCI.uci.html @@ -1,198 +1,1235 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: uci</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: uci</h1> - +<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#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#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#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#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#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#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#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> - <h2><span class="attribs"><span class="type-signature"></span></span> - <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 + 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> +</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"> + uci.js, line 4 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line4">line 4</a> - </li></ul></dd> - - - + + </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"> + uci.js, line 269 + </div> + + </div> - <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(config, type, name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Adds a new section of the given type to the given configuration, + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -201,29 +1238,26 @@ optionally named according to the given name.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the configuration to add the section to.</p></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"> @@ -232,29 +1266,26 @@ optionally named according to the given name.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The type of the section to add.</p></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"> @@ -263,175 +1294,156 @@ optionally named according to the given name.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The name of the section to add. If the name is omitted, an anonymous + <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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line269">line 269</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the section ID of the newly added section which is equivalent -to the given name for non-anonymous sections.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="apply"><span class="type-signature"></span>apply<span class="signature">(timeout<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<number>}</span></h4> - - - - -<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> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<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"> + uci.js, line 858 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</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> + - <tbody> + + + + + +<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"> @@ -440,19 +1452,7 @@ operation to cancel the rollback timer.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -460,267 +1460,252 @@ operation to cancel the rollback timer.</p> </td> - - <td class="description last"><p>Override the confirmation timeout after which a rollback is triggered.</p></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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line858">line 858</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving/rejecting with the <code>ubus</code> RPC status code.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<number></span> - - - </dd> -</dl> - + <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"> + uci.js, line 938 + </div> + + </div> - <h4 class="name" id="changes"><span class="type-signature"></span>changes<span class="signature">()</span><span class="type-signature"> → {Promise.<Object.<string, Array.<<a href="LuCI.uci.html#.ChangeRecord">LuCI.uci.ChangeRecord</a>>>>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Fetches uncommitted UCI changes from the remote <code>ubus</code> RPC api.</p> + </div> - - -<div class="description"> - <p>Fetches uncommitted UCI changes from the remote <code>ubus</code> RPC api.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line938">line 938</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an object containing the configuration -names as keys and arrays of related change records as values.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<Object.<string, Array.<<a href="LuCI.uci.html#.ChangeRecord">LuCI.uci.ChangeRecord</a>>>></span> - - - </dd> -</dl> - + <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"> + uci.js, line 88 + </div> + + </div> - <h4 class="name" id="createSID"><span class="type-signature"></span>createSID<span class="signature">(config)</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Generates a new, unique section ID for the given configuration.</p> + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -729,162 +1714,146 @@ by the remote <code>ubus</code> UCI api.</p> </td> - - - - <td class="description last"><p>The configuration to generate the new section ID for.</p></td> + + <td class="description last"> + + <p>The configuration to generate the new section ID for.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line88">line 88</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>A newly generated, unique section ID in the form <code>newXXXXXX</code> -where <code>X</code> denotes a hexadecimal digit.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(config, sid, option<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {null|string|Array.<string>|<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>}</span></h4> - - - - -<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> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> - <th>Attributes</th> + +<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"> + uci.js, line 443 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</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> + - <tbody> + + + + + +<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"> @@ -893,29 +1862,26 @@ option name is omitted.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the configuration to read the value from.</p></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"> @@ -924,29 +1890,26 @@ option name is omitted.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name or ID of the section to read.</p></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"> @@ -955,93 +1918,94 @@ option name is omitted.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The option name to read the value from. If the option name is + <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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line443">line 443</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <ul> + <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 @@ -1050,95 +2014,75 @@ case of <code>option</code> pointing to an UCI list.</li> 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> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> -| - -<span class="param-type">Array.<string></span> -| - -<span class="param-type"><a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a></span> - - - </dd> -</dl> - +</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"> + uci.js, line 618 + </div> + + </div> - <h4 class="name" id="get_first"><span class="type-signature"></span>get_first<span class="signature">(config, type<span class="signature-attributes">opt</span>, option<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {null|string|Array.<string>|<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Gets the value of the given option or the entire section object of + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -1147,29 +2091,26 @@ section of the entire configuration if no type is specfied.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the configuration to read the value from.</p></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"> @@ -1178,33 +2119,30 @@ section of the entire configuration if no type is specfied.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The type of the first section to find. If it is <code>null</code>, the first + <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"> @@ -1213,93 +2151,94 @@ matching the given type.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The option name to read the value from. If the option name is + <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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line618">line 618</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <ul> + <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 @@ -1308,96 +2247,78 @@ case of <code>option</code> pointing to an UCI list.</li> 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> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> -| - -<span class="param-type">Array.<string></span> -| - -<span class="param-type"><a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a></span> - - - </dd> -</dl> - +</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"> + uci.js, line 205 + </div> + + </div> - <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(config)</span><span class="type-signature"> → {Promise.<Array.<string>>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Loads the given UCI configurations from the remote <code>ubus</code> api.</p> + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -1409,164 +2330,148 @@ data.</p> </td> - - - - <td class="description last"><p>The name of the configuration or an array of configuration + + <td class="description last"> + + <p>The name of the configuration or an array of configuration names to load.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line205">line 205</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to the names of the configurations -that have been successfully loaded.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<Array.<string>></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="move"><span class="type-signature"></span>move<span class="signature">(config, sid1, sid2<span class="signature-attributes">opt</span>, after<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> - - - - -<div class="description"> - <p>Move the first specified section within the given configuration -before or after the second specified section.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<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"> + uci.js, line 718 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Move the first specified section within the given configuration +before or after the second specified section.</p> + </div> + - <tbody> + + + + + +<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"> @@ -1575,33 +2480,30 @@ before or after the second specified section.</p> </td> - - <td class="attributes"> - - - - - - </td> - - <td class="default"> </td> - - <td class="description last"><p>The configuration to move the section within.</p></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"> @@ -1610,33 +2512,30 @@ before or after the second specified section.</p> </td> - - <td class="attributes"> - - - - - - </td> - - <td class="default"> </td> - - <td class="description last"><p>The ID of the section to move within the configuration.</p></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"> @@ -1645,26 +2544,23 @@ before or after the second specified section.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> </td> - - <td class="description last"><p>The ID of the target section for the move operation. If the + + <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 @@ -1672,14 +2568,14 @@ 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"> @@ -1688,19 +2584,7 @@ is moved to the end of the configuration.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -1708,157 +2592,152 @@ is moved to the end of the configuration.</p></td> </td> - - <td class="description last"><p>When <code>true</code>, the section <code>sid1</code> is moved after the section <code>sid2</code>, + + <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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line718">line 718</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>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.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(config, sid)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Removes the section with the given ID from the given configuration.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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"> + uci.js, line 296 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Removes the section with the given ID from the given configuration.</p> + </div> + - <tbody> + + + + + +<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"> @@ -1867,21 +2746,21 @@ when either the section specified by <code>sid1</code> or by <code>sid2</code> i </td> - - - - <td class="description last"><p>The name of the configuration to remove the section from.</p></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"> @@ -1890,136 +2769,115 @@ when either the section specified by <code>sid1</code> or by <code>sid2</code> i </td> - - - - <td class="description last"><p>The ID of the section to remove.</p></td> + + <td class="description last"> + + <p>The ID of the section to remove.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line296">line 296</a> - </li></ul></dd> - - - + + </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"> + uci.js, line 119 + </div> + + </div> - <h4 class="name" id="resolveSID"><span class="type-signature"></span>resolveSID<span class="signature">(config, sid)</span><span class="type-signature"> → {string|null}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Resolves a given section ID in extended notation to the internal + <div class="description"> + <p>Resolves a given section ID in extended notation to the internal section ID value.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -2028,21 +2886,21 @@ section ID value.</p> </td> - - - - <td class="description last"><p>The configuration to resolve the section ID for.</p></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"> @@ -2051,283 +2909,257 @@ section ID value.</p> </td> - - - - <td class="description last"><p>The section ID to resolve. If the ID is in the form <code>@typename[#]</code>, + + <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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line119">line 119</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the resolved section ID or the original given ID if it was + <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.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> -| - -<span class="param-type">null</span> - - - </dd> -</dl> - +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"> + uci.js, line 772 + </div> + + </div> - <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Submits all local configuration changes to the remove <code>ubus</code> api, + <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> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line772">line 772</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an array of configuration names which -have been reloaded by the save operation.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<string></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="sections"><span class="type-signature"></span>sections<span class="signature">(config, type<span class="signature-attributes">opt</span>, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>>}</span></h4> - - - - -<div class="description"> - <p>Enumerates the sections of the given configuration, optionally -filtered by type.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <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> - <th>Attributes</th> + +<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"> + uci.js, line 384 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Enumerates the sections of the given configuration, optionally +filtered by type.</p> + </div> + - <tbody> + + + + + +<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"> @@ -2336,29 +3168,26 @@ filtered by type.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the configuration to enumerate the sections for.</p></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"> @@ -2367,32 +3196,29 @@ filtered by type.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Enumerate only sections of the given type. If omitted, enumerate + <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"> @@ -2401,171 +3227,154 @@ all sections.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An optional callback to invoke for each enumerated section.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An optional callback to invoke for each enumerated section.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line384">line 384</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a sorted array of the section objects within the given -configuration, filtered by type of a type has been specified.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>></span> - - - </dd> -</dl> - + <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"> + uci.js, line 516 + </div> + + </div> - <h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(config, sid, option, value)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Sets the value of the given option within the specified section + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -2574,21 +3383,21 @@ with a dot, the function will do nothing.</p> </td> - - - - <td class="description last"><p>The name of the configuration to set the option value in.</p></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"> @@ -2597,21 +3406,21 @@ with a dot, the function will do nothing.</p> </td> - - - - <td class="description last"><p>The name or ID of the section to set the option value in.</p></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"> @@ -2620,21 +3429,21 @@ with a dot, the function will do nothing.</p> </td> - - - - <td class="description last"><p>The option name to set the value for.</p></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"> @@ -2649,143 +3458,120 @@ with a dot, the function will do nothing.</p> </td> - - - - <td class="description last"><p>The option value to set. If the value is <code>null</code> or an empty string, + + <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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line516">line 516</a> - </li></ul></dd> - - - + + </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"> + uci.js, line 653 + </div> + + </div> - <h4 class="name" id="set_first"><span class="type-signature"></span>set_first<span class="signature">(config, type<span class="signature-attributes">opt</span>, option, value)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Sets the value of the given option within the first found section + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -2794,29 +3580,26 @@ with a dot, the function will do nothing.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the configuration to set the option value in.</p></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"> @@ -2825,33 +3608,30 @@ with a dot, the function will do nothing.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The type of the first section to find. If it is <code>null</code>, the first + <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"> @@ -2860,29 +3640,26 @@ section matching the given type is used.</p></td> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The option name to set the value for.</p></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"> @@ -2897,145 +3674,121 @@ section matching the given type is used.</p></td> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The option value to set. If the value is <code>null</code> or an empty string, + <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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line653">line 653</a> - </li></ul></dd> - - - + + </dl> - - - - - - - - - - - - - - - - - - - - - + + - <h4 class="name" id="unload"><span class="type-signature"></span>unload<span class="signature">(config)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Unloads the given UCI configurations from the local cache.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + +</dd> -<table class="params"> - <thead> - <tr> - <th>Name</th> - - - <th>Type</th> - + +<dt> + <div class="nameContainer"> + <h4 class="name" id="unload"> + + unload<span class="signature">(config)</span> + </h4> + - + <div class="tag-source"> + uci.js, line 237 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Unloads the given UCI configurations from the local cache.</p> + </div> + - <tbody> + + + + + +<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"> @@ -3047,139 +3800,118 @@ with the given value.</p></td> </td> - - - - <td class="description last"><p>The name of the configuration or an array of configuration + + <td class="description last"> + + <p>The name of the configuration or an array of configuration names to unload.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line237">line 237</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="unset"> + + unset<span class="signature">(config, sid, option)</span> + </h4> + + <div class="tag-source"> + uci.js, line 587 + </div> + + </div> - <h4 class="name" id="unset"><span class="type-signature"></span>unset<span class="signature">(config, sid, option)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Remove the given option within the specified section of the given + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -3188,21 +3920,21 @@ configuration.</p> </td> - - - - <td class="description last"><p>The name of the configuration to remove the option from.</p></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"> @@ -3211,21 +3943,21 @@ configuration.</p> </td> - - - - <td class="description last"><p>The name or ID of the section to remove the option from.</p></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"> @@ -3234,141 +3966,118 @@ configuration.</p> </td> - - - - <td class="description last"><p>The name of the option to remove.</p></td> + + <td class="description last"> + + <p>The name of the option to remove.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line587">line 587</a> - </li></ul></dd> - - - + + </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"> + uci.js, line 683 + </div> + + </div> - <h4 class="name" id="unset_first"><span class="type-signature"></span>unset_first<span class="signature">(config, type<span class="signature-attributes">opt</span>, option)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Removes the given option within the first found section of the given + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -3377,29 +4086,26 @@ of the entire config when no type has is specified.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The name of the configuration to set the option value in.</p></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"> @@ -3408,33 +4114,30 @@ of the entire config when no type has is specified.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The type of the first section to find. If it is <code>null</code>, the first + <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"> @@ -3443,155 +4146,121 @@ section matching the given type is used.</p></td> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The option name to set the value for.</p></td> + <td class="description last"> + + + + + + + <p>The option name to set the value for.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line683">line 683</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - - - + + + + + + +</dd> + </dl> + + <h3 class="subsection-title">Type Definitions</h3> - + <dl> -<h4 class="name" id=".ChangeRecord">ChangeRecord</h4> - - - - -<div class="description"> - <p>An UCI change record is a plain array containing the change operation +<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> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Array.<string></span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - + </div> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<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"> @@ -3600,22 +4269,22 @@ the operation.</p> </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"> @@ -3624,21 +4293,21 @@ the operation.</p> </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"> @@ -3647,11 +4316,11 @@ the operation.</p> </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> @@ -3671,14 +4340,14 @@ 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"> @@ -3687,11 +4356,11 @@ three elements.</li> </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> @@ -3701,119 +4370,91 @@ list option.</li> renamed.</li> </ul></td> </tr> - + + + </tbody> +</table></dl> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line887">line 887</a> - </li></ul></dd> - - - + </dl> - - - - + + +</dd> -<h4 class="name" id=".SectionObject">SectionObject</h4> - - - - -<div class="description"> - <p>A section object represents the options and their corresponding values +<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> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type">Object.<string, (boolean|number|string|Array.<string>)></span> - - - </li> - </ul> - - - - - - <h5 class="subsection-title">Properties:</h5> - + </div> + + + +<dl class="details"> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - + <h5 class="subsection-title">Properties:</h5> + <dl> - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - +<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"> @@ -3822,22 +4463,22 @@ an allowed character for normal option names.</p> </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"> @@ -3846,21 +4487,21 @@ anonymous (<code>true</code>) or named (<code>false</code>).</p></td> </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"> @@ -3869,23 +4510,23 @@ anonymous (<code>true</code>) or named (<code>false</code>).</p></td> </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"> @@ -3894,22 +4535,22 @@ being a hexadecimal digit or a string holding the name of the section.</p></td> </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"> @@ -3921,125 +4562,107 @@ section.</p></td> </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> + - </tbody> -</table> - - - - -<dl class="details"> - + - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line316">line 316</a> - </li></ul></dd> - - - + </dl> - - - - + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="~sectionsFn"> + + sectionsFn<span class="signature">(section, sid)</span> + </h4> + + <div class="tag-source"> + uci.js, line 352 + </div> + + </div> - <h4 class="name" id="~sectionsFn"><span class="type-signature"></span>sectionsFn<span class="signature">(section, sid)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The sections callback is invoked for each section found within + <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> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -4048,21 +4671,21 @@ associated name as arguments.</p> </td> - - - - <td class="description last"><p>The section object.</p></td> + + <td class="description last"> + + <p>The section object.</p></td> </tr> - - - + + + <tr> <td class="name"><code>sid</code></td> - + <td class="type"> @@ -4071,106 +4694,80 @@ associated name as arguments.</p> </td> - - - - <td class="description last"><p>The name or ID of the section.</p></td> + + <td class="description last"> + + <p>The name or ID of the section.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="uci.js.html">uci.js</a>, <a href="uci.js.html#line352">line 352</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + + +</dd> - - - - - - - - - - - - - - - - - + </dl> + + </article> -</section> +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> - -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/LuCI.view.html b/documentation/jsapi/LuCI.view.html index 4a7209ceb0..59b34cfd83 100644 --- a/documentation/jsapi/LuCI.view.html +++ b/documentation/jsapi/LuCI.view.html @@ -1,155 +1,1199 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: view</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: view</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: view</h1> - +<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#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#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#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#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#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#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#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.view.html">Class: view</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>view</h2> - - <div class="class-description"><p>The <code>view</code> class forms the basis of views and provides a standard + view + </h2> + + <div class="class-description"><p>The <code>view</code> class forms the basis of views and provides a standard set of methods to inherit from.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="view"> + + new LuCI.view<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + luci.js, line 2687 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2687">line 2687</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="addFooter"> + + addFooter<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{DocumentFragment}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2905 + </div> + + </div> - <h4 class="name" id="addFooter"><span class="type-signature"></span>addFooter<span class="signature">()</span><span class="type-signature"> → {DocumentFragment}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Renders a standard page action footer if any of the + <div class="description"> + <p>Renders a standard page action footer if any of the <code>handleSave()</code>, <code>handleSaveApply()</code> or <code>handleReset()</code> functions are defined.</p> <p>The default implementation should be sufficient for most @@ -160,119 +1204,109 @@ triggering the <code>handleSave()</code>, <code>handleSaveApply()</code> and <p>When any of these <code>handle*()</code> functions is overwritten with <code>null</code> by a view extending this class, the corresponding button will not be rendered.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2905">line 2905</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a <code>DocumentFragment</code> containing the footer bar + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + DocumentFragment + + + </td> + <td class="description last">Returns a <code>DocumentFragment</code> containing the footer bar with buttons for each corresponding <code>handle*()</code> action or an empty <code>DocumentFragment</code> if all three <code>handle*()</code> -methods are overwritten with <code>null</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">DocumentFragment</span> - - - </dd> -</dl> - +methods are overwritten with <code>null</code>.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="handleReset"> + + handleReset<span class="signature">(ev)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*|Promise.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2871 + </div> + + </div> - <h4 class="name" id="handleReset"><span class="type-signature"></span>handleReset<span class="signature">(ev)</span><span class="type-signature"> → {*|Promise.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The handleReset function is invoked when the user clicks + <div class="description"> + <p>The handleReset function is invoked when the user clicks the <code>Reset</code> button in the page action footer.</p> <p>The default implementation should be sufficient for most views using <code>form.Map()</code> based forms - it @@ -286,44 +1320,39 @@ this base class should overwrite the <code>handleReset</code> function with <code>null</code>.</p> <p>The invocation of this function is wrapped by <code>Promise.resolve()</code> so it may return Promises if needed.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>ev</code></td> - + <td class="type"> @@ -332,125 +1361,116 @@ with <code>null</code>.</p> </td> - - - - <td class="description last"><p>The DOM event that triggered the function.</p></td> + + <td class="description last"> + + <p>The DOM event that triggered the function.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2871">line 2871</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Any return values of this function are discarded, but + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + * + | + + Promise.<*> + + + </td> + <td class="description last">Any return values of this function are discarded, but passed through <code>Promise.resolve()</code> to ensure that any returned promise runs to completion before the button -is reenabled.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">*</span> -| - -<span class="param-type">Promise.<*></span> - - - </dd> -</dl> - +is reenabled.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="handleSave"> + + handleSave<span class="signature">(ev)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*|Promise.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2790 + </div> + + </div> - <h4 class="name" id="handleSave"><span class="type-signature"></span>handleSave<span class="signature">(ev)</span><span class="type-signature"> → {*|Promise.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The handleSave function is invoked when the user clicks + <div class="description"> + <p>The handleSave function is invoked when the user clicks the <code>Save</code> button in the page action footer.</p> <p>The default implementation should be sufficient for most views using <code>form.Map()</code> based forms - it @@ -464,44 +1484,39 @@ this base class should overwrite the <code>handleSave</code> function with <code>null</code>.</p> <p>The invocation of this function is wrapped by <code>Promise.resolve()</code> so it may return Promises if needed.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>ev</code></td> - + <td class="type"> @@ -510,125 +1525,116 @@ with <code>null</code>.</p> </td> - - - - <td class="description last"><p>The DOM event that triggered the function.</p></td> + + <td class="description last"> + + <p>The DOM event that triggered the function.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2790">line 2790</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Any return values of this function are discarded, but + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + * + | + + Promise.<*> + + + </td> + <td class="description last">Any return values of this function are discarded, but passed through <code>Promise.resolve()</code> to ensure that any returned promise runs to completion before the button -is reenabled.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">*</span> -| - -<span class="param-type">Promise.<*></span> - - - </dd> -</dl> - +is reenabled.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="handleSaveApply"> + + handleSaveApply<span class="signature">(ev)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*|Promise.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2834 + </div> + + </div> - <h4 class="name" id="handleSaveApply"><span class="type-signature"></span>handleSaveApply<span class="signature">(ev)</span><span class="type-signature"> → {*|Promise.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The handleSaveApply function is invoked when the user clicks + <div class="description"> + <p>The handleSaveApply function is invoked when the user clicks the <code>Save & Apply</code> button in the page action footer.</p> <p>The default implementation should be sufficient for most views using <code>form.Map()</code> based forms - it @@ -644,44 +1650,39 @@ extending this base class should overwrite the <code>handleSaveApply</code> function with <code>null</code>.</p> <p>The invocation of this function is wrapped by <code>Promise.resolve()</code> so it may return Promises if needed.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>ev</code></td> - + <td class="type"> @@ -690,125 +1691,116 @@ extending this base class should overwrite the </td> - - - - <td class="description last"><p>The DOM event that triggered the function.</p></td> + + <td class="description last"> + + <p>The DOM event that triggered the function.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2834">line 2834</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Any return values of this function are discarded, but + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + * + | + + Promise.<*> + + + </td> + <td class="description last">Any return values of this function are discarded, but passed through <code>Promise.resolve()</code> to ensure that any returned promise runs to completion before the button -is reenabled.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">*</span> -| - -<span class="param-type">Promise.<*></span> - - - </dd> -</dl> - +is reenabled.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="load"> + + <span class="type-signature ">abstract</span>load<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*|Promise.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2725 + </div> + + </div> - <h4 class="name" id="load"><span class="type-signature">(abstract) </span>load<span class="signature">()</span><span class="type-signature"> → {*|Promise.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The load function is invoked before the view is rendered.</p> + <div class="description"> + <p>The load function is invoked before the view is rendered.</p> <p>The invocation of this function is wrapped by <code>Promise.resolve()</code> so it may return Promises if needed.</p> <p>The return value of the function (or the resolved values @@ -816,119 +1808,109 @@ of the promise returned by it) will be passed as first argument to <code>render()</code>.</p> <p>This function is supposed to be overwritten by subclasses, the default implementation does nothing.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2725">line 2725</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>May return any value or a Promise resolving to any value.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">*</span> -| - -<span class="param-type">Promise.<*></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + * + | + + Promise.<*> + + + </td> + <td class="description last">May return any value or a Promise resolving to any value.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="render"> + + <span class="type-signature ">abstract</span>render<span class="signature">(load_results)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node|Promise.<Node>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2757 + </div> + + </div> - <h4 class="name" id="render"><span class="type-signature">(abstract) </span>render<span class="signature">(load_results)</span><span class="type-signature"> → {Node|Promise.<Node>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The render function is invoked after the + <div class="description"> + <p>The render function is invoked after the <a href="LuCI.view.html#load"><code>load()</code></a> function and responsible for setting up the view contents. It must return a DOM <code>Node</code> or <code>DocumentFragment</code> holding the contents to @@ -941,44 +1923,39 @@ main content area using <a href="LuCI.dom.html#append"><code>dom.append()</code></a>.</p> <p>This function is supposed to be overwritten by subclasses, the default implementation does nothing.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>load_results</code></td> - + <td class="type"> @@ -990,136 +1967,117 @@ the default implementation does nothing.</p> </td> - - - - <td class="description last"><p>This function will receive the return value of the + + <td class="description last"> + + <p>This function will receive the return value of the <a href="LuCI.view.html#load"><code>view.load()</code></a> function as first argument.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2757">line 2757</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Should return a DOM <code>Node</code> value or a <code>Promise</code> resolving -to a <code>Node</code> value.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Node</span> -| - -<span class="param-type">Promise.<Node></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Node + | + + Promise.<Node> + + + </td> + <td class="description last">Should return a DOM <code>Node</code> value or a <code>Promise</code> resolving +to a <code>Node</code> value.</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + + + </article> -</section> - +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/index.html b/documentation/jsapi/index.html index d6997c8d82..550ed9bc8c 100644 --- a/documentation/jsapi/index.html +++ b/documentation/jsapi/index.html @@ -1,26 +1,1070 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Home</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Index</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/jsdoc-default.css"> -</head> + <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":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Home</h1> - +<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#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#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#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#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#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#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#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="index.html">Index</h1> + @@ -35,16 +1079,14 @@ - - <section> - <article><h1>OpenWrt luci feed</h1> -<p><a href="https://hosted.weblate.org/engage/openwrt/?utm_source=widget"><img src="https://hosted.weblate.org/widgets/openwrt/-/svg-badge.svg" alt="Translation status"></a></p> + <article class="readme"><h1>OpenWrt luci feed</h1> +<p><a target="_blank" href="https://hosted.weblate.org/engage/openwrt/?utm_source=widget"><img src="https://hosted.weblate.org/widgets/openwrt/-/svg-badge.svg" alt="Translation status"></a></p> <h2>Description</h2> <p>This is the OpenWrt "luci"-feed containing LuCI - OpenWrt Configuration Interface.</p> <h2>Usage</h2> @@ -56,15 +1098,19 @@ ./scripts/feeds install -a -p luci </code></pre> <h2>API Reference</h2> -<p>You can browse the generated API documentation <a href="http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/documentation/api/index.html">directly on Github</a>.</p> +<p>You can browse the generated API documentation directly on Github.</p> +<ul> +<li><a target="_blank" href="http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/documentation/api/index.html">Server side Lua APIs</a></li> +<li><a target="_blank" href="http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/documentation/jsapi/index.html">Client side JavaScript APIs</a></li> +</ul> <h2>Development</h2> -<p>Documentation for developing and extending LuCI can be found <a href="https://github.com/openwrt/luci/wiki">in the Wiki</a></p> +<p>Documentation for developing and extending LuCI can be found <a target="_blank" href="https://github.com/openwrt/luci/wiki">in the Wiki</a></p> <h2>License</h2> <p>See <a href="LICENSE">LICENSE</a> file.</p> <h2>Package Guidelines</h2> <p>See <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> file.</p> <h2>Translation status</h2> -<p><a href="https://hosted.weblate.org/engage/openwrt/?utm_source=widget"><img src="https://hosted.weblate.org/widgets/openwrt/-/multi-auto.svg" alt="Translation status"></a></p></article> +<p><a target="_blank" href="https://hosted.weblate.org/engage/openwrt/?utm_source=widget"><img src="https://hosted.weblate.org/widgets/openwrt/-/multi-auto.svg" alt="Translation status"></a></p></article> </section> @@ -72,19 +1118,14 @@ -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> - -<br class="clear"> + -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> - -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file diff --git a/documentation/jsapi/styles/prettify-tomorrow.css b/documentation/jsapi/styles/prettify-tomorrow.css index b6f92a78db..aa2908c251 100644 --- a/documentation/jsapi/styles/prettify-tomorrow.css +++ b/documentation/jsapi/styles/prettify-tomorrow.css @@ -98,7 +98,7 @@ /* pre.prettyprint { background: white; - font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-family: Menlo, Monaco, Consolas, monospace; font-size: 12px; line-height: 1.5; border: 1px solid #ccc; |