From baa727de93db009f90d70a80a9861758a24eae77 Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Tue, 5 Nov 2019 10:27:59 +0100 Subject: docs: rename documentation folder to docs Signed-off-by: Jo-Philipp Wich --- documentation/jsapi/LuCI.rpc.html | 3225 ------------------------------------- 1 file changed, 3225 deletions(-) delete mode 100644 documentation/jsapi/LuCI.rpc.html (limited to 'documentation/jsapi/LuCI.rpc.html') diff --git a/documentation/jsapi/LuCI.rpc.html b/documentation/jsapi/LuCI.rpc.html deleted file mode 100644 index 557b972376..0000000000 --- a/documentation/jsapi/LuCI.rpc.html +++ /dev/null @@ -1,3225 +0,0 @@ - - - - - Class: rpc - - - - - - - - - - - - - - - - - -
- -
-

- -
- -
- -
-
-

Class: rpc

- - - - -
- -
-

- LuCI. - - rpc -

- -

The LuCI.rpc class provides high level ubus JSON-RPC abstractions -and means for listing and invoking remove RPC methods.

- -
- -
-
- - - - -
-
-

- - new LuCI.rpc() -

- - -
- rpc.js, line 8 -
- -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Methods

- -
- -
-
-

- - addInterceptor(interceptorFn){LuCI.rpc~interceptorFn} -

- - -
- rpc.js, line 454 -
- -
- - -
-
- - -
-

Registers a new interceptor function.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
interceptorFn - - -LuCI.rpc~interceptorFn - - - - - -

The inteceptor function to register.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - LuCI.rpc~interceptorFn - - - Returns the given function value.
- - - - -
- - - -
-
-

- - declare(options){LuCI.rpc~invokeFn} -

- - -
- rpc.js, line 292 -
- -
- - -
-
- - -
-

Describes a remote RPC call procedure and returns a function -implementing it.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
options - - -LuCI.rpc.DeclareOptions - - - - - -

If any object names are given, this function will return the method -signatures of each given object.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - LuCI.rpc~invokeFn - - - Returns a new function implementing the method call described in -options.
- - - - -
- - - -
-
-

- - getBaseURL(){string} -

- - -
- rpc.js, line 367 -
- -
- - -
-
- - -
-

Returns the current RPC base URL.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns the RPC URL endpoint to issue requests against.
- - - - -
- - - -
-
-

- - getSessionID(){string} -

- - -
- rpc.js, line 346 -
- -
- - -
-
- - -
-

Returns the current RPC session id.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns the 32 byte session ID string used for authenticating remote -requests.
- - - - -
- - - -
-
-

- - getStatusText(statusCode){string} -

- - -
- rpc.js, line 391 -
- -
- - -
-
- - -
-

Translates a numeric ubus error code into a human readable -description.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
statusCode - - -number - - - - - -

The numeric status code.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns the textual description of the code.
- - - - -
- - - -
-
-

- - list(objectNames){Promise.<(Array.<string>|Object.<string, Object.<string, Object.<string, string>>>)>} -

- - -
- rpc.js, line 140 -
- -
- - -
-
- - -
-

Lists available remote ubus objects or the method signatures of -specific objects.

-

This function has two signatures and is sensitive to the number of -arguments passed to it:

-
    -
  • list() - -Returns an array containing the names of all remote ubus objects
    • -
  • list("objname", ...) -Returns method signatures for each given ubus object name.
    • -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
objectNames - - -string - - - - - - - optional - - - - - repeatable - - -

If any object names are given, this function will return the method -signatures of each given object.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - Promise.<(Array.<string>|Object.<string, Object.<string, Object.<string, string>>>)> - - - When invoked without arguments, this function will return a promise -resolving to an array of ubus object names. When invoked with one or -more arguments, a promise resolving to an object describing the method -signatures of each requested ubus object name will be returned.
- - - - -
- - - -
-
-

- - removeInterceptor(interceptorFn){boolean} -

- - -
- rpc.js, line 470 -
- -
- - -
-
- - -
-

Removes a registered interceptor function.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
interceptorFn - - -LuCI.rpc~interceptorFn - - - - - -

The inteceptor function to remove.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true if the given function has been removed or false -if it has not been found.
- - - - -
- - - -
-
-

- - setBaseURL(sid) -

- - -
- rpc.js, line 377 -
- -
- - -
-
- - -
-

Set the RPC base URL to use.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
sid - - -string - - - - - -

Sets the RPC URL endpoint to issue requests against.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
-

- - setSessionID(sid) -

- - -
- rpc.js, line 357 -
- -
- - -
-
- - -
-

Set the RPC session id to use.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
sid - - -string - - - - - -

Sets the 32 byte session ID string used for authenticating remote -requests.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- -
- - - -

Type Definitions

- -
- -
-
-

LuCI.rpc.DeclareOptionsObject

-
- - -
-
- - - -
- - -
Properties:
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
object - - -string - - - - - - - -

The name of the remote ubus object to invoke.

method - - -string - - - - - - - -

The name of the remote ubus method to invoke.

params - - -Array.<string> - - - - - - <optional>
- - - -

