Whitebeam Library Definition

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 Library Definition

Method Description

extlogin()

An attempt is made to log-in with the supplied parameters.

Syntax

bool = extlogin(username, password, community, expiry)

Parameters

The 'extlogin' method takes 4 parameters:

Name Type/Value Range/Length Description
usernamestring2-31 characters Required. Name of user to be logged in.
passwordstring3-64 characters Required. Password of user to be logged in.
communitystring2-31 characters Optional. Default value is the string "default"

Community, or comma separated list of communities (no white-space) against which the user should be validated. The first matching community is used.

expirynumber  Optional. Expiry time for login in minutes.

Results

The 'extlogin' method returns bool:

Type/Value Range/Length Description
bool   Returns true if the login is successful, otherwise returns false.

Whitebeam release 1.3.36
(loadtime : 9ms)