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