Skip to main content
Version: 10.1

$.udb.checkLoginRequired()

note

This article is about the checkLoginRequired() function of the udb object.

$.udb.checkLoginRequired()

Checks if a login is required for the current page, and shows the login page if necessary.

Returns a boolean value.

Syntax

.checkLoginRequired( *show* )

*show* ::= { true | false }

The optional show determines whether the login page may be displayed if the user is not logged in and the page displayed requires it.

Example

if (!$.udb.checkLoginRequired(true))
return $.udb.showLogin();