MODULES Uize.Util.Browser.Cookies
1. Introduction
The Uize.Util.Browser.Cookies module is a package under the Uize namespace, and provides a couple of methods for managing browser cookies.
DEVELOPERS: Chris van Rensburg
1.1. Examples
There are no dedicated showcase example pages for the Uize.Util.Browser.Cookies module.
SEARCH FOR EXAMPLES
Use the link below to search for example pages on the UIZE Web site that reference the Uize.Util.Browser.Cookies module...
SEARCH
1.2. Implementation Info
The Uize.Util.Browser.Cookies module defines the Uize.Util.Browser.Cookies package under the Uize.Util.Browser namespace.
1.2.1. Features Introduced in This Module
The features listed in this section have been introduced in this module.
STATIC METHODS
Uize.Util.Browser.Cookies.getCookie | Uize.Util.Browser.Cookies.setCookie
STATIC PROPERTIES
Uize.Util.Browser.Cookies.moduleName | Uize.Util.Browser.Cookies.pathToResources
1.2.2. Features Overridden in This Module
No features have been overridden in this module.
1.2.3. Features Inherited From Other Modules
This module has no inherited features.
1.2.4. Modules Directly Under This Namespace
There are no modules directly under this namespace.
1.2.5. Unit Tests
There is no dedicated unit tests module for the Uize.Util.Browser.Cookies module.
2. Static Methods
2.1. Uize.Util.Browser.Cookies.getCookie
SYNTAX
cookieValueSTR = Uize.Util.Browser.Cookies.getCookie (cookieNameSTR);
NOTES
| if there is no cookie stored by the specified name, then an empty string will be returned |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.2. Uize.Util.Browser.Cookies.setCookie
SYNTAX
Uize.Util.Browser.Cookies.setCookie (cookieNameSTR,cookieValueSTR,pathSTR,expirationSTR);
VARIATIONS
Uize.Util.Browser.Cookies.setCookie (cookieNameSTR,cookieValueSTR,pathSTR);
When no expirationSTR parameter is specified, the expiration will be set to one year from the time that the cookie value is set.
Uize.Util.Browser.Cookies.setCookie (cookieNameSTR,cookieValueSTR);
When no pathSTR parameter is specified, then the path of the current page being used.
Uize.Util.Browser.Cookies.setCookie (cookieNameSTR);
When only a cookieNameSTR parameter is specified, the cookie specified by that parameter will be cleared.
IMPLEMENTATION INFO
| this feature was introduced in this module |