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