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

clientData()

Return the client ID and instance of the currently executing site

Syntax

{client,instance} = rb.page.clientData()

Parameters

The 'clientData' method takes no parameters

Results

The 'clientData' method returns {client,instance}:

Type/Value Range/Length Description
{client,instance}  An object with 'client' and 'instance' attributes

Remarks

Each Whitebeam application has a unique client_id and instance (unique within the server). The client is a name - usually representing the name of the web-site or of the client organisation. The instance is '0' for the live version of the site and '1' for the test version (other values are also possible although uncommon).

Ths method returns a JavaScript object containing both the client and the instance of the currently running site.

Whitebeam release 1.3.36
(loadtime : 118ms)