PMA.UI Documentation by Pathomation

PromptLogin

PMA.UI.Authentication PromptLogin

Authenticates against a PMA.core server by prompting the user to enter credentials. Upon creation, the instance will register itself automatically as an authentication provider for the given context.

Constructor

new PromptLogin(context, serverNameCallback)

Source:
Tutorials:
  • Tutorial: 04-tree
Parameters:
Name Type Description
context Context
serverNameCallback PromptLogin~serverNameCallback A callback that takes a serverUrl as parameter and returns a frienly name for that server

Methods

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

Source:
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

Type Definitions

serverNameCallback(serverUrl) → {string}

Source:
The callback function used to authenticate to a server url
Parameters:
Name Type Description
serverUrl string The URL of the PMA.core server to find a friendly name for
Returns:
A friendly name for the specified server url if found or null
Type
string