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.Poll.html | 1878 ------------------------------------ 1 file changed, 1878 deletions(-) delete mode 100644 documentation/jsapi/LuCI.Poll.html (limited to 'documentation/jsapi/LuCI.Poll.html') diff --git a/documentation/jsapi/LuCI.Poll.html b/documentation/jsapi/LuCI.Poll.html deleted file mode 100644 index a00c9a3acb..0000000000 --- a/documentation/jsapi/LuCI.Poll.html +++ /dev/null @@ -1,1878 +0,0 @@ - - - - - Class: Poll - - - - - - - - - - - - - - - - - -
- -
-

- -
- -
- -
-
-

Class: Poll

- - - - -
- -
-

- LuCI. - - Poll -

- -

The Poll class allows registering and unregistering poll actions, -as well as starting, stopping and querying the state of the polling -loop.

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

- - new LuCI.Poll() -

- - -
- luci.js, line 999 -
- -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Methods

- -
- -
-
-

- - active(){boolean} -

- - -
- luci.js, line 1150 -
- -
- - -
-
- - -
-

Test whether the polling loop is running.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - -
    -
  • Returns true if polling is active, else false.
    • -
- - - - -
- - - -
-
-

- - add(fn, interval){boolean} -

- - -
- luci.js, line 1023 -
- -
- - -
-
- - -
-

Add a new operation to the polling loop. If the polling loop is not -already started at this point, it will be implicitely started.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
fn - - -function - - - - - -

The function to invoke on each poll interval.

interval - - -number - - - - - -

The poll interval in seconds.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - -
Throws:
- - - -
-
-
-

Throws TypeError when an invalid interval was passed.

-
-
-
-
-
- Type -
-
- -TypeError - - -
-
-
-
- - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true if the function has been added or false if it -already is registered.
- - - - -
- - - -
-
-

- - remove(fn){boolean} -

- - -
- luci.js, line 1064 -
- -
- - -
-
- - -
-

Remove an operation from the polling loop. If no further operatons -are registered, the polling loop is implicitely stopped.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
fn - - -function - - - - - -

The function to remove.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - -
Throws:
- - - -
-
-
-

Throws TypeError when the given argument isn't a function.

-
-
-
-
-
- Type -
-
- -TypeError - - -
-
-
-
- - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true if the function has been removed or false if it -wasn't found.
- - - - -
- - - -
-
-

- - start(){boolean} -

- - -
- luci.js, line 1090 -
- -
- - -
-
- - -
-

(Re)start the polling loop. Dispatches a custom poll-start event -to the document object upon successful start.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true if polling has been started (or if no functions -where registered) or false when the polling loop already runs.
- - - - -
- - - -
-
-

- - stop(){boolean} -

- - -
- luci.js, line 1115 -
- -
- - -
-
- - -
-

Stop the polling loop. Dispatches a custom poll-stop event -to the document object upon successful stop.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true if polling has been stopped or false if it din't -run to begin with.
- - - - -
- -
- - - - - - - -
- -
- - - - - - - -
- 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