logoutOnUnload

Logs the user out of the session for the special case where the browser page is being unloaded. An optional mask message can be specified to be displayed while the logout is being processed.

If an external login has been used (“?externalLogin=true” URL argument or app.initializeExternalLogin is called directly), this call has no effect and the previous session is not cleared.

Note: For normal logouts, use the logout method.

Syntax

logoutOnUnload(showmask,
               maskMsg);

Parameters

  • showMask - (boolean) (optional) If true (the default), a mask is shown on the main application block returned by app.getAppBlock(). If false, a mask is not shown.
  • maskMsg - (String) (optional) A string value that is displayed in the mask if showMask is True. The default is an empty string.

Returns

None