docs/jsapi/LuCI.rpc.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4     <meta charset="utf-8">
   5     <title>Class: rpc</title>
   6
   7
   8     <script src="scripts/prettify/prettify.js"></script>
   9     <script src="scripts/prettify/lang-css.js"></script>
  10     <script src="scripts/jquery.min.js"></script>
  11     <!--[if lt IE 9]>
  12       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  13     <![endif]-->
  14     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  15     <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
  16     <link type="text/css" rel="stylesheet" href="styles/jaguar.css">
  17
  18
  19     <script>
  20     var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
  21     </script>
  22
  23
  24
  25 </head>
  26 <body>
  27 <div id="wrap" class="clearfix">
  28
  29 <div class="navigation">
  30     <h3 class="applicationName"><a href="index.html"></a></h3>
  31
  32     <div class="search">
  33         <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
  34     </div>
  35     <ul class="list">
  36
  37         <li class="item" data-name="LuCI">
  38             <span class="title">
  39                 <a href="LuCI.html">LuCI</a>
  40
  41             </span>
  42             <ul class="members itemMembers">
  43
  44             <span class="subtitle">Members</span>
  45
  46                 <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li>
  47
  48             </ul>
  49             <ul class="typedefs itemMembers">
  50
  51             <span class="subtitle">Typedefs</span>
  52
  53                 <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li>
  54
  55             </ul>
  56             <ul class="typedefs itemMembers">
  57
  58             </ul>
  59             <ul class="methods itemMembers">
  60
  61             <span class="subtitle">Methods</span>
  62
  63                 <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li>
  64
  65                 <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li>
  66
  67                 <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li>
  68
  69                 <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li>
  70
  71                 <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li>
  72
  73                 <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li>
  74
  75                 <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li>
  76
  77                 <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li>
  78
  79                 <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li>
  80
  81                 <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li>
  82
  83                 <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li>
  84
  85                 <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li>
  86
  87                 <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li>
  88
  89                 <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li>
  90
  91                 <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li>
  92
  93                 <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li>
  94
  95                 <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li>
  96
  97                 <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li>
  98
  99                 <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li>
 100
 101             </ul>
 102             <ul class="events itemMembers">
 103
 104             </ul>
 105         </li>
 106
 107         <li class="item" data-name="LuCI.Class">
 108             <span class="title">
 109                 <a href="LuCI.Class.html">LuCI.Class</a>
 110
 111             </span>
 112             <ul class="members itemMembers">
 113
 114             </ul>
 115             <ul class="typedefs itemMembers">
 116
 117             </ul>
 118             <ul class="typedefs itemMembers">
 119
 120             </ul>
 121             <ul class="methods itemMembers">
 122
 123             <span class="subtitle">Methods</span>
 124
 125                 <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li>
 126
 127                 <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li>
 128
 129                 <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li>
 130
 131                 <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li>
 132
 133                 <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li>
 134
 135                 <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li>
 136
 137             </ul>
 138             <ul class="events itemMembers">
 139
 140             </ul>
 141         </li>
 142
 143         <li class="item" data-name="LuCI.dom">
 144             <span class="title">
 145                 <a href="LuCI.dom.html">LuCI.dom</a>
 146
 147             </span>
 148             <ul class="members itemMembers">
 149
 150             </ul>
 151             <ul class="typedefs itemMembers">
 152
 153             <span class="subtitle">Typedefs</span>
 154
 155                 <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li>
 156
 157             </ul>
 158             <ul class="typedefs itemMembers">
 159
 160             </ul>
 161             <ul class="methods itemMembers">
 162
 163             <span class="subtitle">Methods</span>
 164
 165                 <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li>
 166
 167                 <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li>
 168
 169                 <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li>
 170
 171                 <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li>
 172
 173                 <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li>
 174
 175                 <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li>
 176
 177                 <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li>
 178
 179                 <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li>
 180
 181                 <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li>
 182
 183                 <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li>
 184
 185                 <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li>
 186
 187                 <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li>
 188
 189                 <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li>
 190
 191             </ul>
 192             <ul class="events itemMembers">
 193
 194             </ul>
 195         </li>
 196
 197         <li class="item" data-name="LuCI.fs">
 198             <span class="title">
 199                 <a href="LuCI.fs.html">LuCI.fs</a>
 200
 201             </span>
 202             <ul class="members itemMembers">
 203
 204             </ul>
 205             <ul class="typedefs itemMembers">
 206
 207             <span class="subtitle">Typedefs</span>
 208
 209                 <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li>
 210
 211                 <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li>
 212
 213             </ul>
 214             <ul class="typedefs itemMembers">
 215
 216             </ul>
 217             <ul class="methods itemMembers">
 218
 219             <span class="subtitle">Methods</span>
 220
 221                 <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li>
 222
 223                 <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li>
 224
 225                 <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li>
 226
 227                 <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li>
 228
 229                 <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li>
 230
 231                 <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li>
 232
 233                 <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li>
 234
 235                 <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li>
 236
 237             </ul>
 238             <ul class="events itemMembers">
 239
 240             </ul>
 241         </li>
 242
 243         <li class="item" data-name="LuCI.Headers">
 244             <span class="title">
 245                 <a href="LuCI.Headers.html">LuCI.Headers</a>
 246
 247             </span>
 248             <ul class="members itemMembers">
 249
 250             </ul>
 251             <ul class="typedefs itemMembers">
 252
 253             </ul>
 254             <ul class="typedefs itemMembers">
 255
 256             </ul>
 257             <ul class="methods itemMembers">
 258
 259             <span class="subtitle">Methods</span>
 260
 261                 <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li>
 262
 263                 <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li>
 264
 265             </ul>
 266             <ul class="events itemMembers">
 267
 268             </ul>
 269         </li>
 270
 271         <li class="item" data-name="LuCI.Network">
 272             <span class="title">
 273                 <a href="LuCI.Network.html">LuCI.Network</a>
 274
 275             </span>
 276             <ul class="members itemMembers">
 277
 278             </ul>
 279             <ul class="typedefs itemMembers">
 280
 281             <span class="subtitle">Typedefs</span>
 282
 283                 <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li>
 284
 285                 <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li>
 286
 287                 <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li>
 288
 289                 <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li>
 290
 291                 <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li>
 292
 293             </ul>
 294             <ul class="typedefs itemMembers">
 295
 296             </ul>
 297             <ul class="methods itemMembers">
 298
 299             <span class="subtitle">Methods</span>
 300
 301                 <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li>
 302
 303                 <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li>
 304
 305                 <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li>
 306
 307                 <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
 308
 309                 <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li>
 310
 311                 <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li>
 312
 313                 <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li>
 314
 315                 <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li>
 316
 317                 <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li>
 318
 319                 <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li>
 320
 321                 <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li>
 322
 323                 <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li>
 324
 325                 <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li>
 326
 327                 <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li>
 328
 329                 <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li>
 330
 331                 <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li>
 332
 333                 <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li>
 334
 335                 <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li>
 336
 337                 <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li>
 338
 339                 <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li>
 340
 341                 <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li>
 342
 343                 <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li>
 344
 345                 <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li>
 346
 347                 <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li>
 348
 349                 <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li>
 350
 351                 <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li>
 352
 353                 <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li>
 354
 355                 <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li>
 356
 357             </ul>
 358             <ul class="events itemMembers">
 359
 360             </ul>
 361         </li>
 362
 363         <li class="item" data-name="LuCI.Network.Device">
 364             <span class="title">
 365                 <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
 366
 367             </span>
 368             <ul class="members itemMembers">
 369
 370             </ul>
 371             <ul class="typedefs itemMembers">
 372
 373             </ul>
 374             <ul class="typedefs itemMembers">
 375
 376             </ul>
 377             <ul class="methods itemMembers">
 378
 379             <span class="subtitle">Methods</span>
 380
 381                 <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li>
 382
 383                 <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li>
 384
 385                 <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li>
 386
 387                 <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li>
 388
 389                 <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li>
 390
 391                 <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li>
 392
 393                 <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li>
 394
 395                 <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li>
 396
 397                 <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li>
 398
 399                 <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li>
 400
 401                 <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li>
 402
 403                 <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li>
 404
 405                 <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li>
 406
 407                 <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li>
 408
 409                 <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li>
 410
 411                 <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li>
 412
 413                 <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li>
 414
 415                 <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li>
 416
 417                 <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li>
 418
 419                 <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li>
 420
 421                 <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li>
 422
 423                 <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li>
 424
 425             </ul>
 426             <ul class="events itemMembers">
 427
 428             </ul>
 429         </li>
 430
 431         <li class="item" data-name="LuCI.Network.Hosts">
 432             <span class="title">
 433                 <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>
 434
 435             </span>
 436             <ul class="members itemMembers">
 437
 438             </ul>
 439             <ul class="typedefs itemMembers">
 440
 441             </ul>
 442             <ul class="typedefs itemMembers">
 443
 444             </ul>
 445             <ul class="methods itemMembers">
 446
 447             <span class="subtitle">Methods</span>
 448
 449                 <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li>
 450
 451                 <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li>
 452
 453                 <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li>
 454
 455                 <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li>
 456
 457                 <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li>
 458
 459                 <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li>
 460
 461                 <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li>
 462
 463                 <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li>
 464
 465             </ul>
 466             <ul class="events itemMembers">
 467
 468             </ul>
 469         </li>
 470
 471         <li class="item" data-name="LuCI.Network.Protocol">
 472             <span class="title">
 473                 <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
 474
 475             </span>
 476             <ul class="members itemMembers">
 477
 478             </ul>
 479             <ul class="typedefs itemMembers">
 480
 481             </ul>
 482             <ul class="typedefs itemMembers">
 483
 484             </ul>
 485             <ul class="methods itemMembers">
 486
 487             <span class="subtitle">Methods</span>
 488
 489                 <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li>
 490
 491                 <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li>
 492
 493                 <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li>
 494
 495                 <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li>
 496
 497                 <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li>
 498
 499                 <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li>
 500
 501                 <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li>
 502
 503                 <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li>
 504
 505                 <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li>
 506
 507                 <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li>
 508
 509                 <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li>
 510
 511                 <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li>
 512
 513                 <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li>
 514
 515                 <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li>
 516
 517                 <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li>
 518
 519                 <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li>
 520
 521                 <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li>
 522
 523                 <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li>
 524
 525                 <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li>
 526
 527                 <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li>
 528
 529                 <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li>
 530
 531                 <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li>
 532
 533                 <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li>
 534
 535                 <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li>
 536
 537                 <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li>
 538
 539                 <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li>
 540
 541                 <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li>
 542
 543                 <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li>
 544
 545                 <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li>
 546
 547                 <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li>
 548
 549                 <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li>
 550
 551                 <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li>
 552
 553                 <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li>
 554
 555                 <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li>
 556
 557                 <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li>
 558
 559                 <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li>
 560
 561                 <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li>
 562
 563                 <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li>
 564
 565             </ul>
 566             <ul class="events itemMembers">
 567
 568             </ul>
 569         </li>
 570
 571         <li class="item" data-name="LuCI.Network.WifiDevice">
 572             <span class="title">
 573                 <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
 574
 575             </span>
 576             <ul class="members itemMembers">
 577
 578             </ul>
 579             <ul class="typedefs itemMembers">
 580
 581             </ul>
 582             <ul class="typedefs itemMembers">
 583
 584             </ul>
 585             <ul class="methods itemMembers">
 586
 587             <span class="subtitle">Methods</span>
 588
 589                 <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li>
 590
 591                 <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
 592
 593                 <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li>
 594
 595                 <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li>
 596
 597                 <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li>
 598
 599                 <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li>
 600
 601                 <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li>
 602
 603                 <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li>
 604
 605                 <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li>
 606
 607                 <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li>
 608
 609                 <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li>
 610
 611                 <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li>
 612
 613                 <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li>
 614
 615             </ul>
 616             <ul class="events itemMembers">
 617
 618             </ul>
 619         </li>
 620
 621         <li class="item" data-name="LuCI.Network.WifiNetwork">
 622             <span class="title">
 623                 <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>
 624
 625             </span>
 626             <ul class="members itemMembers">
 627
 628             </ul>
 629             <ul class="typedefs itemMembers">
 630
 631             </ul>
 632             <ul class="typedefs itemMembers">
 633
 634             </ul>
 635             <ul class="methods itemMembers">
 636
 637             <span class="subtitle">Methods</span>
 638
 639                 <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li>
 640
 641                 <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li>
 642
 643                 <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li>
 644
 645                 <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li>
 646
 647                 <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li>
 648
 649                 <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li>
 650
 651                 <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li>
 652
 653                 <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li>
 654
 655                 <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li>
 656
 657                 <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li>
 658
 659                 <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li>
 660
 661                 <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li>
 662
 663                 <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li>
 664
 665                 <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li>
 666
 667                 <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li>
 668
 669                 <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li>
 670
 671                 <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li>
 672
 673                 <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li>
 674
 675                 <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li>
 676
 677                 <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li>
 678
 679                 <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li>
 680
 681                 <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li>
 682
 683                 <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li>
 684
 685                 <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li>
 686
 687                 <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li>
 688
 689                 <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li>
 690
 691                 <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li>
 692
 693                 <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li>
 694
 695                 <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li>
 696
 697                 <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li>
 698
 699                 <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li>
 700
 701                 <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li>
 702
 703                 <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li>
 704
 705                 <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li>
 706
 707                 <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li>
 708
 709             </ul>
 710             <ul class="events itemMembers">
 711
 712             </ul>
 713         </li>
 714
 715         <li class="item" data-name="LuCI.Poll">
 716             <span class="title">
 717                 <a href="LuCI.Poll.html">LuCI.Poll</a>
 718
 719             </span>
 720             <ul class="members itemMembers">
 721
 722             </ul>
 723             <ul class="typedefs itemMembers">
 724
 725             </ul>
 726             <ul class="typedefs itemMembers">
 727
 728             </ul>
 729             <ul class="methods itemMembers">
 730
 731             <span class="subtitle">Methods</span>
 732
 733                 <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li>
 734
 735                 <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li>
 736
 737                 <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li>
 738
 739                 <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li>
 740
 741                 <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li>
 742
 743             </ul>
 744             <ul class="events itemMembers">
 745
 746             </ul>
 747         </li>
 748
 749         <li class="item" data-name="LuCI.Request">
 750             <span class="title">
 751                 <a href="LuCI.Request.html">LuCI.Request</a>
 752
 753             </span>
 754             <ul class="members itemMembers">
 755
 756             </ul>
 757             <ul class="typedefs itemMembers">
 758
 759             <span class="subtitle">Typedefs</span>
 760
 761                 <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li>
 762
 763                 <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li>
 764
 765             </ul>
 766             <ul class="typedefs itemMembers">
 767
 768             </ul>
 769             <ul class="methods itemMembers">
 770
 771             <span class="subtitle">Methods</span>
 772
 773                 <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li>
 774
 775                 <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li>
 776
 777                 <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li>
 778
 779                 <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li>
 780
 781                 <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li>
 782
 783                 <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li>
 784
 785             </ul>
 786             <ul class="events itemMembers">
 787
 788             </ul>
 789         </li>
 790
 791         <li class="item" data-name="LuCI.Request.poll">
 792             <span class="title">
 793                 <a href="LuCI.Request.poll.html">LuCI.Request.poll</a>
 794
 795             </span>
 796             <ul class="members itemMembers">
 797
 798             </ul>
 799             <ul class="typedefs itemMembers">
 800
 801             <span class="subtitle">Typedefs</span>
 802
 803                 <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li>
 804
 805             </ul>
 806             <ul class="typedefs itemMembers">
 807
 808             </ul>
 809             <ul class="methods itemMembers">
 810
 811             <span class="subtitle">Methods</span>
 812
 813                 <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li>
 814
 815                 <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li>
 816
 817                 <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li>
 818
 819                 <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li>
 820
 821                 <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li>
 822
 823             </ul>
 824             <ul class="events itemMembers">
 825
 826             </ul>
 827         </li>
 828
 829         <li class="item" data-name="LuCI.Response">
 830             <span class="title">
 831                 <a href="LuCI.Response.html">LuCI.Response</a>
 832
 833             </span>
 834             <ul class="members itemMembers">
 835
 836             <span class="subtitle">Members</span>
 837
 838                 <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li>
 839
 840                 <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li>
 841
 842                 <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li>
 843
 844                 <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li>
 845
 846                 <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li>
 847
 848                 <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li>
 849
 850             </ul>
 851             <ul class="typedefs itemMembers">
 852
 853             </ul>
 854             <ul class="typedefs itemMembers">
 855
 856             </ul>
 857             <ul class="methods itemMembers">
 858
 859             <span class="subtitle">Methods</span>
 860
 861                 <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li>
 862
 863                 <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li>
 864
 865                 <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li>
 866
 867             </ul>
 868             <ul class="events itemMembers">
 869
 870             </ul>
 871         </li>
 872
 873         <li class="item" data-name="LuCI.rpc">
 874             <span class="title">
 875                 <a href="LuCI.rpc.html">LuCI.rpc</a>
 876
 877             </span>
 878             <ul class="members itemMembers">
 879
 880             </ul>
 881             <ul class="typedefs itemMembers">
 882
 883             <span class="subtitle">Typedefs</span>
 884
 885                 <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li>
 886
 887                 <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li>
 888
 889                 <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li>
 890
 891                 <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li>
 892
 893             </ul>
 894             <ul class="typedefs itemMembers">
 895
 896             </ul>
 897             <ul class="methods itemMembers">
 898
 899             <span class="subtitle">Methods</span>
 900
 901                 <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li>
 902
 903                 <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li>
 904
 905                 <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li>
 906
 907                 <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li>
 908
 909                 <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li>
 910
 911                 <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li>
 912
 913                 <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li>
 914
 915                 <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li>
 916
 917                 <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li>
 918
 919             </ul>
 920             <ul class="events itemMembers">
 921
 922             </ul>
 923         </li>
 924
 925         <li class="item" data-name="LuCI.uci">
 926             <span class="title">
 927                 <a href="LuCI.uci.html">LuCI.uci</a>
 928
 929             </span>
 930             <ul class="members itemMembers">
 931
 932             </ul>
 933             <ul class="typedefs itemMembers">
 934
 935             <span class="subtitle">Typedefs</span>
 936
 937                 <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li>
 938
 939                 <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li>
 940
 941                 <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li>
 942
 943             </ul>
 944             <ul class="typedefs itemMembers">
 945
 946             </ul>
 947             <ul class="methods itemMembers">
 948
 949             <span class="subtitle">Methods</span>
 950
 951                 <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li>
 952
 953                 <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li>
 954
 955                 <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li>
 956
 957                 <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li>
 958
 959                 <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li>
 960
 961                 <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li>
 962
 963                 <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li>
 964
 965                 <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li>
 966
 967                 <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li>
 968
 969                 <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li>
 970
 971                 <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li>
 972
 973                 <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li>
 974
 975                 <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li>
 976
 977                 <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li>
 978
 979                 <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li>
 980
 981                 <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li>
 982
 983                 <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li>
 984
 985             </ul>
 986             <ul class="events itemMembers">
 987
 988             </ul>
 989         </li>
 990
 991         <li class="item" data-name="LuCI.view">
 992             <span class="title">
 993                 <a href="LuCI.view.html">LuCI.view</a>
 994
 995             </span>
 996             <ul class="members itemMembers">
 997
 998             </ul>
 999             <ul class="typedefs itemMembers">
