.showLogin()

Previous Next

Shows the login page, or changes how the login page is displayed.

Syntax

.showLogin( options )

 

options  ::=  { struct | "reset" }

 

struct   ::=  {

    useTopContext:  use-top-context

,   reset: reset-function

,   show: show-function

}

 

use-top-context ::=  { true false }

Options may be a string with the value “reset” that resets any changes made to the .showLogin() behavior, or a struct that can have the following items, all of which are optional.

 

Use-top-context is a boolean that defines if the login page must always be displayed in the top-level context, and not e.g. in the ApplicationFrame.

 

Reset-function is a function that takes one parameter named reason, and is used to reset the login page in case a login has failed.

 

Show-function is a function that takes one parameter named reason, and is the function used to show the login page.

 

Omitting the options parameter will log out the user and show the login page.

 

 

Examples

$.udb.showLogin( {useTopContext: true} );

 

$.udb.showLogin( "reset" );