- Number<div class="mdesc"><div class="short">Sends an HTTP request to a remote server.
-Important: Ajax server requests are asynchronous, and this call will
-retu...</div><div class="long"><p>Sends an HTTP request to a remote server.</p>\r
-<p><b>Important:</b> Ajax server requests are asynchronous, and this call will\r
-return before the response has been received. Process any returned data\r
-in a callback function.</p>\r
-<pre><code>Ext.Ajax.request({\r
- url: <em>'ajax_demo/sample.json'</em>,\r
- success: <b>function</b>(response, opts) {\r
- <b>var</b> obj = Ext.decode(response.responseText);\r
- console.dir(obj);\r
- },\r
- failure: <b>function</b>(response, opts) {\r
- console.log(<em>'server-side failure <b>with</b> status code '</em> + response.status);\r
- }\r
-});</code></pre>\r
-<p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">An object which may contain the following properties:<ul>\r
-<li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to\r
-which to send the request, or a function to call which returns a URL string. The scope of the\r
-function is specified by the <tt>scope</tt> option. Defaults to the configured\r
-<tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a></tt>.</div></li>\r
-<li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">\r
-An object containing properties which are used as parameters to the\r
-request, a url encoded string or a function to call to get either. The scope of the function\r
-is specified by the <tt>scope</tt> option.</div></li>\r
-<li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use\r
-for the request. Defaults to the configured method, or if no method was configured,\r
-"GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that\r
-the method name is case-sensitive and should be all caps.</div></li>\r
-<li><b>callback</b> : Function (Optional)<div class="sub-desc">The\r
-function to be called upon receipt of the HTTP response. The callback is\r
-called regardless of success or failure and is passed the following\r
-parameters:<ul>\r
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-<li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>\r
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data. \r
-See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about \r
-accessing elements of the response.</div></li>\r
-</ul></div></li>\r
-<li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function\r
-to be called upon success of the request. The callback is passed the following\r
-parameters:<ul>\r
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-</ul></div></li>\r
-<li><b>failure</b> : Function (Optional)<div class="sub-desc">The function\r
-to be called upon failure of the request. The callback is passed the\r
-following parameters:<ul>\r
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-</ul></div></li>\r
-<li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in\r
-which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were\r
-specified as functions from which to draw values, then this also serves as the scope for those function calls.\r
-Defaults to the browser window.</div></li>\r
-<li><b>timeout</b> : Number (Optional)<div class="sub-desc">The timeout in milliseconds to be used for this request. Defaults to 30 seconds.</div></li>\r
-<li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt><form></tt>\r
-Element or the id of the <tt><form></tt> to pull parameters from.</div></li>\r
-<li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used \r
-with the <tt>form</tt> option</b>.\r
-<p>True if the form object is a file upload (will be set automatically if the form was\r
-configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>\r
-<p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>\r
-performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\r
-DOM <tt><form></tt> element temporarily modified to have its\r
-<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
-to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document\r
-but removed after the return data has been gathered.</p>\r
-<p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
-server is using JSON to send the return object, then the\r
-<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
-must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
-<p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
-is created containing a <tt>responseText</tt> property in order to conform to the\r
-requirements of event handlers and callbacks.</p>\r
-<p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>\r
-and some server technologies (notably JEE) may require some custom processing in order to\r
-retrieve parameter names and parameter values from the packet content.</p>\r
-</div></li>\r
-<li><b>headers</b> : Object (Optional)<div class="sub-desc">Request\r
-headers to set for the request.</div></li>\r
-<li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document\r
-to use for the post. Note: This will be used instead of params for the post\r
-data. Any params will be appended to the URL.</div></li>\r
-<li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON\r
-data to use as the post. Note: This will be used instead of params for the post\r
-data. Any params will be appended to the URL.</div></li>\r
-<li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True\r
-to add a unique cache-buster param to GET requests.</div></li>\r
-</ul></p>\r
-<p>The options object may also contain any other property which might be needed to perform\r
-postprocessing in a callback because it is passed to callback functions.</p></div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">transactionId The id of the server transaction. This may be used
+ Number<div class="mdesc"><div class="short">Sends an HTTP request to a remote server.
+Important: Ajax server requests are asynchronous, and this call will
+return...</div><div class="long"><p>Sends an HTTP request to a remote server.</p>
+<p><b>Important:</b> Ajax server requests are asynchronous, and this call will
+return before the response has been received. Process any returned data
+in a callback function.</p>
+<pre><code>Ext.Ajax.request({
+ url: <em>'ajax_demo/sample.json'</em>,
+ success: <b>function</b>(response, opts) {
+ <b>var</b> obj = Ext.decode(response.responseText);
+ console.dir(obj);
+ },
+ failure: <b>function</b>(response, opts) {
+ console.log(<em>'server-side failure <b>with</b> status code '</em> + response.status);
+ }
+});</code></pre>
+<p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">An object which may contain the following properties:<ul>
+<li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to
+which to send the request, or a function to call which returns a URL string. The scope of the
+function is specified by the <tt>scope</tt> option. Defaults to the configured
+<tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a></tt>.</div></li>
+<li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">
+An object containing properties which are used as parameters to the
+request, a url encoded string or a function to call to get either. The scope of the function
+is specified by the <tt>scope</tt> option.</div></li>
+<li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use
+for the request. Defaults to the configured method, or if no method was configured,
+"GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that
+the method name is case-sensitive and should be all caps.</div></li>
+<li><b>callback</b> : Function (Optional)<div class="sub-desc">The
+function to be called upon receipt of the HTTP response. The callback is
+called regardless of success or failure and is passed the following
+parameters:<ul>
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
+<li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.
+See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about
+accessing elements of the response.</div></li>
+</ul></div></li>
+<li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function
+to be called upon success of the request. The callback is passed the following
+parameters:<ul>
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
+</ul></div></li>
+<li><b>failure</b> : Function (Optional)<div class="sub-desc">The function
+to be called upon failure of the request. The callback is passed the
+following parameters:<ul>
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
+</ul></div></li>
+<li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in
+which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were
+specified as functions from which to draw values, then this also serves as the scope for those function calls.
+Defaults to the browser window.</div></li>
+<li><b>timeout</b> : Number (Optional)<div class="sub-desc">The timeout in milliseconds to be used for this request. Defaults to 30 seconds.</div></li>
+<li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt><form></tt>
+Element or the id of the <tt><form></tt> to pull parameters from.</div></li>
+<li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used
+with the <tt>form</tt> option</b>.
+<p>True if the form object is a file upload (will be set automatically if the form was
+configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>
+<p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>
+performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
+DOM <tt><form></tt> element temporarily modified to have its
+<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
+to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document
+but removed after the return data has been gathered.</p>
+<p>The server response is parsed by the browser to create the document for the IFRAME. If the
+server is using JSON to send the return object, then the
+<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
+must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
+<p>The response text is retrieved from the document, and a fake XMLHttpRequest object
+is created containing a <tt>responseText</tt> property in order to conform to the
+requirements of event handlers and callbacks.</p>
+<p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>
+and some server technologies (notably JEE) may require some custom processing in order to
+retrieve parameter names and parameter values from the packet content.</p>
+</div></li>
+<li><b>headers</b> : Object (Optional)<div class="sub-desc">Request
+headers to set for the request.</div></li>
+<li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document
+to use for the post. Note: This will be used instead of params for the post
+data. Any params will be appended to the URL.</div></li>
+<li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON
+data to use as the post. Note: This will be used instead of params for the post
+data. Any params will be appended to the URL.</div></li>
+<li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True
+to add a unique cache-buster param to GET requests.</div></li>
+</ul></p>
+<p>The options object may also contain any other property which might be needed to perform
+postprocessing in a callback because it is passed to callback functions.</p></div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">transactionId The id of the server transaction. This may be used
git.ithinksw.org / extjs.git / blobdiff