1000
1001             </ul>
1002             <ul class="typedefs itemMembers">
1003
1004             </ul>
1005             <ul class="methods itemMembers">
1006
1007             <span class="subtitle">Methods</span>
1008
1009                 <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li>
1010
1011                 <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li>
1012
1013                 <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li>
1014
1015                 <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li>
1016
1017                 <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li>
1018
1019                 <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li>
1020
1021             </ul>
1022             <ul class="events itemMembers">
1023
1024             </ul>
1025         </li>
1026
1027         <li class="item" data-name="LuCI.XHR">
1028             <span class="title">
1029                 <a href="LuCI.XHR.html">LuCI.XHR</a>
1030
1031             </span>
1032             <ul class="members itemMembers">
1033
1034             </ul>
1035             <ul class="typedefs itemMembers">
1036
1037             </ul>
1038             <ul class="typedefs itemMembers">
1039
1040             </ul>
1041             <ul class="methods itemMembers">
1042
1043             <span class="subtitle">Methods</span>
1044
1045                 <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li>
1046
1047                 <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li>
1048
1049                 <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li>
1050
1051                 <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li>
1052
1053                 <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li>
1054
1055                 <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li>
1056
1057             </ul>
1058             <ul class="events itemMembers">
1059
1060             </ul>
1061         </li>
1062
1063     </ul>
1064 </div>
1065     <div class="main">
1066         <h1 class="page-title" data-filename="LuCI.rpc.html">Class: rpc</h1>
1067
1068
1069
1070
1071 <section>
1072
1073 <header>
1074     <h2>
1075         <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>
1076
1077     rpc
1078     </h2>
1079
1080         <div class="class-description"><p>The <code>LuCI.rpc</code> class provides high level ubus JSON-RPC abstractions
1081 and means for listing and invoking remove RPC methods.</p></div>
1082
1083 </header>
1084
1085 <article>
1086     <div class="container-overview">
1087
1088
1089
1090
1091 <dt>
1092     <div class="nameContainer">
1093         <h4 class="name" id="rpc">
1094
1095             new LuCI.rpc<span class="signature">()</span>
1096         </h4>
1097
1098
1099         <div class="tag-source">
1100             rpc.js, line 8
1101         </div>
1102
1103     </div>
1104
1105
1106 </dt>
1107 <dd>
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118 <dl class="details">
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140 </dl>
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154 </dd>
1155
1156
1157     </div>
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172         <h3 class="subsection-title">Methods</h3>
1173
1174         <dl>
1175
1176 <dt>
1177     <div class="nameContainer">
1178         <h4 class="name" id="addInterceptor">
1179
1180             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>
1181         </h4>
1182
1183
1184         <div class="tag-source">
1185             rpc.js, line 454
1186         </div>
1187
1188     </div>
1189
1190
1191 </dt>
1192 <dd>
1193
1194
1195     <div class="description">
1196         <p>Registers a new interceptor function.</p>
1197     </div>
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207 <table class="params">
1208     <thead>
1209         <tr>
1210
1211                 <th>Name</th>
1212
1213
1214                 <th>Type</th>
1215
1216
1217
1218                 <th class="last">Description</th>
1219         </tr>
1220         </thead>
1221
1222         <tbody>
1223
1224
1225         <tr>
1226
1227                 <td class="name"><code>interceptorFn</code></td>
1228
1229
1230             <td class="type">
1231
1232
1233 <span class="param-type"><a href="LuCI.rpc.html#~interceptorFn">LuCI.rpc~interceptorFn</a></span>
1234
1235
1236
1237             </td>
1238
1239
1240
1241             <td class="description last">
1242
1243                 <p>The inteceptor function to register.</p></td>
1244         </tr>
1245
1246
1247         </tbody>
1248 </table>
1249
1250
1251
1252 <dl class="details">
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274 </dl>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286     <h5>Returns:</h5>
1287
1288
1289
1290 <table class="params">
1291     <thead>
1292     <tr>
1293
1294         <th>Type</th>
1295         <th class="last">Description</th>
1296     </tr>
1297     </thead>
1298     <tbody>
1299
1300         <tr>
1301
1302             <td class="type">
1303
1304                         <a href="LuCI.rpc.html#~interceptorFn">LuCI.rpc~interceptorFn</a>
1305
1306
1307             </td>
1308             <td class="description last">Returns the given function value.</td>
1309         </tr>
1310
1311     </tbody>
1312 </table>
1313
1314
1315
1316
1317 </dd>
1318
1319
1320
1321 <dt>
1322     <div class="nameContainer">
1323         <h4 class="name" id="declare">
1324
1325             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>
1326         </h4>
1327
1328
1329         <div class="tag-source">
1330             rpc.js, line 292
1331         </div>
1332
1333     </div>
1334
1335
1336 </dt>
1337 <dd>
1338
1339
1340     <div class="description">
1341         <p>Describes a remote RPC call procedure and returns a function
1342 implementing it.</p>
1343     </div>
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353 <table class="params">
1354     <thead>
1355         <tr>
1356
1357                 <th>Name</th>
1358
1359
1360                 <th>Type</th>
1361
1362
1363
1364                 <th class="last">Description</th>
1365         </tr>
1366         </thead>
1367
1368         <tbody>
1369
1370
1371         <tr>
1372
1373                 <td class="name"><code>options</code></td>
1374
1375
1376             <td class="type">
1377
1378
1379 <span class="param-type"><a href="LuCI.rpc.html#.DeclareOptions">LuCI.rpc.DeclareOptions</a></span>
1380
1381
1382
1383             </td>
1384
1385
1386
1387             <td class="description last">
1388
1389                 <p>If any object names are given, this function will return the method
1390 signatures of each given object.</p></td>
1391         </tr>
1392
1393
1394         </tbody>
1395 </table>
1396
1397
1398
1399 <dl class="details">
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421 </dl>
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433     <h5>Returns:</h5>
1434
1435
1436
1437 <table class="params">
1438     <thead>
1439     <tr>
1440
1441         <th>Type</th>
1442         <th class="last">Description</th>
1443     </tr>
1444     </thead>
1445     <tbody>
1446
1447         <tr>
1448
1449             <td class="type">
1450
1451                         <a href="LuCI.rpc.html#~invokeFn">LuCI.rpc~invokeFn</a>
1452
1453
1454             </td>
1455             <td class="description last">Returns a new function implementing the method call described in
1456 <code>options</code>.</td>
1457         </tr>
1458
1459     </tbody>
1460 </table>
1461
1462
1463
1464
1465 </dd>
1466
1467
1468
1469 <dt>
1470     <div class="nameContainer">
1471         <h4 class="name" id="getBaseURL">
1472
1473             getBaseURL<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1474         </h4>
1475
1476
1477         <div class="tag-source">
1478             rpc.js, line 367
1479         </div>
1480
1481     </div>
1482
1483
1484 </dt>
1485 <dd>
1486
1487
1488     <div class="description">
1489         <p>Returns the current RPC base URL.</p>
1490     </div>
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500 <dl class="details">
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522 </dl>
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534     <h5>Returns:</h5>
1535
1536
1537
1538 <table class="params">
1539     <thead>
1540     <tr>
1541
1542         <th>Type</th>
1543         <th class="last">Description</th>
1544     </tr>
1545     </thead>
1546     <tbody>
1547
1548         <tr>
1549
1550             <td class="type">
1551
1552                         string
1553
1554
1555             </td>
1556             <td class="description last">Returns the RPC URL endpoint to issue requests against.</td>
1557         </tr>
1558
1559     </tbody>
1560 </table>
1561
1562
1563
1564
1565 </dd>
1566
1567
1568
1569 <dt>
1570     <div class="nameContainer">
1571         <h4 class="name" id="getSessionID">
1572
1573             getSessionID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1574         </h4>
1575
1576
1577         <div class="tag-source">
1578             rpc.js, line 346
1579         </div>
1580
1581     </div>
1582
1583
1584 </dt>
1585 <dd>
1586
1587
1588     <div class="description">
1589         <p>Returns the current RPC session id.</p>
1590     </div>
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600 <dl class="details">
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622 </dl>
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634     <h5>Returns:</h5>
1635
1636
1637
1638 <table class="params">
1639     <thead>
1640     <tr>
1641
1642         <th>Type</th>
1643         <th class="last">Description</th>
1644     </tr>
1645     </thead>
1646     <tbody>
1647
1648         <tr>
1649
1650             <td class="type">
1651
1652                         string
1653
1654
1655             </td>
1656             <td class="description last">Returns the 32 byte session ID string used for authenticating remote
1657 requests.</td>
1658         </tr>
1659
1660     </tbody>
1661 </table>
1662
1663
1664
1665
1666 </dd>
1667
1668
1669
1670 <dt>
1671     <div class="nameContainer">
1672         <h4 class="name" id="getStatusText">
1673
1674             getStatusText<span class="signature">(statusCode)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1675         </h4>
1676
1677
1678         <div class="tag-source">
1679             rpc.js, line 391
1680         </div>
1681
1682     </div>
1683
1684
1685 </dt>
1686 <dd>
1687
1688
1689     <div class="description">
1690         <p>Translates a numeric <code>ubus</code> error code into a human readable
1691 description.</p>
1692     </div>
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702 <table class="params">
1703     <thead>
1704         <tr>
1705
1706                 <th>Name</th>
1707
1708
1709                 <th>Type</th>
1710
1711
1712
1713                 <th class="last">Description</th>
1714         </tr>
1715         </thead>
1716
1717         <tbody>
1718
1719
1720         <tr>
1721
1722                 <td class="name"><code>statusCode</code></td>
1723
1724
1725             <td class="type">
1726
1727
1728 <span class="param-type">number</span>
1729
1730
1731
1732             </td>
1733
1734
1735
1736             <td class="description last">
1737
1738                 <p>The numeric status code.</p></td>
1739         </tr>
1740
1741
1742         </tbody>
1743 </table>
1744
1745
1746
1747 <dl class="details">
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769 </dl>
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781     <h5>Returns:</h5>
1782
1783
1784
1785 <table class="params">
1786     <thead>
1787     <tr>
1788
1789         <th>Type</th>
1790         <th class="last">Description</th>
1791     </tr>
1792     </thead>
1793     <tbody>
1794
1795         <tr>
1796
1797             <td class="type">
1798
1799                         string
1800
1801
1802             </td>
1803             <td class="description last">Returns the textual description of the code.</td>
1804         </tr>
1805
1806     </tbody>
1807 </table>
1808
1809
1810
1811
1812 </dd>
1813
1814
1815
1816 <dt>
1817     <div class="nameContainer">
1818         <h4 class="name" id="list">
1819
1820             list<span class="signature">(<span class="optional">objectNames</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;(Array.&lt;string>|Object.&lt;string, Object.&lt;string, Object.&lt;string, string>>>)>}</span>
1821         </h4>
1822
1823
1824         <div class="tag-source">
1825             rpc.js, line 140
1826         </div>
1827
1828     </div>
1829
1830
1831 </dt>
1832 <dd>
1833
1834
1835     <div class="description">
1836         <p>Lists available remote ubus objects or the method signatures of
1837 specific objects.</p>
1838 <p>This function has two signatures and is sensitive to the number of
1839 arguments passed to it:</p>
1840 <ul>
1841 <li><code>list()</code> -
1842 Returns an array containing the names of all remote <code>ubus</code> objects</li>
1843 <li><code>list(&quot;objname&quot;, ...)</code>
1844 Returns method signatures for each given <code>ubus</code> object name.</li>
1845 </ul>
1846     </div>
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856 <table class="params">
1857     <thead>
1858         <tr>
1859
1860                 <th>Name</th>
1861
1862
1863                 <th>Type</th>
1864
1865
1866
1867                 <th class="last">Description</th>
1868         </tr>
1869         </thead>
1870
1871         <tbody>
1872
1873
1874         <tr>
1875
1876                 <td class="name"><code>objectNames</code></td>
1877
1878
1879             <td class="type">
1880
1881
1882 <span class="param-type">string</span>
1883
1884
1885
1886             </td>
1887
1888
1889
1890             <td class="description last">
1891
1892
1893                         <span class="optional">optional</span>
1894
1895
1896
1897
1898                         <span class="repeatable">repeatable</span>
1899
1900
1901                 <p>If any object names are given, this function will return the method
1902 signatures of each given object.</p></td>
1903         </tr>
1904
1905
1906         </tbody>
1907 </table>
1908
1909
1910
1911 <dl class="details">
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933 </dl>
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945     <h5>Returns:</h5>
1946
1947
1948
1949 <table class="params">
1950     <thead>
1951     <tr>
1952
1953         <th>Type</th>
1954         <th class="last">Description</th>
1955     </tr>
1956     </thead>
1957     <tbody>
1958
1959         <tr>
1960
1961             <td class="type">
1962
1963                         Promise.&lt;(Array.&lt;string>|Object.&lt;string, Object.&lt;string, Object.&lt;string, string>>>)>
1964
1965
1966             </td>
1967             <td class="description last">When invoked without arguments, this function will return a promise
1968 resolving to an array of <code>ubus</code> object names. When invoked with one or
1969 more arguments, a promise resolving to an object describing the method
1970 signatures of each requested <code>ubus</code> object name will be returned.</td>
1971         </tr>
1972
1973     </tbody>
1974 </table>
1975
1976
1977
1978
1979 </dd>
1980
1981
1982
1983 <dt>
1984     <div class="nameContainer">
1985         <h4 class="name" id="removeInterceptor">
1986
1987             removeInterceptor<span class="signature">(interceptorFn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
1988         </h4>
1989
1990
1991         <div class="tag-source">
1992             rpc.js, line 470
1993         </div>
1994
1995     </div>
1996
1997
1998 </dt>
1999 <dd>
2000
2001
2002     <div class="description">
2003         <p>Removes a registered interceptor function.</p>
2004     </div>
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014 <table class="params">
2015     <thead>
2016         <tr>
2017
2018                 <th>Name</th>
2019
2020
2021                 <th>Type</th>
2022
2023
2024
2025                 <th class="last">Description</th>
2026         </tr>
2027         </thead>
2028
2029         <tbody>
2030
2031
2032         <tr>
2033
2034                 <td class="name"><code>interceptorFn</code></td>
2035
2036
2037             <td class="type">
2038
2039
2040 <span class="param-type"><a href="LuCI.rpc.html#~interceptorFn">LuCI.rpc~interceptorFn</a></span>
2041
2042
2043
2044             </td>
2045
2046
2047
2048             <td class="description last">
2049
2050                 <p>The inteceptor function to remove.</p></td>
2051         </tr>
2052
2053
2054         </tbody>
2055 </table>
2056
2057
2058
2059 <dl class="details">
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081 </dl>
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093     <h5>Returns:</h5>
2094
2095
2096
2097 <table class="params">
2098     <thead>
2099     <tr>
2100
2101         <th>Type</th>
2102         <th class="last">Description</th>
2103     </tr>
2104     </thead>
2105     <tbody>
2106
2107         <tr>
2108
2109             <td class="type">
2110
2111                         boolean
2112
2113
2114             </td>
2115             <td class="description last">Returns <code>true</code> if the given function has been removed or <code>false</code>
2116 if it has not been found.</td>
2117         </tr>
2118
2119     </tbody>
2120 </table>
2121
2122
2123
2124
2125 </dd>
2126
2127
2128
2129 <dt>
2130     <div class="nameContainer">
2131         <h4 class="name" id="setBaseURL">
2132
2133             setBaseURL<span class="signature">(sid)</span>
2134         </h4>
2135
2136
2137         <div class="tag-source">
2138             rpc.js, line 377
2139         </div>
2140
2141     </div>
2142
2143
2144 </dt>
2145 <dd>
2146
2147
2148     <div class="description">
2149         <p>Set the RPC base URL to use.</p>
2150     </div>
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160 <table class="params">
2161     <thead>
2162         <tr>
2163
2164                 <th>Name</th>
2165
2166
2167                 <th>Type</th>
2168
2169
2170
2171                 <th class="last">Description</th>
2172         </tr>
2173         </thead>
2174
2175         <tbody>
2176
2177
2178         <tr>
2179
2180                 <td class="name"><code>sid</code></td>
2181
2182
2183             <td class="type">
2184
2185
2186 <span class="param-type">string</span>
2187
2188
2189
2190             </td>
2191
2192
2193
2194             <td class="description last">
2195
2196                 <p>Sets the RPC URL endpoint to issue requests against.</p></td>
2197         </tr>
2198
2199
2200         </tbody>
2201 </table>
2202
2203
2204
2205 <dl class="details">
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227 </dl>
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241 </dd>
2242
2243
2244
2245 <dt>
2246     <div class="nameContainer">
2247         <h4 class="name" id="setSessionID">
2248
2249             setSessionID<span class="signature">(sid)</span>
2250         </h4>
2251
2252
2253         <div class="tag-source">
2254             rpc.js, line 357
2255         </div>
2256
2257     </div>
2258
2259
2260 </dt>
2261 <dd>
2262
2263
2264     <div class="description">
2265         <p>Set the RPC session id to use.</p>
2266     </div>
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276 <table class="params">
2277     <thead>
2278         <tr>
2279
2280                 <th>Name</th>
2281
2282
2283                 <th>Type</th>
2284
2285
2286
2287                 <th class="last">Description</th>
2288         </tr>
2289         </thead>
2290
2291         <tbody>
2292
2293
2294         <tr>
2295
2296                 <td class="name"><code>sid</code></td>
2297
2298
2299             <td class="type">
2300
2301
2302 <span class="param-type">string</span>
2303
2304
2305
2306             </td>
2307
2308
2309
2310             <td class="description last">
2311
2312                 <p>Sets the 32 byte session ID string used for authenticating remote
2313 requests.</p></td>
2314         </tr>
2315
2316
2317         </tbody>
2318 </table>
2319
2320
2321
2322 <dl class="details">
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344 </dl>
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358 </dd>
2359
2360         </dl>
2361
2362
2363
2364         <h3 class="subsection-title">Type Definitions</h3>
2365
2366         <dl>
2367
2368 <dt>
2369     <div class="nameContainer">
2370         <h4 class="name" id=".DeclareOptions">LuCI.rpc.DeclareOptions<span class="type-signature type object">Object</span> </h4>
2371     </div>
2372
2373
2374 </dt>
2375 <dd>
2376
2377
2378
2379 <dl class="details">
2380
2381
2382         <h5 class="subsection-title">Properties:</h5>
2383
2384         <dl>
2385
2386 <table class="props">
2387     <thead>
2388         <tr>
2389
2390                 <th>Name</th>
2391
2392
2393                 <th>Type</th>
2394
2395
2396                 <th>Argument</th>
2397
2398
2399
2400
2401                 <th class="last">Description</th>
2402         </tr>
2403         </thead>
2404
2405         <tbody>
2406
2407
2408         <tr>
2409
2410                 <td class="name"><code>object</code></td>
2411
2412
2413             <td class="type">
2414
2415
2416 <span class="param-type">string</span>
2417
2418
2419
2420             </td>
2421
2422
2423                 <td class="attributes">
2424
2425
2426
2427                 </td>
2428
2429
2430
2431
2432             <td class="description last"><p>The name of the remote <code>ubus</code> object to invoke.</p></td>
2433         </tr>
2434
2435
2436
2437         <tr>
2438
2439                 <td class="name"><code>method</code></td>
2440
2441
2442             <td class="type">
2443
2444
2445 <span class="param-type">string</span>
2446
2447
2448
2449             </td>
2450
2451
2452                 <td class="attributes">
2453
2454
2455
2456                 </td>
2457
2458
2459
2460
2461             <td class="description last"><p>The name of the remote <code>ubus</code> method to invoke.</p></td>
2462         </tr>
2463
2464
2465
2466         <tr>
2467
2468                 <td class="name"><code>params</code></td>
2469
2470
2471             <td class="type">
2472
2473
2474 <span class="param-type">Array.&lt;string></span>
2475
2476
2477
2478             </td>
2479
2480
2481                 <td class="attributes">
2482
2483                     &lt;optional><br>
2484
2485
2486
2487                 </td>
2488
2489
2490
2491
2492             <td class="description last"><p>Lists the named parameters expected by the remote <code>ubus</code> RPC method.
2493 The arguments passed to the resulting generated method call function
2494 will be mapped to named parameters in the order they appear in this
2495 array.</p>
2496 <p>Extraneous parameters passed to the generated function will not be
2497 sent to the remote procedure but are passed to the
2498 <a href="LuCI.rpc.html#~filterFn"><code>filter function</code></a> if one is specified.</p>
2499 <p>Examples:</p>
2500 <ul>
2501 <li><code>params: [ &quot;foo&quot;, &quot;bar&quot; ]</code> -
2502 When the resulting call function is invoked with <code>fn(true, false)</code>,
2503 the corresponding args object sent to the remote procedure will be
2504 <code>{ foo: true, bar: false }</code>.</li>
2505 <li><code>params: [ &quot;test&quot; ], filter: function(reply, args, extra) { ... }</code> -
2506 When the resultung generated function is invoked with
2507 <code>fn(&quot;foo&quot;, &quot;bar&quot;, &quot;baz&quot;)</code> then <code>{ &quot;test&quot;: &quot;foo&quot; }</code> will be sent as
2508 argument to the remote procedure and the filter function will be
2509 invoked with <code>filterFn(reply, [ &quot;foo&quot; ], &quot;bar&quot;, &quot;baz&quot;)</code></li>
2510 </ul></td>
2511         </tr>
2512
2513
2514
2515         <tr>
2516
2517                 <td class="name"><code>expect</code></td>
2518
2519
2520             <td class="type">
2521
2522
2523 <span class="param-type">Object.&lt;string, *></span>
2524
2525
2526
2527             </td>
2528
2529
2530                 <td class="attributes">
2531
2532                     &lt;optional><br>
2533
2534
2535
2536                 </td>
2537
2538
2539
2540
2541             <td class="description last"><p>Describes the expected return data structure. The given object is
2542 supposed to contain a single key selecting the value to use from
2543 the returned <code>ubus</code> reply object. The value of the sole key within
2544 the <code>expect</code> object is used to infer the expected type of the received
2545 <code>ubus</code> reply data.</p>
2546 <p>If the received data does not contain <code>expect</code>'s key, or if the
2547 type of the data differs from the type of the value in the expect
2548 object, the expect object's value is returned as default instead.</p>
2549 <p>The key in the <code>expect</code> object may be an empty string (<code>''</code>) in which
2550 case the entire reply object is selected instead of one of its subkeys.</p>
2551 <p>If the <code>expect</code> option is omitted, the received reply will be returned
2552 as-is, regardless of its format or type.</p>
2553 <p>Examples:</p>
2554 <ul>
2555 <li><code>expect: { '': { error: 'Invalid response' } }</code> -
2556 This requires the entire <code>ubus</code> reply to be a plain JavaScript
2557 object. If the reply isn't an object but e.g. an array or a numeric
2558 error code instead, it will get replaced with
2559 <code>{ error: 'Invalid response' }</code> instead.</li>
2560 <li><code>expect: { results: [] }</code> -
2561 This requires the received <code>ubus</code> reply to be an object containing
2562 a key <code>results</code> with an array as value. If the received reply does
2563 not contain such a key, or if <code>reply.results</code> points to a non-array
2564 value, the empty array (<code>[]</code>) will be used instead.</li>
2565 <li><code>expect: { success: false }</code> -
2566 This requires the received <code>ubus</code> reply to be an object containing
2567 a key <code>success</code> with a boolean value. If the reply does not contain
2568 <code>success</code> or if <code>reply.success</code> is not a boolean value, <code>false</code> will
2569 be returned as default instead.</li>
2570 </ul></td>
2571         </tr>
2572
2573
2574
2575         <tr>
2576
2577                 <td class="name"><code>filter</code></td>
2578
2579
2580             <td class="type">
2581
2582
2583 <span class="param-type"><a href="LuCI.rpc.html#~filterFn">LuCI.rpc~filterFn</a></span>
2584
2585
2586
2587             </td>
2588
2589
2590                 <td class="attributes">
2591
2592                     &lt;optional><br>
2593
2594
2595
2596                 </td>
2597
2598
2599
2600
2601             <td class="description last"><p>Specfies an optional filter function which is invoked to transform the
2602 received reply data before it is returned to the caller.</p></td>
2603         </tr>
2604
2605
2606         </tbody>
2607 </table></dl>
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630 </dl>
2631
2632
2633
2634 </dd>
2635
2636
2637
2638 <dt>
2639     <div class="nameContainer">
2640         <h4 class="name" id="~filterFn">
2641
2642             filterFn<span class="signature">(data, args, extraArgs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
2643         </h4>
2644
2645
2646         <div class="tag-source">
2647             rpc.js, line 231
2648         </div>
2649
2650     </div>
2651
2652
2653 </dt>
2654 <dd>
2655
2656
2657     <div class="description">
2658         <p>The filter function is invoked to transform a received <code>ubus</code> RPC call
2659 reply before returning it to the caller.</p>
2660     </div>
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670 <table class="params">
2671     <thead>
2672         <tr>
2673
2674                 <th>Name</th>
2675
2676
2677                 <th>Type</th>
2678
2679
2680
2681                 <th class="last">Description</th>
2682         </tr>
2683         </thead>
2684
2685         <tbody>
2686
2687
2688         <tr>
2689
2690                 <td class="name"><code>data</code></td>
2691
2692
2693             <td class="type">
2694
2695
2696 <span class="param-type">*</span>
2697
2698
2699
2700             </td>
2701
2702
2703
2704             <td class="description last">
2705
2706
2707
2708
2709
2710
2711                 <p>The received <code>ubus</code> reply data or a subset of it as described in the
2712 <code>expect</code> option of the RPC call declaration. In case of remote call
2713 errors, <code>data</code> is numeric <code>ubus</code> error code instead.</p></td>
2714         </tr>
2715
2716
2717
2718         <tr>
2719
2720                 <td class="name"><code>args</code></td>
2721
2722
2723             <td class="type">
2724
2725
2726 <span class="param-type">Array.&lt;*></span>
2727
2728
2729
2730             </td>
2731
2732
2733
2734             <td class="description last">
2735
2736
2737
2738
2739
2740
2741                 <p>The arguments the RPC method has been invoked with.</p></td>
2742         </tr>
2743
2744
2745
2746         <tr>
2747
2748                 <td class="name"><code>extraArgs</code></td>
2749
2750
2751             <td class="type">
2752
2753
2754 <span class="param-type">*</span>
2755
2756
2757
2758             </td>
2759
2760
2761
2762             <td class="description last">
2763
2764
2765
2766
2767
2768                         <span class="repeatable">repeatable</span>
2769
2770
2771                 <p>All extraneous arguments passed to the RPC method exceeding the number
2772 of arguments describes in the RPC call declaration.</p></td>
2773         </tr>
2774
2775
2776         </tbody>
2777 </table>
2778
2779
2780
2781 <dl class="details">
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803 </dl>
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815     <h5>Returns:</h5>
2816
2817
2818
2819 <table class="params">
2820     <thead>
2821     <tr>
2822
2823         <th>Type</th>
2824         <th class="last">Description</th>
2825     </tr>
2826     </thead>
2827     <tbody>
2828
2829         <tr>
2830
2831             <td class="type">
2832
2833                         *
2834
2835
2836             </td>
2837             <td class="description last">The return value of the filter function will be returned to the caller
2838 of the RPC method as-is.</td>
2839         </tr>
2840
2841     </tbody>
2842 </table>
2843
2844
2845
2846
2847 </dd>
2848
2849
2850
2851 <dt>
2852     <div class="nameContainer">
2853         <h4 class="name" id="~interceptorFn">
2854
2855             interceptorFn<span class="signature">(msg, req)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;*>|*}</span>
2856         </h4>
2857
2858
2859         <div class="tag-source">
2860             rpc.js, line 408
2861         </div>
2862
2863     </div>
2864
2865
2866 </dt>
2867 <dd>
2868
2869
2870     <div class="description">
2871         <p>Registered interceptor functions are invoked before the standard reply
2872 parsing and handling logic.</p>
2873 <p>By returning rejected promises, interceptor functions can cause the
2874 invocation function to fail, regardless of the received reply.</p>
2875 <p>Interceptors may also modify their message argument in-place to
2876 rewrite received replies before they're processed by the standard
2877 response handling code.</p>
2878 <p>A common use case for such functions is to detect failing RPC replies
2879 due to expired authentication in order to trigger a new login.</p>
2880     </div>
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890 <table class="params">
2891     <thead>
2892         <tr>
2893
2894                 <th>Name</th>
2895
2896
2897                 <th>Type</th>
2898
2899
2900
2901                 <th class="last">Description</th>
2902         </tr>
2903         </thead>
2904
2905         <tbody>
2906
2907
2908         <tr>
2909
2910                 <td class="name"><code>msg</code></td>
2911
2912
2913             <td class="type">
2914
2915
2916 <span class="param-type">*</span>
2917
2918
2919
2920             </td>
2921
2922
2923
2924             <td class="description last">
2925
2926                 <p>The unprocessed, JSON decoded remote RPC method call reply.</p>
2927 <p>Since interceptors run before the standard parsing logic, the reply
2928 data is not verified for correctness or filtered according to
2929 <code>expect</code> and <code>filter</code> specifications in the declarations.</p></td>
2930         </tr>
2931
2932
2933
2934         <tr>
2935
2936                 <td class="name"><code>req</code></td>
2937
2938
2939             <td class="type">
2940
2941
2942 <span class="param-type">Object</span>
2943
2944
2945
2946             </td>
2947
2948
2949
2950             <td class="description last">
2951
2952                 <p>The related request object which is an extended variant of the
2953 declaration object, allowing access to internals of the invocation
2954 function such as <code>filter</code>, <code>expect</code> or <code>params</code> values.</p></td>
2955         </tr>
2956
2957
2958         </tbody>
2959 </table>
2960
2961
2962
2963 <dl class="details">
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985 </dl>
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997     <h5>Returns:</h5>
2998
2999
3000
3001 <table class="params">
3002     <thead>
3003     <tr>
3004
3005         <th>Type</th>
3006         <th class="last">Description</th>
3007     </tr>
3008     </thead>
3009     <tbody>
3010
3011         <tr>
3012
3013             <td class="type">
3014
3015                         Promise.&lt;*>
3016                          |
3017
3018                         *
3019
3020
3021             </td>
3022             <td class="description last">Interceptor functions may return a promise to defer response
3023 processing until some delayed work completed. Any values the returned
3024 promise resolves to are ignored.
3025 When the returned promise rejects with an error, the invocation
3026 function will fail too, forwarding the error to the caller.</td>
3027         </tr>
3028
3029     </tbody>
3030 </table>
3031
3032
3033
3034
3035 </dd>
3036
3037
3038
3039 <dt>
3040     <div class="nameContainer">
3041         <h4 class="name" id="~invokeFn">
3042
3043             invokeFn<span class="signature">(params)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;*>}</span>
3044         </h4>
3045
3046
3047         <div class="tag-source">
3048             rpc.js, line 254
3049         </div>
3050
3051     </div>
3052
3053
3054 </dt>
3055 <dd>
3056
3057
3058     <div class="description">
3059         <p>The generated invocation function is returned by
3060 <a href="LuCI.rpc.html#declare"><code>rpc.declare()</code></a> and encapsulates a single
3061 RPC method call.</p>
3062 <p>Calling this function will execute a remote <code>ubus</code> HTTP call request
3063 using the arguments passed to it as arguments and return a promise
3064 resolving to the received reply values.</p>
3065     </div>
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075 <table class="params">
3076     <thead>
3077         <tr>
3078
3079                 <th>Name</th>
3080
3081
3082                 <th>Type</th>
3083
3084
3085
3086                 <th class="last">Description</th>
3087         </tr>
3088         </thead>
3089
3090         <tbody>
3091
3092
3093         <tr>
3094
3095                 <td class="name"><code>params</code></td>
3096
3097
3098             <td class="type">
3099
3100
3101 <span class="param-type">*</span>
3102
3103
3104
3105             </td>
3106
3107
3108
3109             <td class="description last">
3110
3111
3112
3113
3114
3115                         <span class="repeatable">repeatable</span>
3116
3117
3118                 <p>The parameters to pass to the remote procedure call. The given
3119 positional arguments will be named to named RPC parameters according
3120 to the names specified in the <code>params</code> array of the method declaration.</p>
3121 <p>Any additional parameters exceeding the amount of arguments in the
3122 <code>params</code> declaration are passed as private extra arguments to the
3123 declared filter function.</p></td>
3124         </tr>
3125
3126
3127         </tbody>
3128 </table>
3129
3130
3131
3132 <dl class="details">
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154 </dl>
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166     <h5>Returns:</h5>
3167
3168
3169
3170 <table class="params">
3171     <thead>
3172     <tr>
3173
3174         <th>Type</th>
3175         <th class="last">Description</th>
3176     </tr>
3177     </thead>
3178     <tbody>
3179
3180         <tr>
3181
3182             <td class="type">
3183
3184                         Promise.&lt;*>
3185
3186
3187             </td>
3188             <td class="description last">Returns a promise resolving to the result data of the remote <code>ubus</code>
3189 RPC method invocation, optionally substituted and filtered according
3190 to the <code>expect</code> and <code>filter</code> declarations.</td>
3191         </tr>
3192
3193     </tbody>
3194 </table>
3195
3196
3197
3198
3199 </dd>
3200
3201             </dl>
3202
3203
3204
3205
3206
3207 </article>
3208
3209 </section>
3210
3211
3212
3213
3214
3215
3216
3217         <footer>
3218             Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
3219         </footer>
3220     </div>
3221 </div>
3222 <script>prettyPrint();</script>
3223 <script src="scripts/jaguar.js"></script>
3224 </body>
3225 </html>