Professional Documents
Culture Documents
5
Simple Use Case: Reading/writing a cookie Cookie Options Object YAHOO.util.Cookie
Options that can be set on the options object in remove(), set(), removeSub(), setSub(), and setSubs(). Cookie Methods
var value = YAHOO.util.Cookie.get("name"); Member Type Description get(str name, func converter)
expires Date A Date object representing the date and time at which returns a cookie value
Retrieves the cookie named “name” and stores its value in a the cookie should expire. set(str name, str value, obj options)
sets a cookie
variable. domain string The domain for which the cookie should be accessible. remove(str name, obj options)
path string The path for which the cookie should be accessible. removes a cookie
YAHOO.util.Cookie.set("name", "value"); secure boolean Indicates if the cookie is accessible only via SSL.
YAHOO.util.Cookie
Sets a cookie named “name” and stores “value” in it. Usage: YAHOO.util.Cookie.getSub() Subcookie Methods
var value = YAHOO.util.Cookie.getSub(str name, str getSub(str name, str subname,
Usage: YAHOO.util.Cookie.get() subname [, func converter])
func converter) returns a subcookie
value
getSubs(str name) returns all
var value = YAHOO.util.Cookie.get(str name[, Arguments: subcookies in an object
func converter]) (1) name: The name of the cookie to get. setSub(str name, str subname, str
(2) subname: The subcookie name to get. value, obj options) sets a
Arguments: subcookie
(1) name: The name of the cookie to get. (3) converter: (Optional) A conversion function to run the value through setSubs(str name, obj subcookies,
(2) converter: (Optional) A conversion function to run the value before returning it. This function is not called if the subcookie with the obj options) sets all subcookies in a
cookie
through before returning it. This function is not called if the given name doesn’t exist. removeSub(str name, str
cookie with the given name doesn’t exist. subname, obj options) removes a
Usage: YAHOO.util.Cookie.removeSub() subcookie
YAHOO.util.Cookie.set(str name, str value [, obj YAHOO.util.Cookie.setSub(str name, str subname, str
options]) value [, obj options])
Arguments: Arguments:
(1) name: The name of the cookie to set. (1) name: The name of the cookie to set.
(2) value: The value of the cookie to set. (2) subname: The subcookie name to set.
(3) options: (Optional) Options for setting the accessibility of the (3) value: The value for the subcookie.
cookie based on expiration date, domain, path, and security. (4) options: (Optional) Options for setting the accessibility of the cookie
based on expiration date, domain, path, and security.