From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-security-mgr/-init-.html | 15 ++++ .../-security-mgr/after-error.html | 15 ++++ .../-security-mgr/after-login.html | 15 ++++ .../-security-mgr/index.html | 83 ++++++++++++++++++++++ .../-security-mgr/login.html | 20 ++++++ .../-security-mgr/with-auth.html | 18 +++++ 6 files changed, 166 insertions(+) create mode 100644 api1/pl.treksoft.kvision.remote/-security-mgr/-init-.html create mode 100644 api1/pl.treksoft.kvision.remote/-security-mgr/after-error.html create mode 100644 api1/pl.treksoft.kvision.remote/-security-mgr/after-login.html create mode 100644 api1/pl.treksoft.kvision.remote/-security-mgr/index.html create mode 100644 api1/pl.treksoft.kvision.remote/-security-mgr/login.html create mode 100644 api1/pl.treksoft.kvision.remote/-security-mgr/with-auth.html (limited to 'api1/pl.treksoft.kvision.remote/-security-mgr') diff --git a/api1/pl.treksoft.kvision.remote/-security-mgr/-init-.html b/api1/pl.treksoft.kvision.remote/-security-mgr/-init-.html new file mode 100644 index 00000000..d276e99a --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-security-mgr/-init-.html @@ -0,0 +1,15 @@ + + + +SecurityMgr.<init> - kvision + + + +kvision / pl.treksoft.kvision.remote / SecurityMgr / <init>
+
+

<init>

+ +SecurityMgr() +

Form login dispatcher.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-security-mgr/after-error.html b/api1/pl.treksoft.kvision.remote/-security-mgr/after-error.html new file mode 100644 index 00000000..68c357da --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-security-mgr/after-error.html @@ -0,0 +1,15 @@ + + + +SecurityMgr.afterError - kvision + + + +kvision / pl.treksoft.kvision.remote / SecurityMgr / afterError
+
+

afterError

+ +open suspend fun afterError(): Unit +

Method called after error.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-security-mgr/after-login.html b/api1/pl.treksoft.kvision.remote/-security-mgr/after-login.html new file mode 100644 index 00000000..f018290f --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-security-mgr/after-login.html @@ -0,0 +1,15 @@ + + + +SecurityMgr.afterLogin - kvision + + + +kvision / pl.treksoft.kvision.remote / SecurityMgr / afterLogin
+
+

afterLogin

+ +open suspend fun afterLogin(): Unit +

Method called after successful login.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-security-mgr/index.html b/api1/pl.treksoft.kvision.remote/-security-mgr/index.html new file mode 100644 index 00000000..625ecad1 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-security-mgr/index.html @@ -0,0 +1,83 @@ + + + +SecurityMgr - kvision + + + +kvision / pl.treksoft.kvision.remote / SecurityMgr
+
+

SecurityMgr

+abstract class SecurityMgr +

Form login dispatcher.

Constructors

+ + + + + + + +

<init>

+SecurityMgr() +

Form login dispatcher.

Functions

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

+ afterError +	+`open suspend fun afterError(): Unit` + Method called after error. +
+ afterLogin +	+`open suspend fun afterLogin(): Unit` + Method called after successful login. +
+ login +	+`abstract suspend fun login(): Boolean` + Login user. +
+ withAuth +	+`suspend fun <T> withAuth(block: suspend () -> T): T` + Executes given block of code after successful authentication. +

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-security-mgr/login.html b/api1/pl.treksoft.kvision.remote/-security-mgr/login.html new file mode 100644 index 00000000..a859fdd1 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-security-mgr/login.html @@ -0,0 +1,20 @@ + + + +SecurityMgr.login - kvision + + + +kvision / pl.treksoft.kvision.remote / SecurityMgr / login
+
+

login

+ +abstract suspend fun login(): Boolean +

Exceptions

+SecurityException - if login is not successful

Return
+true if login is successful

+ + diff --git a/api1/pl.treksoft.kvision.remote/-security-mgr/with-auth.html b/api1/pl.treksoft.kvision.remote/-security-mgr/with-auth.html new file mode 100644 index 00000000..2411563a --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-security-mgr/with-auth.html @@ -0,0 +1,18 @@ + + + +SecurityMgr.withAuth - kvision + + + +kvision / pl.treksoft.kvision.remote / SecurityMgr / withAuth
+
+

withAuth

+ +suspend fun <T> withAuth(block: suspend () -> T): T +

Executes given block of code after successful authentication.

Parameters

+block - a block of code

+ + -- cgit