Lists the named parameters expected by the remote ubus RPC method. -The arguments passed to the resulting generated method call function -will be mapped to named parameters in the order they appear in this -array.

-

Extraneous parameters passed to the generated function will not be -sent to the remote procedure but are passed to the -filter function if one is specified.

-

Examples:

-
    -
  • params: [ "foo", "bar" ] - -When the resulting call function is invoked with fn(true, false), -the corresponding args object sent to the remote procedure will be -{ foo: true, bar: false }.
    • -
  • params: [ "test" ], filter: function(reply, args, extra) { ... } - -When the resultung generated function is invoked with -fn("foo", "bar", "baz") then { "test": "foo" } will be sent as -argument to the remote procedure and the filter function will be -invoked with filterFn(reply, [ "foo" ], "bar", "baz")
    • -
expect - - -Object.<string, *> - - - - - - <optional>
- - - -

Describes the expected return data structure. The given object is -supposed to contain a single key selecting the value to use from -the returned ubus reply object. The value of the sole key within -the expect object is used to infer the expected type of the received -ubus reply data.

-

If the received data does not contain expect's key, or if the -type of the data differs from the type of the value in the expect -object, the expect object's value is returned as default instead.

-

The key in the expect object may be an empty string ('') in which -case the entire reply object is selected instead of one of its subkeys.

-

If the expect option is omitted, the received reply will be returned -as-is, regardless of its format or type.

-

Examples:

-
    -
  • expect: { '': { error: 'Invalid response' } } - -This requires the entire ubus reply to be a plain JavaScript -object. If the reply isn't an object but e.g. an array or a numeric -error code instead, it will get replaced with -{ error: 'Invalid response' } instead.
    • -
  • expect: { results: [] } - -This requires the received ubus reply to be an object containing -a key results with an array as value. If the received reply does -not contain such a key, or if reply.results points to a non-array -value, the empty array ([]) will be used instead.
    • -
  • expect: { success: false } - -This requires the received ubus reply to be an object containing -a key success with a boolean value. If the reply does not contain -success or if reply.success is not a boolean value, false will -be returned as default instead.
    • -
filter - - -LuCI.rpc~filterFn - - - - - - <optional>
- - - -

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

- - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - -
-
-

- - filterFn(data, args, extraArgs){*} -

- - -
- rpc.js, line 231 -
- -
- - -
-
- - -
-

The filter function is invoked to transform a received ubus RPC call -reply before returning it to the caller.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -* - - - - - - - - - - -

The received ubus reply data or a subset of it as described in the -expect option of the RPC call declaration. In case of remote call -errors, data is numeric ubus error code instead.

args - - -Array.<*> - - - - - - - - - - -

The arguments the RPC method has been invoked with.

extraArgs - - -* - - - - - - - - - - repeatable - - -

All extraneous arguments passed to the RPC method exceeding the number -of arguments describes in the RPC call declaration.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - * - - - The return value of the filter function will be returned to the caller -of the RPC method as-is.
- - - - -
- - - -
-
-

- - interceptorFn(msg, req){Promise.<*>|*} -

- - -
- rpc.js, line 408 -
- -
- - -
-
- - -
-

Registered interceptor functions are invoked before the standard reply -parsing and handling logic.

-

By returning rejected promises, interceptor functions can cause the -invocation function to fail, regardless of the received reply.

-

Interceptors may also modify their message argument in-place to -rewrite received replies before they're processed by the standard -response handling code.

-

A common use case for such functions is to detect failing RPC replies -due to expired authentication in order to trigger a new login.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
msg - - -* - - - - - -

The unprocessed, JSON decoded remote RPC method call reply.

-

Since interceptors run before the standard parsing logic, the reply -data is not verified for correctness or filtered according to -expect and filter specifications in the declarations.

req - - -Object - - - - - -

The related request object which is an extended variant of the -declaration object, allowing access to internals of the invocation -function such as filter, expect or params values.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - Promise.<*> - | - - * - - - Interceptor functions may return a promise to defer response -processing until some delayed work completed. Any values the returned -promise resolves to are ignored. -When the returned promise rejects with an error, the invocation -function will fail too, forwarding the error to the caller.
- - - - -
- - - -
-
-

- - invokeFn(params){Promise.<*>} -

- - -
- rpc.js, line 254 -
- -
- - -
-
- - -
-

The generated invocation function is returned by -rpc.declare() and encapsulates a single -RPC method call.

-

Calling this function will execute a remote ubus HTTP call request -using the arguments passed to it as arguments and return a promise -resolving to the received reply values.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -* - - - - - - - - - - repeatable - - -

The parameters to pass to the remote procedure call. The given -positional arguments will be named to named RPC parameters according -to the names specified in the params array of the method declaration.

-

Any additional parameters exceeding the amount of arguments in the -params declaration are passed as private extra arguments to the -declared filter function.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - Promise.<*> - - - Returns a promise resolving to the result data of the remote ubus -RPC method invocation, optionally substituted and filtered according -to the expect and filter declarations.
- - - - -
- -
- - - - - -
- -
- - - - - - - -
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) -
-
-
- - - - \ No newline at end of file -- cgit v1.2.3