git.roojs.org Git - roojs1/blob - docs/symbols/Roo.state.CookieProvider.json

   1 {
   2   "name" : "Roo.state.CookieProvider",
   3   "augments" : [
   4     "Roo.state.Provider"
   5   ],
   6   "childClasses" : [],
   7   "desc" : "The default Provider implementation which saves state via cookies.\n<br />Usage:\n <pre><code>\n   var cp = new Roo.state.CookieProvider({\n       path: \"/cgi-bin/\",\n       expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days\n       domain: \"roojs.com\"\n   })\n   Roo.state.Manager.setProvider(cp);\n </code></pre>",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "CookieProvider",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "config",
  19       "type" : "Object",
  20       "desc" : "The configuration object",
  21       "isOptional" : false
  22     }
  23   ],
  24   "returns" : [],
  25   "throws" : "",
  26   "requires" : "",
  27   "config" : [
  28     {
  29       "name" : "path",
  30       "type" : "String",
  31       "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)",
  32       "memberOf" : ""
  33     },
  34     {
  35       "name" : "secure",
  36       "type" : "Boolean",
  37       "desc" : "True if the site is using SSL (defaults to false)",
  38       "memberOf" : ""
  39     },
  40     {
  41       "name" : "domain",
  42       "type" : "String",
  43       "desc" : "The domain to save the cookie for.  Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')",
  44       "memberOf" : ""
  45     },
  46     {
  47       "name" : "expires",
  48       "type" : "Date",
  49       "desc" : "The cookie expiration date (defaults to 7 days from now)",
  50       "memberOf" : ""
  51     }
  52   ],
  53   "methods" : [
  54     {
  55       "name" : "clear",
  56       "type" : "function",
  57       "desc" : "Clears a value from the state",
  58       "sig" : "(name)",
  59       "static" : false,
  60       "memberOf" : "Roo.state.Provider",
  61       "isStatic" : false,
  62       "isConstructor" : false,
  63       "isPrivate" : false,
  64       "example" : "",
  65       "deprecated" : "",
  66       "since" : "",
  67       "see" : "",
  68       "exceptions" : "",
  69       "requires" : "",
  70       "params" : [
  71         {
  72           "name" : "name",
  73           "type" : "String",
  74           "desc" : "The key name",
  75           "isOptional" : false
  76         }
  77       ],
  78       "returns" : []
  79     },
  80     {
  81       "name" : "decodeValue",
  82       "type" : "function",
  83       "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
  84       "sig" : "(value)",
  85       "static" : false,
  86       "memberOf" : "Roo.state.Provider",
  87       "isStatic" : false,
  88       "isConstructor" : false,
  89       "isPrivate" : false,
  90       "example" : "",
  91       "deprecated" : "",
  92       "since" : "",
  93       "see" : "",
  94       "exceptions" : "",
  95       "requires" : "",
  96       "params" : [
  97         {
  98           "name" : "value",
  99           "type" : "String",
 100           "desc" : "The value to decode",
 101           "isOptional" : false
 102         }
 103       ],
 104       "returns" : [
 105         {
 106           "name" : "",
 107           "type" : "Mixed",
 108           "desc" : "The decoded value"
 109         }
 110       ]
 111     },
 112     {
 113       "name" : "get",
 114       "type" : "function",
 115       "desc" : "Returns the current value for a key",
 116       "sig" : "(name, defaultValue)",
 117       "static" : false,
 118       "memberOf" : "Roo.state.Provider",
 119       "isStatic" : false,
 120       "isConstructor" : false,
 121       "isPrivate" : false,
 122       "example" : "",
 123       "deprecated" : "",
 124       "since" : "",
 125       "see" : "",
 126       "exceptions" : "",
 127       "requires" : "",
 128       "params" : [
 129         {
 130           "name" : "name",
 131           "type" : "String",
 132           "desc" : "The key name",
 133           "isOptional" : false
 134         },
 135         {
 136           "name" : "defaultValue",
 137           "type" : "Mixed",
 138           "desc" : "A default value to return if the key's value is not found",
 139           "isOptional" : false
 140         }
 141       ],
 142       "returns" : [
 143         {
 144           "name" : "",
 145           "type" : "Mixed",
 146           "desc" : "The state data"
 147         }
 148       ]
 149     },
 150     {
 151       "name" : "set",
 152       "type" : "function",
 153       "desc" : "Sets the value for a key",
 154       "sig" : "(name, value)",
 155       "static" : false,
 156       "memberOf" : "Roo.state.Provider",
 157       "isStatic" : false,
 158       "isConstructor" : false,
 159       "isPrivate" : false,
 160       "example" : "",
 161       "deprecated" : "",
 162       "since" : "",
 163       "see" : "",
 164       "exceptions" : "",
 165       "requires" : "",
 166       "params" : [
 167         {
 168           "name" : "name",
 169           "type" : "String",
 170           "desc" : "The key name",
 171           "isOptional" : false
 172         },
 173         {
 174           "name" : "value",
 175           "type" : "Mixed",
 176           "desc" : "The value to set",
 177           "isOptional" : false
 178         }
 179       ],
 180       "returns" : []
 181     },
 182     {
 183       "name" : "encodeValue",
 184       "type" : "function",
 185       "desc" : "Encodes a value including type information.  Decode with {@link #decodeValue}.",
 186       "sig" : "(value)",
 187       "static" : false,
 188       "memberOf" : "Roo.state.Provider",
 189       "isStatic" : false,
 190       "isConstructor" : false,
 191       "isPrivate" : false,
 192       "example" : "",
 193       "deprecated" : "",
 194       "since" : "",
 195       "see" : "",
 196       "exceptions" : "",
 197       "requires" : "",
 198       "params" : [
 199         {
 200           "name" : "value",
 201           "type" : "Mixed",
 202           "desc" : "The value to encode",
 203           "isOptional" : false
 204         }
 205       ],
 206       "returns" : [
 207         {
 208           "name" : "",
 209           "type" : "String",
 210           "desc" : "The encoded value"
 211         }
 212       ]
 213     }
 214   ],
 215   "events" : [
 216     {
 217       "name" : "statechange",
 218       "type" : "function",
 219       "desc" : "Fires when a state change occurs.",
 220       "sig" : "function (_self, key, value)\n{\n\n}",
 221       "memberOf" : "Roo.state.Provider",
 222       "example" : "",
 223       "deprecated" : "",
 224       "since" : "",
 225       "see" : "",
 226       "params" : [
 227         {
 228           "name" : "this",
 229           "type" : "Provider",
 230           "desc" : "This state provider",
 231           "isOptional" : false
 232         },
 233         {
 234           "name" : "key",
 235           "type" : "String",
 236           "desc" : "The state key which was changed",
 237           "isOptional" : false
 238         },
 239         {
 240           "name" : "value",
 241           "type" : "String",
 242           "desc" : "The encoded value for the state",
 243           "isOptional" : false
 244         }
 245       ],
 246       "returns" : []
 247     }
 248   ]
 249 }