docs/output/Ext.util.Cookies.js

   1 Ext.data.JsonP.Ext_util_Cookies({
   2   "tagname": "class",
   3   "name": "Ext.util.Cookies",
   4   "doc": "<p>Utility class for setting/reading values from browser cookies.\nValues can be written using the <a href=\"#/api/Ext.util.Cookies-method-set\" rel=\"Ext.util.Cookies-method-set\" class=\"docClass\">set</a> method.\nValues can be read using the <a href=\"#/api/Ext.util.Cookies-method-get\" rel=\"Ext.util.Cookies-method-get\" class=\"docClass\">get</a> method.\nA cookie can be invalidated on the client machine using the <a href=\"#/api/Ext.util.Cookies-method-clear\" rel=\"Ext.util.Cookies-method-clear\" class=\"docClass\">clear</a> method.</p>\n",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "clear",
  24       "member": "Ext.util.Cookies",
  25       "doc": "<p>Removes a cookie with the provided name from the browser\nif found by setting its expiration date to sometime in the past.</p>\n",
  26       "params": [
  27         {
  28           "type": "String",
  29           "name": "name",
  30           "doc": "<p>The name of the cookie to remove</p>\n",
  31           "optional": false
  32         },
  33         {
  34           "type": "String",
  35           "name": "path",
  36           "doc": "<p>(optional) The path for the cookie. This must be included if you included a path while setting the cookie.</p>\n",
  37           "optional": true
  38         }
  39       ],
  40       "return": {
  41         "type": "void",
  42         "doc": "\n"
  43       },
  44       "private": false,
  45       "static": false,
  46       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js",
  47       "linenr": 80,
  48       "html_filename": "Cookies.html",
  49       "href": "Cookies.html#Ext-util-Cookies-method-clear",
  50       "shortDoc": "Removes a cookie with the provided name from the browser\nif found by setting its expiration date to sometime in the p..."
  51     },
  52     {
  53       "tagname": "method",
  54       "name": "get",
  55       "member": "Ext.util.Cookies",
  56       "doc": "<p>Retrieves cookies that are accessible by the current page. If a cookie\ndoes not exist, <code>get()</code> returns <tt>null</tt>.  The following\nexample retrieves the cookie called \"valid\" and stores the String value\nin the variable <tt>validStatus</tt>.</p>\n\n<pre><code>var validStatus = Ext.util.Cookies.get(\"valid\");\n</code></pre>\n\n",
  57       "params": [
  58         {
  59           "type": "String",
  60           "name": "name",
  61           "doc": "<p>The name of the cookie to get</p>\n",
  62           "optional": false
  63         }
  64       ],
  65       "return": {
  66         "type": "Mixed",
  67         "doc": "<p>Returns the cookie value for the specified name;\nnull if the cookie name does not exist.</p>\n"
  68       },
  69       "private": false,
  70       "static": false,
  71       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js",
  72       "linenr": 48,
  73       "html_filename": "Cookies.html",
  74       "href": "Cookies.html#Ext-util-Cookies-method-get",
  75       "shortDoc": "Retrieves cookies that are accessible by the current page. If a cookie\ndoes not exist, get() returns null.  The follo..."
  76     },
  77     {
  78       "tagname": "method",
  79       "name": "set",
  80       "member": "Ext.util.Cookies",
  81       "doc": "<p>Create a cookie with the specified name and value. Additional settings\nfor the cookie may be optionally specified (for example: expiration,\naccess restriction, SSL).</p>\n",
  82       "params": [
  83         {
  84           "type": "String",
  85           "name": "name",
  86           "doc": "<p>The name of the cookie to set.</p>\n",
  87           "optional": false
  88         },
  89         {
  90           "type": "Mixed",
  91           "name": "value",
  92           "doc": "<p>The value to set for the cookie.</p>\n",
  93           "optional": false
  94         },
  95         {
  96           "type": "Object",
  97           "name": "expires",
  98           "doc": "<p>(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).</p>\n",
  99           "optional": false
 100         },
 101         {
 102           "type": "String",
 103           "name": "path",
 104           "doc": "<p>(Optional) Setting a path on the cookie restricts\naccess to pages that match that path. Defaults to all pages (<tt>'/'</tt>).</p>\n",
 105           "optional": false
 106         },
 107         {
 108           "type": "String",
 109           "name": "domain",
 110           "doc": "<p>(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.</p>\n",
 111           "optional": false
 112         },
 113         {
 114           "type": "Boolean",
 115           "name": "secure",
 116           "doc": "<p>(Optional) Specify true to indicate that the cookie\nshould only be accessible via SSL on a page using the HTTPS protocol.\nDefaults to <tt>false</tt>. 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.</p>\n",
 117           "optional": false
 118         }
 119       ],
 120       "return": {
 121         "type": "void",
 122         "doc": "\n"
 123       },
 124       "private": false,
 125       "static": false,
 126       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js",
 127       "linenr": 15,
 128       "html_filename": "Cookies.html",
 129       "href": "Cookies.html#Ext-util-Cookies-method-set",
 130       "shortDoc": "Create a cookie with the specified name and value. Additional settings\nfor the cookie may be optionally specified (fo..."
 131     }
 132   ],
 133   "property": [
 134
 135   ],
 136   "event": [
 137
 138   ],
 139   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js",
 140   "linenr": 1,
 141   "html_filename": "Cookies.html",
 142   "href": "Cookies.html#Ext-util-Cookies",
 143   "cssVar": [
 144
 145   ],
 146   "cssMixin": [
 147
 148   ],
 149   "component": false,
 150   "superclasses": [
 151
 152   ],
 153   "subclasses": [
 154
 155   ],
 156   "mixedInto": [
 157
 158   ],
 159   "allMixins": [
 160
 161   ]
 162 });