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