From c1f972df1bb9a54048b4e6243c32e3ee856dd176 Mon Sep 17 00:00:00 2001 From: Paul Spooren Date: Wed, 6 Oct 2021 19:06:28 -1000 Subject: docs: remove static jsapi content It should be dynamically created by a CI rather than being updated manually. This should result to more accurate docs. Signed-off-by: Paul Spooren --- docs/jsapi/LuCI.session.html | 4089 ------------------------------------------ 1 file changed, 4089 deletions(-) delete mode 100644 docs/jsapi/LuCI.session.html (limited to 'docs/jsapi/LuCI.session.html') diff --git a/docs/jsapi/LuCI.session.html b/docs/jsapi/LuCI.session.html deleted file mode 100644 index 298f6dbd50..0000000000 --- a/docs/jsapi/LuCI.session.html +++ /dev/null @@ -1,4089 +0,0 @@ - - - - - Class: session - - - - - - - - - - - - - - - - - -
- -
-

- -
- -
- -
-
-

Class: session

- - - - -
- -
-

- LuCI. - - session -

- -

The session class provides various session related functionality.

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

- - new LuCI.session() -

- - -
- luci.js, line 1828 -
- -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Methods

- -
- -
-
-

- - getID(){string} -

- - -
- luci.js, line 1845 -
- -
- - -
-
- - -
-

Retrieve the current session ID.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns the current session ID.
- - - - -
- - - -
-
-

- - getLocalData(key){*} -

- - -
- luci.js, line 1870 -
- -
- - -
-
- - -
-

Retrieve data from the local session storage.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -string - - - - - - - optional - - - - - -

The key to retrieve from the session data store. If omitted, all -session data will be returned.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - * - - - Returns the stored session data or null if the given key wasn't -found.
- - - - -
- - - -
-
-

- - getToken(){string|null} -

- - -
- luci.js, line 1855 -
- -
- - -
-
- - -
-

Retrieve the current session token.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - | - - null - - - Returns the current session token or null if not logged in.
- - - - -
- - - -
-
-

- - setLocalData(key, value){boolean} -

- - -
- luci.js, line 1904 -
- -
- - -
-
- - -
-

Set data in the local session storage.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -string - - - - - -

The key to set in the session data store.

value - - -* - - - - - -

The value to store. It will be internally converted to JSON before -being put in the session store.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true if the data could be stored or false on error.
- - - - -
- -
- - - - - - - -
- -
- - - - - - - -
- Documentation generated by JSDoc 3.6.3 on Thu Aug 06 2020 17:58:02 GMT+0200 (Central European Summer Time) -
-
-
- - - - \ No newline at end of file -- cgit v1.2.3