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