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