For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

## Sencha Documentation

# Ext.util.Cookies

Utility class for setting/reading values from browser cookies. Values can be written using the set method. Values can be read using the get method. A cookie can be invalidated on the client machine using the clear method.

Defined By

### Methods

Ext.util.Cookies
view source
clear( String name, [String path]) : void
Removes a cookie with the provided name from the browser if found by setting its expiration date to sometime in the p...

Removes a cookie with the provided name from the browser if found by setting its expiration date to sometime in the past.

### Parameters

- name : String

  The name of the cookie to remove

- path : String

  (optional) The path for the cookie. This must be included if you included a path while setting the cookie.

### Returns

- void

Ext.util.Cookies
view source
get( String name) : Mixed
Retrieves cookies that are accessible by the current page. If a cookie does not exist, get() returns null. The follo...

Retrieves cookies that are accessible by the current page. If a cookie does not exist, `get()` returns `null`. The following example retrieves the cookie called "valid" and stores the String value in the variable `validStatus`.

    var validStatus = Ext.util.Cookies.get("valid");

### Parameters

- name : String

  The name of the cookie to get

### Returns

- Mixed

  Returns the cookie value for the specified name; null if the cookie name does not exist.

Ext.util.Cookies
view source
set( String name, Mixed value, Object expires, String path, String domain, Boolean secure) : void
Create a cookie with the specified name and value. Additional settings for the cookie may be optionally specified (fo...

Create a cookie with the specified name and value. Additional settings for the cookie may be optionally specified (for example: expiration, access restriction, SSL).

### Parameters

- name : String

  The name of the cookie to set.

- value : Mixed

  The value to set for the cookie.

- expires : Object

  (Optional) Specify an expiration date the cookie is to persist until. Note that the specified Date object will be converted to Greenwich Mean Time (GMT).

- path : String

  (Optional) Setting a path on the cookie restricts access to pages that match that path. Defaults to all pages (`'/'`).

- domain : String

  (Optional) Setting a domain restricts access to pages on a given domain (typically used to allow cookie access across subdomains). For example, "sencha.com" will create a cookie that can be accessed from any subdomain of sencha.com, including www.sencha.com, support.sencha.com, etc.

- secure : Boolean

  (Optional) Specify true to indicate that the cookie should only be accessible via SSL on a page using the HTTPS protocol. Defaults to `false`. Note that this will only work if the page calling this code uses the HTTPS protocol, otherwise the cookie will be created with default options.

### Returns

- void