SessionLogin

Authenticates against a PMA.core server without user interaction. Upon creation, the instance will register itself automatically as an authentication provider for the given context.

Constructor

new SessionLogin(context, serverSessions)

Source:

components/js/sessionlogin.js, line 14

Parameters:

Name	Type	Description
`context`	Context
`serverSessions`	Array.<SessionLogin~serverSessions>	Array of PMA.core server sessions.

Classes

SessionLogin

Methods

authenticate(serverUrl, successopt, failureopt) → {boolean}

Source:

components/js/sessionlogin.js, line 36

Authenticates against a PMA.core server. This method is usually invoked by the context itself and should rarely be used outside it.

Parameters:

Name	Type	Attributes	Description
`serverUrl`	string		The URL of the PMA.core server to authenticate against
`success`	function	<optional>
`failure`	function	<optional>

Returns:

True or false depending on whether this instance has enough information to authenticate against this PMA.core server

Type: boolean

updateSessionId(serverUrl, sessionId)

Source:

components/js/sessionlogin.js, line 52

Updates the session id of a specified server

Parameters:

Name	Type	Description
`serverUrl`	string	The URL of the PMA.core server to authenticate against
`sessionId`	string	The sessionId to update

Type Definitions

serverSessions

Source:

components/js/sessionlogin.js, line 3

Properties:

Name	Type	Description
`serverUrl`	string
`sessionId`	string

Holds a session ID per PMA.core server URL. Used to skip authentication, if a session ID is already available.

Type:

Object