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

cookie.read()

Read client side cookies.

Syntax

MetaData Object = rb.page.cookie.read()

Parameters

The 'cookie.read' method takes no parameters

Results

The 'cookie.read' method returns a JavaScript object containing arbitrary attributes (Meta Value):

Type/Value Range/Length Description
MetaData   JavaScript object containing a named property for each cookie sent by the client. Name of property is the name in the cookie header.

Remarks

Thie method allows the Pattern Page to read any cookies sent to the server by the client. The resulting JavaScript object contains a property for each client side cookie received in the request. The name of each property is the name provided for the cookie.

Just because you tried to place a cookie on the client - doesn't mean that cookie will a) be stored by the client or b) that the client will return it to you. For a discussion of cookies versus other similar mechanisms see the tutorial on Session Data. Some reasons why a browser may not accept a cookies are:
  • Cookies turned off at the browser end.
  • Written too many cookies to the browser - the client is not required to store more than a limited number of cookies or a limited amount of data.
This method does not return the contents of the Whitebeam session cookie placed on the client by the system.

Whitebeam release 1.3.36
(loadtime : 66ms)