Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

System Template

auth.status()

Return the authentication status for this page.

Syntax

String = rb.security.auth.status()

Parameters

The 'auth.status' method takes no parameters

Results

The 'auth.status' method returns String:

Type/Value Range/Length Description
String   This method returns a string that identifies the current authentication status for the page being executed.

Remarks

This method returns the current authentication status for the page. The value returned is one of the following:

StringInterpretation
NoneNo authentication information was presented by the client.
AuthOKClient provided a user name and password - and those matched entries in the Contact Template.
AuthFailedClient provided a user name and password - But they did not match entries int the Contact Template for the specified community.
AuthNotTestedThe Presentation Engine only validates the authentication information when the Pattern Page requests it to (either through the rb.security.auth.test method or through the rb:authentication tag. If neither of these have occurred then no validation has taken place. In this case this method will return the "AuthNotTested" value.

Whitebeam release 1.3.36
(loadtime : 64ms)