From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../-security-mgr/-init-.html | 15 ----- .../-security-mgr/after-error.html | 15 ----- .../-security-mgr/after-login.html | 15 ----- .../-security-mgr/index.html | 69 ---------------------- .../-security-mgr/login.html | 20 ------- .../-security-mgr/with-auth.html | 18 ------ 6 files changed, 152 deletions(-) delete mode 100644 api/pl.treksoft.kvision.remote/-security-mgr/-init-.html delete mode 100644 api/pl.treksoft.kvision.remote/-security-mgr/after-error.html delete mode 100644 api/pl.treksoft.kvision.remote/-security-mgr/after-login.html delete mode 100644 api/pl.treksoft.kvision.remote/-security-mgr/index.html delete mode 100644 api/pl.treksoft.kvision.remote/-security-mgr/login.html delete mode 100644 api/pl.treksoft.kvision.remote/-security-mgr/with-auth.html (limited to 'api/pl.treksoft.kvision.remote/-security-mgr') diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/-init-.html b/api/pl.treksoft.kvision.remote/-security-mgr/-init-.html deleted file mode 100644 index 4e31e55d..00000000 --- a/api/pl.treksoft.kvision.remote/-security-mgr/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -SecurityMgr.<init> - kvision - - - -kvision / pl.treksoft.kvision.remote / SecurityMgr / <init>
-
-

<init>

- -SecurityMgr() -

Pac4j form login dispatcher.

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

afterError

- -open suspend fun afterError(): Unit -

Method called after error.

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

afterLogin

- -open suspend fun afterLogin(): Unit -

Method called after successful login.

- - diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/index.html b/api/pl.treksoft.kvision.remote/-security-mgr/index.html deleted file mode 100644 index 2c1b3d96..00000000 --- a/api/pl.treksoft.kvision.remote/-security-mgr/index.html +++ /dev/null @@ -1,69 +0,0 @@ - - - -SecurityMgr - kvision - - - -kvision / pl.treksoft.kvision.remote / SecurityMgr
-
-

SecurityMgr

-abstract class SecurityMgr -

Pac4j form login dispatcher.

-

Constructors

- - - - - - - -
-

<init>

-
-SecurityMgr() -

Pac4j 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.

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

login

- -abstract suspend fun login(): Boolean -

Login user.

-

Exceptions

-

-SecurityException - if login is not successful

-

Return
-true if login is successful

- - diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/with-auth.html b/api/pl.treksoft.kvision.remote/-security-mgr/with-auth.html deleted file mode 100644 index cf76923e..00000000 --- a/api/pl.treksoft.kvision.remote/-security-mgr/with-auth.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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