git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.data.HttpProxy.json

   1 {
   2   "name" : "Roo.data.HttpProxy",
   3   "augments" : [
   4     "Roo.data.DataProxy"
   5   ],
   6   "desc" : "An implementation of {@link Roo.data.DataProxy} that reads a data object from an {@link Roo.data.Connection} object\nconfigured to reference a certain URL.<br><br>\n<p>\n<em>Note that this class cannot be used to retrieve data from a domain other than the domain\nfrom which the running page was served.<br><br>\n<p>\nFor cross-domain access to remote data, use an {@link Roo.data.ScriptTagProxy}.</em><br><br>\n<p>\nBe aware that to enable the browser to parse an XML document, the server must set\nthe Content-Type header in the HTTP response to \"text/xml\".",
   7   "isSingleton" : false,
   8   "isStatic" : true,
   9   "isBuiltin" : false,
  10   "config" : [
  11     {
  12       "name" : "method",
  13       "type" : "String",
  14       "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
  15       "memberOf" : "Roo.data.HttpProxy",
  16       "values" : [
  17       ]
  18     },
  19     {
  20       "name" : "timeout",
  21       "type" : "Number",
  22       "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
  23       "memberOf" : "Roo.data.HttpProxy",
  24       "values" : [
  25       ]
  26     },
  27     {
  28       "name" : "autoAbort",
  29       "type" : "Boolean",
  30       "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
  31       "memberOf" : "Roo.data.HttpProxy",
  32       "values" : [
  33       ]
  34     },
  35     {
  36       "name" : "url",
  37       "type" : "String",
  38       "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
  39       "memberOf" : "Roo.data.HttpProxy",
  40       "values" : [
  41       ]
  42     },
  43     {
  44       "name" : "extraParams",
  45       "type" : "Object",
  46       "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
  47       "memberOf" : "Roo.data.HttpProxy",
  48       "values" : [
  49       ]
  50     },
  51     {
  52       "name" : "disableCaching",
  53       "type" : "Boolean",
  54       "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
  55       "memberOf" : "Roo.data.HttpProxy",
  56       "values" : [
  57       ]
  58     },
  59     {
  60       "name" : "defaultHeaders",
  61       "type" : "Object",
  62       "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
  63       "memberOf" : "Roo.data.HttpProxy",
  64       "values" : [
  65       ]
  66     }
  67   ],
  68   "methods" : [
  69     {
  70       "name" : "getConnection",
  71       "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
  72       "isStatic" : false,
  73       "isConstructor" : false,
  74       "isPrivate" : false,
  75       "memberOf" : "Roo.data.HttpProxy",
  76       "example" : "",
  77       "deprecated" : "",
  78       "since" : "",
  79       "see" : "",
  80       "params" : [
  81       ],
  82       "returns" : [
  83         {
  84           "name" : "",
  85           "type" : "Connection",
  86           "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
  87         }
  88       ]
  89     },
  90     {
  91       "name" : "load",
  92       "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.",
  93       "isStatic" : false,
  94       "isConstructor" : false,
  95       "isPrivate" : false,
  96       "memberOf" : "Roo.data.HttpProxy",
  97       "example" : "",
  98       "deprecated" : "",
  99       "since" : "",
 100       "see" : "",
 101       "params" : [
 102         {
 103           "name" : "params",
 104           "type" : "Object",
 105           "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
 106           "isOptional" : false
 107         },
 108         {
 109           "name" : "reader",
 110           "type" : "Roo.data.DataReader",
 111           "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
 112           "isOptional" : false
 113         },
 114         {
 115           "name" : "callback",
 116           "type" : "Function",
 117           "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
 118           "isOptional" : false
 119         },
 120         {
 121           "name" : "scope",
 122           "type" : "Object",
 123           "desc" : "The scope in which to call the callback",
 124           "isOptional" : false
 125         },
 126         {
 127           "name" : "arg",
 128           "type" : "Object",
 129           "desc" : "An optional argument which is passed to the callback as its second parameter.",
 130           "isOptional" : false
 131         }
 132       ],
 133       "returns" : [
 134       ]
 135     }
 136   ],
 137   "events" : [
 138     {
 139       "name" : "load",
 140       "desc" : "Fires before the load method's callback is called.",
 141       "memberOf" : "Roo.data.DataProxy",
 142       "example" : "",
 143       "deprecated" : "",
 144       "since" : "",
 145       "see" : "",
 146       "params" : [
 147         {
 148           "name" : "This",
 149           "type" : "Object",
 150           "desc" : "DataProxy object.",
 151           "isOptional" : false
 152         },
 153         {
 154           "name" : "o",
 155           "type" : "Object",
 156           "desc" : "The data object.",
 157           "isOptional" : false
 158         },
 159         {
 160           "name" : "arg",
 161           "type" : "Object",
 162           "desc" : "The callback argument object passed to the load function.",
 163           "isOptional" : false
 164         }
 165       ],
 166       "returns" : [
 167       ]
 168     },
 169     {
 170       "name" : "beforeload",
 171       "desc" : "Fires before a network request is made to retrieve a data object.",
 172       "memberOf" : "Roo.data.DataProxy",
 173       "example" : "",
 174       "deprecated" : "",
 175       "since" : "",
 176       "see" : "",
 177       "params" : [
 178         {
 179           "name" : "This",
 180           "type" : "Object",
 181           "desc" : "DataProxy object.",
 182           "isOptional" : false
 183         },
 184         {
 185           "name" : "params",
 186           "type" : "Object",
 187           "desc" : "The params parameter to the load function.",
 188           "isOptional" : false
 189         }
 190       ],
 191       "returns" : [
 192       ]
 193     },
 194     {
 195       "name" : "loadexception",
 196       "desc" : "Fires if an Exception occurs during data retrieval.",
 197       "memberOf" : "Roo.data.DataProxy",
 198       "example" : "",
 199       "deprecated" : "",
 200       "since" : "",
 201       "see" : "",
 202       "params" : [
 203         {
 204           "name" : "This",
 205           "type" : "Object",
 206           "desc" : "DataProxy object.",
 207           "isOptional" : false
 208         },
 209         {
 210           "name" : "o",
 211           "type" : "Object",
 212           "desc" : "The data object.",
 213           "isOptional" : false
 214         },
 215         {
 216           "name" : "arg",
 217           "type" : "Object",
 218           "desc" : "The callback argument object passed to the load function.",
 219           "isOptional" : false
 220         },
 221         {
 222           "name" : "e",
 223           "type" : "Object",
 224           "desc" : "The Exception.",
 225           "isOptional" : false
 226         }
 227       ],
 228       "returns" : [
 229       ]
 230     }
 231   ]
 232 }