The LoginClientModule runs on initialization, and both displays the login screen to the user and handles the majority of the login process after the user has entered their credentials. 

Availability

The LoginClientModule is an init-level module, so it is created and available when the browser session is first instantiated, before the login screen is displayed. It is shut down immediately before the client session is destroyed. 

Methods

The login methods initiate a login attempt, either with a username and password, or with a saved session identifier. If a username is specified and has a backslash (\) in it, the part before the backslash is treated as a core server slug, and the part after the backslash is treated as the actual username. This is similar to how Windows treats domain logins. 

The logout method initiates a logout. If displayLoginScreen is true, the login screen is then displayed (this should be true if the user has initiated the logout themselves, or if the administrator has logged the user out). If notifyServer is true, the login module will send a request to the core server to inform it of the logout. This should true if the user has logged themselves out, or if the session has expired, but not if the administrator has logged the user out. 

Factory Name

The factory name for dependencies of this module is:

Direct Descendents

The following other modules are known to be direct descendents of the LanguageClientModule:

• SavedLoginClientModule