mozilla

Compare Revisions

nsIXMLHttpRequest

Change Revisions

Revision 59571:

Revision 59571 by Cancerbero sgx on

Revision 59572:

Revision 59572 by Cancerbero sgx on

Title:
nsIXMLHttpRequest
nsIXMLHttpRequest
Slug:
nsIXMLHttpRequest
nsIXMLHttpRequest
Tags:
NeedsTechnicalReview, Interfaces, XMLHttpRequest, "XPCOM API Reference", "XPCOM Interface Reference"
NeedsTechnicalReview, Interfaces, XMLHttpRequest, "XPCOM API Reference", "XPCOM Interface Reference"
Content:

Revision 59571
Revision 59572
tt156    <h4 name="abort">
157      abort
158    </h4>
159    <pre class="eval">
160 void   abort();
161</pre>
162    <p>
163      If the request has been sent already, this method will abor
 >t the request.
164    </p>
165    <h4 name="getAllResponseHeaders">
166      getAllResponseHeaders
167    </h4>
168    <pre class="eval">
169 string getAllResponseHeaders();
170</pre>
171    <p>
172      Returns all of the response headers as a string for HTTP re
 >quests.
173    </p>
174    <p>
175      Note that this will return all the headers from the *curren
 >t* part of a multipart request, not from the original channel. <c
 >ode>Returns</code> A string containing all of the response header
 >s or NULL if the response has not yet been received.
176    </p>
177    <h4 name="getResponseHeader">
178      getResponseHeader
179    </h4>
180    <pre class="eval">
181 ACString getResponseHeader(in AUTF8String header);
182</pre>
183    <p>
184      Returns the text of the header with the specified name for 
 >HTTP requests.
185    </p>
186    <p>
187      <code>header</code> - The name of the header to retrieve
188    </p>
189    <p>
190      Returns a string containing the text of the header specifie
 >d or NULL if the response has not yet been received or the header
 > does not exist in the response.
191    </p>
192    <h4 name="openRequest">
193      openRequest
194    </h4>
195    <pre class="eval">
196  [noscript] void   openRequest(in AUTF8String method,
197                                in AUTF8String url,
198                                in boolean async,
199                                in AString user,
200                                in AString password);
201</pre>
202    <p>
203      Native (non-script) method to initialize a request. Note th
 >at the request is not sent until the <code>send</code> method is 
 >invoked.
204    </p>
205    <p>
206      If there is an "active" request (that is, if open() or open
 >Request() has been called already), this is equivalent to calling
 > abort().
207    </p>
208    <p>
209      <code>method</code> - The HTTP method, for example "POST" o
 >r "GET". Ignored if the URL is not a HTTP(S) URL. <code>url</code
 >> - The URL to which to send the request. <code>async</code> - Wh
 >ether the request is synchronous or asynchronous i.e. whether sen
 >d returns only after the response is received or if it returns im
 >mediately after sending the request. In the latter case, notifica
 >tion of completion is sent through the event listeners. This argu
 >ment must be true if the multipart attribute has been set to true
 >, or an exception will be thrown. <code>user</code> - A username 
 >for authentication if necessary. <code>password</code> - A passwo
 >rd for authentication if necessary.
210    </p>
211    <h4 name="open">
212      open
213    </h4>
214    <pre class="eval">
215 void   open(in AUTF8String method, in AUTF8String url);
216</pre>
217    <p>
218      Meant to be a script-only method for initializing a request
 >. The parameters are similar to the ones detailed in the descript
 >ion of <code>openRequest</code>, but the last 3 are optional.
219    </p>
220    <p>
221      If there is an "active" request (that is, if <code>open()</
 >code> or <code>openRequest()</code> has been called already), thi
 >s is equivalent to calling <code>abort()</code>.
222    </p>
223    <p>
224      <code>method</code> - The HTTP method - either "POST" or "G
 >ET". Ignored if the URL is not a HTTP URL. <code>url</code> - The
 > URL to which to send the request. <code>async</code> - (optional
 >) Whether the request is synchronous or asynchronous i.e. whether
 > send returns only after the response is received or if it return
 >s immediately after sending the request. In the latter case, noti
 >fication of completion is sent through the event listeners. The d
 >efault value is true. This argument must be true if the multipart
 > attribute has been set to true, or an exception will be thrown. 
 ><code>user</code> - (optional) A username for authentication if n
 >ecessary. The default value is the empty string <code>password</c
 >ode> - (optional) A password for authentication if necessary. The
 > default value is the empty string
225    </p>
226    <h4 name="send">
227      send
228    </h4>
229    <pre class="eval">
230 void   send(in nsIVariant body);
231</pre>
232    <p>
233      Sends the request. If the request is asynchronous, returns 
 >immediately after sending the request. If it is synchronous retur
 >ns only after the response has been received.
234    </p>
235    <p>
236      All event listeners must be set before calling send().
237    </p>
238    <p>
239      After the initial response, all event listeners will be cle
 >ared.
240    </p>
241    <p>
242      <code>body</code> - Either an instance of nsIDOMDocument, n
 >sIInputStream or a string (nsISupportsString in the native callin
 >g case). This is used to populate the body of the HTTP request if
 > the HTTP request method is "POST". If the parameter is a nsIDOMD
 >ocument, it is serialized. If the parameter is a nsIInputStream, 
 >then it must be compatible with nsIUploadChannel.setUploadStream,
 > and a Content-Length header will be added to the HTTP request wi
 >th a value given by nsIInputStream.available. Any headers include
 >d at the top of the stream will be treated as part of the message
 > body. The MIME type of the stream should be specified by setting
 > the Content- Type header via the setRequestHeader method before 
 >calling send.
243    </p>
244    <h4 name="setRequestHeader">
245      setRequestHeader
246    </h4>
247    <pre class="eval">
248 void   setRequestHeader(in AUTF8String header, in AUTF8String va
 >lue);
249</pre>
250    <p>
251      Sets a HTTP request header for HTTP requests. You must call
 > open before setting the request headers.
252    </p>
253    <p>
254      <code>header</code> - The name of the header to set in the 
 >request. <code>value</code> - The body of the header.
255    </p>
256    <h4 name="overrideMimeType">
257      overrideMimeType
258    </h4>
259    <pre class="eval">
260 void   overrideMimeType(in AUTF8String mimetype);
261</pre>
262    <p>
263      Override the mime type returned by the server (if any). Thi
 >s may be used, for example, to force a stream to be treated and p
 >arsed as text/xml, even if the server does not report it as such.
 > This must be done before the <code>send</code> method is invoked
 >. <code>mimetype</code> - The type used to override that returned
 > by the server (if any).
264    </p>

Back to History