goog.net.XhrIo

Abort the current XMLHttpRequest

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Creates a new XHR object.

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object.

If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

Disposes of the object and its resources.

Nullifies all callbacks to reduce risks of leaks.

Fires all registered listeners in this listenable for the given type and capture mode, passing them the given eventObject. This does not perform actual capture/bubble. Only implementors of the interface should be using this.

Gets the text of all the headers in the response. Will only return correct result after ready state reaches LOADED (i.e. HEADERS_RECEIVED as per MDN).

Gets the text of all the headers in the response. As opposed to #getAllResponseHeaders, this method does not require that the request has completed.

Get the last error message

Get the last error message

Get the last Uri that was requested

Gets the goog.events.ListenableKey for the event or null if no such listener is in use.

Gets all listeners in this listenable for the given type and capture mode.

Returns the parent of this event target to use for capture/bubble mechanism.

NOTE(chrishenry): The name reflects the original implementation of custom event target (goog.events.EventTarget). We decided that changing the name is not worth it.

Gets whether progress events are enabled.

Get the readystate from the Xhr object Will only return correct result when called from the context of a callback

Get the response as the type specificed by #setResponseType. At time of writing, this is only directly supported in very recent versions of WebKit (10.0.612.1 dev and later). If the field is not supported directly, we will try to emulate it.

Emulating the response means following the rules laid out at http://www.w3.org/TR/XMLHttpRequest/#the-response-attribute

On browsers with no support for this (Chrome < 10, Firefox < 4, etc), only response types of DEFAULT or TEXT may be used, and the response returned will be the text response.

On browsers with Mozilla's draft support for array buffers (Firefox 4, 5), only response types of DEFAULT, TEXT, and ARRAY_BUFFER may be used, and the response returned will be either the text response or the Mozilla implementation of the array buffer response.

On browsers will full support, any valid response type supported by the browser may be used, and the response provided by the browser will be returned.

Get the response body from the Xhr object. This property is only available in IE since version 7 according to MSDN: http://msdn.microsoft.com/en-us/library/ie/ms534368(v=vs.85).aspx Will only return correct result when called from the context of a callback.

One option is to construct a VBArray from the returned object and convert it to a JavaScript array using the toArray method: (new window['VBArray'](xhrIo.getResponseBody())).toArray() This will result in an array of numbers in the range of [0..255]

Another option is to use the VBScript CStr method to convert it into a string as outlined in http://stackoverflow.com/questions/1919972

Get the value of the response-header with the given name from the Xhr object Will only return correct result when called from the context of a callback and the request has completed

Returns all response headers as a key-value map. Multiple values for the same header key can be combined into one, separated by a comma and a space. Note that the native getResponseHeader method for retrieving a single header does a case insensitive match on the header name. This method does not include any case normalization logic, it will just return a key-value representation of the headers. See: http://www.w3.org/TR/XMLHttpRequest/#the-getresponseheader()-method

Get the response and evaluates it as JSON from the Xhr object Will only return correct result when called from the context of a callback

Get the response text from the Xhr object Will only return correct result when called from the context of a callback.

Gets the desired type for the response.

Get the response XML from the Xhr object Will only return correct result when called from the context of a callback.

Get the status from the Xhr object Will only return correct result when called from the context of a callback

Get the status text from the Xhr object Will only return correct result when called from the context of a callback

Get the value of the response-header with the given name from the Xhr object. As opposed to #getResponseHeader, this method does not require that the request has completed.

Returns the number of milliseconds after which an incomplete request will be aborted, or 0 if no timeout is set.

Gets whether a "credentialed" request is to be sent.

Whether there is any active listeners matching the specified signature. If either the type or capture parameters are unspecified, the function will match on the remaining criteria.

Adds an event listener. A listener can only be added once to an object and if it is added again the key for the listener is returned. Note that if the existing listener is a one-off listener (registered via listenOnce), it will no longer be a one-off listener after a call to listen().

Adds an event listener that is removed automatically after the listener fired once.

If an existing listener already exists, listenOnce will do nothing. In particular, if the listener was previously registered via listen(), listenOnce() will not turn the listener into a one-off listener. Similarly, if there is already an existing one-off listener, listenOnce does not modify the listeners (it is still a once listener).

Associates a disposable object with this object so that they will be disposed together.

Removes all listeners from this listenable. If type is specified, it will only remove listeners of the particular type. otherwise all registered listeners will be removed.

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

Instance send that actually uses XMLHttpRequest to make a server call.

Sets the parent of this event target to use for capture/bubble mechanism.

Sets whether progress events are enabled for this request. Note that progress events require pre-flight OPTIONS request handling for CORS requests, and may cause trouble with older browsers. See progressEventsEnabled_ for details.

Sets the desired type for the response. At time of writing, this is only supported in very recent versions of WebKit (10.0.612.1 dev and later).

If this is used, the response may only be accessed via #getResponse.

Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.

Sets the number of milliseconds after which an incomplete request will be aborted and a goog.net.EventType.TIMEOUT event raised; 0 means no timeout is set.

Specify a Trust Tokens operation to execute alongside the request.

Sets whether a "credentialed" request that is aware of cookie and authentication information should be made. This option is only supported by browsers that support HTTP Access Control. As of this writing, this option is not supported in IE.

Removes an event listener which was added with listen() or listenOnce().

Removes an event listener which was added with listen() by the key returned by listen().

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

Map of default headers to add to every request, use: XhrIo.headers.set(name, value)

Disposes all non-disposed instances of goog.net.XhrIo created by goog.net.XhrIo.send. goog.net.XhrIo.send cleans up the goog.net.XhrIo instance it creates when the request completes or fails. However, if the request never completes, then the goog.net.XhrIo is not disposed. This can occur if the window is unloaded before the request completes. We could have goog.net.XhrIo.send return the goog.net.XhrIo it creates and make the client of goog.net.XhrIo.send be responsible for disposing it in this case. However, this makes things significantly more complicated for the client, and the whole point of goog.net.XhrIo.send is that it's simple and easy to use. Clients of goog.net.XhrIo.send should call goog.net.XhrIo.cleanup when doing final cleanup on window unload.

Installs exception protection for all entry point introduced by goog.net.XhrIo instances which are not protected by goog.debug.ErrorHandler#protectWindowSetTimeout, goog.debug.ErrorHandler#protectWindowSetInterval, or goog.events.protectBrowserEventEntryPoint.

Static send that creates a short lived instance of XhrIo to send the request.

The Content-Transfer-Encoding HTTP header name

The Content-Type HTTP header name

The Content-Type HTTP header value for a url-encoded form

The pattern matching the 'http' and 'https' URI schemes

The methods that typically come along with form data. We set different headers depending on whether the HTTP action is one of these.