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 --- docs/jsapi/LuCI.XHR.html | 2047 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2047 insertions(+) create mode 100644 docs/jsapi/LuCI.XHR.html (limited to 'docs/jsapi/LuCI.XHR.html') diff --git a/docs/jsapi/LuCI.XHR.html b/docs/jsapi/LuCI.XHR.html new file mode 100644 index 0000000000..5a17dfa855 --- /dev/null +++ b/docs/jsapi/LuCI.XHR.html @@ -0,0 +1,2047 @@ + + + + + Class: XHR + + + + + + + + + + + + + + + + + +
+ +
+

+ +
+ +
+ +
+
+

Class: XHR

+ + + + +
+ +
+

+ LuCI. + + XHR +

+ +

The LuCI.XHR class is a legacy compatibility shim for the +functionality formerly provided by xhr.js. It is registered as global +window.XHR symbol for compatibility with legacy code.

+

New code should use LuCI.Request instead to implement HTTP +request handling.

+ +
+ +
+
+ + + + +
+
+

+ + new LuCI.XHR() +

+ + +
+ luci.js, line 2943 +
+ +
+ + +
+
+ + + + + + + + + + +
+ + + + + + + +
Deprecated
  • Yes
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

+ + abort() +

+ + +
+ luci.js, line 3046 +
+ +
+ + +
+
+ + +
+

Ignored for backwards compatibility.

+

This function does nothing.

+
+ + + + + + + + + +
+ + + + + + + +
Deprecated
  • Yes
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+
+

+ + busy(){boolean} +

+ + +
+ luci.js, line 3035 +
+ +
+ + +
+
+ + +
+

Checks the running state of the request.

+
+ + + + + + + + + +
+ + + + + + + +
Deprecated
  • Yes
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + + + + + + + + + + + + + + + + + + + +
TypeDescription
+ + boolean + + + Returns true if the request is still running or false if it +already completed.
+ + + + +
+ + + +
+
+

+ + cancel() +

+ + +
+ luci.js, line 3022 +
+ +
+ + +
+
+ + +
+

Cancels a running request.

+

This function does not actually cancel the underlying +XMLHTTPRequest request but it sets a flag which prevents the +invocation of the callback function when the request eventually +finishes or timed out.

+
+ + + + + + + + + +
+ + + + + + + +
Deprecated
  • Yes
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+
+

+ + get(url, data, callback, timeout){Promise.<null>} +

+ + +
+ luci.js, line 2978 +
+ +
+ + +
+
+ + +
+

This function is a legacy wrapper around +LuCI.get().

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
url + + +string + + + + + + + + + + +

The URL to request

data + + +Object + + + + + + + optional + + + + + +

Additional query string data

callback + + +LuCI.requestCallbackFn + + + + + + + optional + + + + + +

Callback function to invoke on completion

timeout + + +number + + + + + + + optional + + + + + +

Request timeout to use

+ + + +
+ + + + + + + +
Deprecated
  • Yes
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + + + + + + + + + + + + + + + + + + + +
TypeDescription
+ + Promise.<null> + + +
+ + + + +
+ + + +
+
+

+ + post(url, data, callback, timeout){Promise.<null>} +

+ + +
+ luci.js, line 3005 +
+ +
+ + +
+
+ + +
+

This function is a legacy wrapper around +LuCI.post().

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
url + + +string + + + + + + + + + + +

The URL to request

data + + +Object + + + + + + + optional + + + + + +

Additional data to append to the request body.

callback + + +LuCI.requestCallbackFn + + + + + + + optional + + + + + +

Callback function to invoke on completion

timeout + + +number + + + + + + + optional + + + + + +

Request timeout to use

+ + + +
+ + + + + + + +
Deprecated
  • Yes
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + + + + + + + + + + + + + + + + + + + +
TypeDescription
+ + Promise.<null> + + +
+ + + + +
+ + + +
+
+

+ + send_form() +

+ + +
+ luci.js, line 3061 +
+ +
+ + +
+
+ + +
+

Existing for backwards compatibility.

+

This function simply throws an InternalError when invoked.

+
+ + + + + + + + + +
+ + + + + + + +
Deprecated
  • Yes
+ + + + + + + + + + + + + + + +
+ + + + + + + + + +
Throws:
+ + + +
+
+
+

Throws an InternalError with the message Not implemented +when invoked.

+
+
+
+
+
+ Type +
+
+ +InternalError + + +
+
+
+
+ + + + + + + +
+ +
+ + + + + + + +
+ +
+ + + + + + + +
+ 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