Class: Manager

Methods

---

getCurrentState()

Gets the authentication manager state at the time of the method call

Implements:

• olympe.auth.Manager#getCurrentState

Returns:

Type

olympe.auth.Manager.STATE

---

getDomain()

Gets the current domain

Implements:

• olympe.auth.Manager#getDomain

Returns:

Type

olympe.df.Proxy.<string> | string

---

getDomainTag()

Gets the current domain tag

Implements:

• olympe.auth.Manager#getDomainTag

Returns:

Type

olympe.df.Proxy.<string> | string

---

getErrorMessage()

Gets the last error message if any

Implements:

• olympe.auth.Manager#getErrorMessage

Returns:

Type

olympe.df.POString

---

getState()

Gets the authentication manager state

Implements:

• olympe.auth.Manager#getState

Returns:

Type

olympe.df.Proxy.<olympe.auth.Manager.STATE>

---

getTokenNonce()

Gets the 'nonce' of the current user token.

Implements:

• olympe.auth.Manager#getTokenNonce

Returns:

Type

olympe.df.POString

---

getUser()

Gets the current user name

Implements:

• olympe.auth.Manager#getUser

Returns:

Type

olympe.df.Proxy.<string> | string

---

getUserTag()

Gets the current user tag

Implements:

• olympe.auth.Manager#getUserTag

Returns:

Type

olympe.df.Proxy.<string> | string

---

isAuthenticated()

Returns true if the user is authenticated

Implements:

• olympe.auth.Manager#isAuthenticated

Returns:

Type

olympe.df.POBoolean

---

isError()

Returns true if the last login attempt failed

Implements:

• olympe.auth.Manager#isError

Returns:

Type

olympe.df.POBoolean

---

login(request [, providerName])

Logs a user in

Parameters:

Name	Type	Argument	Description
request	olympe.auth.Request		Authentication request
providerName	string	<optional>	Authentication provider name, if not specified use the default one

Implements:

• olympe.auth.Manager#login

---

loginWithLocalToken()

Automatically relogs the user from a locally stored token using the last provider

Implements:

• olympe.auth.Manager#loginWithLocalToken

---

loginWithParams()

Login using the parameters passed to the Olympe configuration.

---

logout()

Logs the user out and call the registered logout callbacks when the answer has come.

Implements:

• olympe.auth.Manager#logout

---

offAuthentication(id)

Unregisters a callback on authentication attempts.

Parameters:

Name	Type	Description
id	string	Callback identifier

Implements:

• olympe.auth.Manager#offAuthentication

---

offLogout(id)

Unregisters a callback on on logout.

Parameters:

Name	Type	Description
id	string	Callback identifier

Implements:

• olympe.auth.Manager#offLogout

---

onAuthentication(callback [, id])

Registers a callback on each authentication attempt. Those callbacks are also called on automatic authentication after disconnection.

Parameters:

Name	Type	Argument	Description
callback	olympe.auth.Manager.AuthenticationCallback		Callback function
id	string	<optional>	Optional callback identifier

Implements:

• olympe.auth.Manager#onAuthentication

Returns:

Callback identifier

Type

string

---

onLogout(callback [, id])

Registers a callback on logout.

Parameters:

Name	Type	Argument	Description
callback	olympe.auth.Manager.LogoutCallback		Callback function
id	string	<optional>	Optional callback identifier

Implements:

• olympe.auth.Manager#onLogout

Returns:

Callback identifier

Type

string

---

registerProvider(provider)

Registers a login method

Parameters:

Name	Type	Description
provider	olympe.auth.Provider	Authentication provider

Implements:

• olympe.auth.Manager#registerProvider

---

resetState()

Reset manager state in case a login failed or could not be performed due to missing information. This logs the user out if it was authenticated!