X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.util.Cookies.js diff --git a/docs/output/Ext.util.Cookies.js b/docs/output/Ext.util.Cookies.js new file mode 100644 index 00000000..6265de18 --- /dev/null +++ b/docs/output/Ext.util.Cookies.js @@ -0,0 +1,162 @@ +Ext.data.JsonP.Ext_util_Cookies({ + "tagname": "class", + "name": "Ext.util.Cookies", + "doc": "

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

\n", + "extends": null, + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": true, + "private": false, + "cfg": [ + + ], + "method": [ + { + "tagname": "method", + "name": "clear", + "member": "Ext.util.Cookies", + "doc": "

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

\n", + "params": [ + { + "type": "String", + "name": "name", + "doc": "

The name of the cookie to remove

\n", + "optional": false + }, + { + "type": "String", + "name": "path", + "doc": "

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

\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js", + "linenr": 80, + "html_filename": "Cookies.html", + "href": "Cookies.html#Ext-util-Cookies-method-clear", + "shortDoc": "Removes a cookie with the provided name from the browser\nif found by setting its expiration date to sometime in the p..." + }, + { + "tagname": "method", + "name": "get", + "member": "Ext.util.Cookies", + "doc": "

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

\n\n
var validStatus = Ext.util.Cookies.get(\"valid\");\n
\n\n", + "params": [ + { + "type": "String", + "name": "name", + "doc": "

The name of the cookie to get

\n", + "optional": false + } + ], + "return": { + "type": "Mixed", + "doc": "

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

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js", + "linenr": 48, + "html_filename": "Cookies.html", + "href": "Cookies.html#Ext-util-Cookies-method-get", + "shortDoc": "Retrieves cookies that are accessible by the current page. If a cookie\ndoes not exist, get() returns null. The follo..." + }, + { + "tagname": "method", + "name": "set", + "member": "Ext.util.Cookies", + "doc": "

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

\n", + "params": [ + { + "type": "String", + "name": "name", + "doc": "

The name of the cookie to set.

\n", + "optional": false + }, + { + "type": "Mixed", + "name": "value", + "doc": "

The value to set for the cookie.

\n", + "optional": false + }, + { + "type": "Object", + "name": "expires", + "doc": "

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

\n", + "optional": false + }, + { + "type": "String", + "name": "path", + "doc": "

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

\n", + "optional": false + }, + { + "type": "String", + "name": "domain", + "doc": "

(Optional) Setting a domain restricts access to\npages on a given domain (typically used to allow cookie access across\nsubdomains). For example, \"sencha.com\" will create a cookie that can be\naccessed from any subdomain of sencha.com, including www.sencha.com,\nsupport.sencha.com, etc.

\n", + "optional": false + }, + { + "type": "Boolean", + "name": "secure", + "doc": "

(Optional) Specify true to indicate that the cookie\nshould only be accessible via SSL on a page using the HTTPS protocol.\nDefaults to false. Note that this will only work if the page\ncalling this code uses the HTTPS protocol, otherwise the cookie will be\ncreated with default options.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js", + "linenr": 15, + "html_filename": "Cookies.html", + "href": "Cookies.html#Ext-util-Cookies-method-set", + "shortDoc": "Create a cookie with the specified name and value. Additional settings\nfor the cookie may be optionally specified (fo..." + } + ], + "property": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js", + "linenr": 1, + "html_filename": "Cookies.html", + "href": "Cookies.html#Ext-util-Cookies", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file