From 3f1d6870ff0b3a0e8e0fc1c63ae2fbee86775261 Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Thu, 16 Apr 2020 13:26:27 +0200 Subject: docs: update js api docs Signed-off-by: Jo-Philipp Wich --- docs/jsapi/LuCI.rpc.html | 185 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 172 insertions(+), 13 deletions(-) (limited to 'docs/jsapi/LuCI.rpc.html') diff --git a/docs/jsapi/LuCI.rpc.html b/docs/jsapi/LuCI.rpc.html index b3d5f4a6fd..9015182904 100644 --- a/docs/jsapi/LuCI.rpc.html +++ b/docs/jsapi/LuCI.rpc.html @@ -74,12 +74,16 @@
  • error
    • +
  • fspath
    • +
  • get
  • halt
  • hasSystemFeature
    • +
  • hasViewPermission
    • +
  • isObject
  • location
    • @@ -331,6 +335,8 @@
  • optional
    • +
  • readonly
    • +
  • rmempty
  • uciconfig
    • @@ -423,6 +429,8 @@
  • placeholder
    • +
  • readonly
    • +
  • rmempty
  • uciconfig
    • @@ -511,6 +519,8 @@
  • placeholder
    • +
  • readonly
    • +
  • rmempty
  • uciconfig
    • @@ -595,6 +605,8 @@
  • placeholder
    • +
  • readonly
    • +
  • rmempty
  • uciconfig
    • @@ -687,6 +699,8 @@
  • placeholder
    • +
  • readonly
    • +
  • rmempty
  • uciconfig
    • @@ -775,6 +789,8 @@
  • placeholder
    • +
  • readonly
    • +
  • rmempty
  • uciconfig
    • @@ -929,6 +945,8 @@
  • placeholder
    • +
  • readonly
    • +
  • rmempty
  • uciconfig
    • @@ -997,6 +1015,10 @@ +
  • + + LuCI.ui.menu + + +
      + +
    + +
      + +
    + +
      + +
    +
    • +
  • LuCI.ui.Select @@ -3328,7 +3426,7 @@ and means for listing and invoking remove RPC methods.

    - rpc.js, line 456 + rpc.js, line 465
    @@ -3473,7 +3571,7 @@ and means for listing and invoking remove RPC methods.

    - rpc.js, line 294 + rpc.js, line 302
    @@ -3621,7 +3719,7 @@ signatures of each given object.

    - rpc.js, line 369 + rpc.js, line 378
    @@ -3721,7 +3819,7 @@ signatures of each given object.

    - rpc.js, line 348 + rpc.js, line 357
    @@ -3822,7 +3920,7 @@ requests.
    - rpc.js, line 393 + rpc.js, line 402
    @@ -3968,7 +4066,7 @@ description.

    - rpc.js, line 142 + rpc.js, line 146
    @@ -4135,7 +4233,7 @@ signatures of each requested ubus object name will be returned. - rpc.js, line 472 + rpc.js, line 481 @@ -4281,7 +4379,7 @@ if it has not been found.
    - rpc.js, line 379 + rpc.js, line 388
    @@ -4397,7 +4495,7 @@ if it has not been found.
    - rpc.js, line 359 + rpc.js, line 368
    @@ -4543,6 +4641,8 @@ requests.

    + Default + Description @@ -4574,6 +4674,10 @@ requests.

    + + + +

    The name of the remote ubus object to invoke.

    @@ -4603,6 +4707,10 @@ requests.

    + + + +

    The name of the remote ubus method to invoke.

    @@ -4634,6 +4742,10 @@ requests.

    + + + +

    Lists the named parameters expected by the remote ubus RPC method. The arguments passed to the resulting generated method call function @@ -4683,6 +4795,10 @@ invoked with filterFn(reply, [ "foo" ], "bar", "b + + + +

    Describes the expected return data structure. The given object is supposed to contain a single key selecting the value to use from @@ -4743,12 +4859,55 @@ be returned as default instead.

    • + + + +

    Specfies an optional filter function which is invoked to transform the received reply data before it is returned to the caller.

    + + + + reject + + + + + +boolean + + + + + + + + + <optional>
    + + + + + + + + + + false + + + + +

    If set to true, non-zero ubus call status codes are treated as fatal +error and lead to the rejection of the call promise. The default +behaviour is to resolve with the call return code value instead.

    + + + @@ -4790,7 +4949,7 @@ received reply data before it is returned to the caller.

    - rpc.js, line 233 + rpc.js, line 241
    @@ -5003,7 +5162,7 @@ of the RPC method as-is.
    - rpc.js, line 410 + rpc.js, line 419
    @@ -5191,7 +5350,7 @@ function will fail too, forwarding the error to the caller.
    - rpc.js, line 256 + rpc.js, line 264
    @@ -5361,7 +5520,7 @@ to the expect and filter declarations. -- cgit v1.2.3