git.roojs.org Git - roojs1/blob - docs/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" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "HttpProxy",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "conn",
  18       "type" : "Object",
  19       "desc" : "Connection config options to add to each request (e.g. {url: 'foo.php'} or\nan {@link Roo.data.Connection} object.  If a Connection config is passed, the singleton {@link Roo.Ajax} object\nwill be used to make the request.",
  20       "isOptional" : false
  21     }
  22   ],
  23   "returns" : [],
  24   "config" : [
  25     {
  26       "name" : "method",
  27       "type" : "String",
  28       "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)",
  29       "memberOf" : "Roo.data.HttpProxy",
  30       "optvals" : []
  31     },
  32     {
  33       "name" : "timeout",
  34       "type" : "Number",
  35       "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
  36       "memberOf" : "Roo.data.HttpProxy",
  37       "optvals" : []
  38     },
  39     {
  40       "name" : "autoAbort",
  41       "type" : "Boolean",
  42       "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
  43       "memberOf" : "Roo.data.HttpProxy",
  44       "optvals" : []
  45     },
  46     {
  47       "name" : "url",
  48       "type" : "String",
  49       "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
  50       "memberOf" : "Roo.data.HttpProxy",
  51       "optvals" : []
  52     },
  53     {
  54       "name" : "extraParams",
  55       "type" : "Object",
  56       "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
  57       "memberOf" : "Roo.data.HttpProxy",
  58       "optvals" : []
  59     },
  60     {
  61       "name" : "disableCaching",
  62       "type" : "Boolean",
  63       "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
  64       "memberOf" : "Roo.data.HttpProxy",
  65       "optvals" : []
  66     },
  67     {
  68       "name" : "defaultHeaders",
  69       "type" : "Object",
  70       "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
  71       "memberOf" : "Roo.data.HttpProxy",
  72       "optvals" : []
  73     }
  74   ],
  75   "methods" : [
  76     {
  77       "name" : "getConnection",
  78       "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
  79       "isStatic" : false,
  80       "isConstructor" : false,
  81       "isPrivate" : false,
  82       "memberOf" : "Roo.data.HttpProxy",
  83       "example" : "",
  84       "deprecated" : "",
  85       "since" : "",
  86       "see" : "",
  87       "params" : [],
  88       "returns" : [
  89         {
  90           "name" : "",
  91           "type" : "Connection",
  92           "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
  93         }
  94       ]
  95     },
  96     {
  97       "name" : "load",
  98       "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.",
  99       "isStatic" : false,
 100       "isConstructor" : false,
 101       "isPrivate" : false,
 102       "memberOf" : "Roo.data.HttpProxy",
 103       "example" : "",
 104       "deprecated" : "",
 105       "since" : "",
 106       "see" : "",
 107       "params" : [
 108         {
 109           "name" : "params",
 110           "type" : "Object",
 111           "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
 112           "isOptional" : false
 113         },
 114         {
 115           "name" : "reader",
 116           "type" : "Roo.data.DataReader",
 117           "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
 118           "isOptional" : false
 119         },
 120         {
 121           "name" : "callback",
 122           "type" : "Function",
 123           "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>",
 124           "isOptional" : false
 125         },
 126         {
 127           "name" : "scope",
 128           "type" : "Object",
 129           "desc" : "The scope in which to call the callback",
 130           "isOptional" : false
 131         },
 132         {
 133           "name" : "arg",
 134           "type" : "Object",
 135           "desc" : "An optional argument which is passed to the callback as its second parameter.",
 136           "isOptional" : false
 137         }
 138       ],
 139       "returns" : []
 140     }
 141   ],
 142   "events" : [
 143     {
 144       "name" : "load",
 145       "desc" : "Fires before the load method's callback is called.",
 146       "memberOf" : "Roo.data.DataProxy",
 147       "example" : "",
 148       "deprecated" : "",
 149       "since" : "",
 150       "see" : "",
 151       "params" : [
 152         {
 153           "name" : "This",
 154           "type" : "Object",
 155           "desc" : "DataProxy object.",
 156           "isOptional" : false
 157         },
 158         {
 159           "name" : "o",
 160           "type" : "Object",
 161           "desc" : "The data object.",
 162           "isOptional" : false
 163         },
 164         {
 165           "name" : "arg",
 166           "type" : "Object",
 167           "desc" : "The callback argument object passed to the load function.",
 168           "isOptional" : false
 169         }
 170       ],
 171       "returns" : []
 172     },
 173     {
 174       "name" : "beforeload",
 175       "desc" : "Fires before a network request is made to retrieve a data object.",
 176       "memberOf" : "Roo.data.DataProxy",
 177       "example" : "",
 178       "deprecated" : "",
 179       "since" : "",
 180       "see" : "",
 181       "params" : [
 182         {
 183           "name" : "This",
 184           "type" : "Object",
 185           "desc" : "DataProxy object.",
 186           "isOptional" : false
 187         },
 188         {
 189           "name" : "params",
 190           "type" : "Object",
 191           "desc" : "The params parameter to the load function.",
 192           "isOptional" : false
 193         }
 194       ],
 195       "returns" : []
 196     },
 197     {
 198       "name" : "loadexception",
 199       "desc" : "Fires if an Exception occurs during data retrieval.",
 200       "memberOf" : "Roo.data.DataProxy",
 201       "example" : "",
 202       "deprecated" : "",
 203       "since" : "",
 204       "see" : "",
 205       "params" : [
 206         {
 207           "name" : "This",
 208           "type" : "Object",
 209           "desc" : "DataProxy object.",
 210           "isOptional" : false
 211         },
 212         {
 213           "name" : "o",
 214           "type" : "Object",
 215           "desc" : "The data object.",
 216           "isOptional" : false
 217         },
 218         {
 219           "name" : "arg",
 220           "type" : "Object",
 221           "desc" : "The callback argument object passed to the load function.",
 222           "isOptional" : false
 223         },
 224         {
 225           "name" : "e",
 226           "type" : "Object",
 227           "desc" : "The Exception.",
 228           "isOptional" : false
 229         }
 230       ],
 231       "returns" : []
 232     }
 233   ]
 234 }