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

rb.page.session Object Description
(system Template)

The Whitebeam System provides tools to help web-authors track user sessions, even though the concept of sessions is not built into the HTML model of the web. The tools probvided include the ability to assign a unique ID to a session and then be able to recognise that session during subsequent requests. The ability to track these sessions is suplemented by the ability for web authors to store data against that session and subsequently retrieve that data in other requests.

Full details of this mechanism can be seen here. The 'rb.page.session' object provides the JavaScript interface to the session tracking mechanism. This object controls the storage of data against a session using the 'MetaData' model.

The session template has been enhanced with Whitebeam Version 1.3.5 to allow:

  • Access to multiple named session data areas
  • rb.page.session.newID - allowing application to assign a new session ID, moving the data from the old session ID to the new with no loss of data.

Methods

rb.page.session.read() Retrieves application data associated with the current session.
rb.page.session.write() Stores application specific information against the current visitors session data
rb.page.session.id() Return the Whitebeam Session Id for the current session.
rb.page.session.newID() Allocate a new session ID and move data from old to new ID
rb.page.session.setPublicKey() Store a public key against the current session.
rb.page.session.writeByPublicKey() Write data to sessions identified by a public key
rb.page.session.url() Add the Whitebeam session ID into the URL provided.
Whitebeam release 1.3.36
(loadtime : 186ms)