Class Index | File Index

Classes


Namespace Sfdc.canvas.cookies

Sfdc.canvas.cookies
Defined in: cookies.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
get(name)
Get the cookie with the specified name
 
remove(name)
Remove the specified cookie by setting the expiry date to one day ago
 
set(name, value, days)
Create a cookie
Namespace Detail
Sfdc.canvas.cookies
Method Detail
get(name)
Get the cookie with the specified name
Parameters:
{String} name
The name of the cookie to retrieve
Returns:
The value of the cookie if the name is found, otherwise null

remove(name)
Remove the specified cookie by setting the expiry date to one day ago
Parameters:
{String} name
The name of the cookie to remove.

set(name, value, days)
Create a cookie
Parameters:
{String} name
Cookie name
{String} value
Cookie value
{Integer} days Optional
Number of days for the cookie to remain active. If not provided, the cookie never expires

Documentation generated by JsDoc Toolkit 2.3.0 on Fri Jan 11 2013 16:00:16 GMT-0000 (GMT)