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