testing.net.XhrIo Extends goog.events.EventTarget
Mock implementation of goog.net.XhrIo. This doesn't provide a mock implementation for all cases, but it's not too hard to add them as needed.

Inheritance

Constructor

goog.testing.net.XhrIo(opt_testQueue)

Parameters

opt_testQueue : goog.testing.TestQueue=
Test queue for inserting test events.

Instance Methods

Public Protected Private
abort(opt_failureCode)
Abort the current XMLHttpRequest
Arguments:
opt_failureCode : goog.net.ErrorCode=
Optional error code to use - defaults to ABORT.
code »
createXhr() goog.net.XhrLike.OrNative
Creates a new XHR object.
Returns: goog.net.XhrLike.OrNative  The newly created XHR object.
code »
getAllResponseHeaders() string
Gets the text of all the headers in the response. Will only return correct result when called from the context of a callback and the request has completed
Returns: string  The string containing all the response headers.
code »
getLastContent() string | undefined
Gets the last POST content that was requested.
Returns: string | undefined  Last POST content or undefined if last request was a GET.
code »
getLastError() string
Gets the last error message.
Returns: string  Last error message.
code »
getLastErrorCode() goog.net.ErrorCode
Gets the last error message.
Returns: goog.net.ErrorCode  Last error code.
code »
getLastMethod() string | undefined
Gets the last HTTP method that was requested.
Returns: string | undefined  Last HTTP method used by send.
code »
getLastRequestHeaders() Object | goog.structs.Map | undefined
Gets the headers of the last request.
Returns: Object | goog.structs.Map | undefined  Last headers manually set in send call or undefined if no additional headers were specified.
code »
getLastUri() string
Gets the last URI that was requested.
Returns: string  Last URI.
code »
getReadyState() number
Returns the readystate.
Returns: number  goog.net.XmlHttp.ReadyState.*.
code »
getResponse() *
Get the response as the type specificed by #setResponseType. At time of writing, this is only supported in very recent versions of WebKit (10.0.612.1 dev and later).
Returns: *  The response.
code »
getResponseBody() Object
Gets the response body from the Xhr object. Will only return correct result when called from the context of a callback.
Returns: Object  Binary result from the server or null.
code »
getResponseHeader(key) string | undefined
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
Arguments:
key : string
The name of the response-header to retrieve.
Returns: string | undefined  The value of the response-header named key.
code »
getResponseHeaders() !Object.<string, string>
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
Returns: !Object.<string, string>  An object with the header keys as keys and header values as values.
code »
getResponseJson(opt_xssiPrefix) Object
Gets the response and evaluates it as JSON from the Xhr object. Will only return correct result when called from the context of a callback.
Arguments:
opt_xssiPrefix : string=
Optional XSSI prefix string to use for stripping of the response before parsing. This needs to be set only if your backend server prepends the same prefix string to the JSON response.
Returns: Object  JavaScript object.
code »
getResponseText() string
Gets the response text from the Xhr object. Will only return correct result when called from the context of a callback.
Returns: string  Result from the server.
code »
getResponseType() goog.net.XhrIo.ResponseType
Gets the desired type for the response.
Returns: goog.net.XhrIo.ResponseType  The desired type for the response.
code »
getResponseXml() Document
Gets the response XML from the Xhr object. Will only return correct result when called from the context of a callback.
Returns: Document  Result from the server if it was XML.
code »
getStatus() number
Get the status from the Xhr object. Will only return correct result when called from the context of a callback.
Returns: number  Http status.
code »
getStatusText() string
Get the status text from the Xhr object. Will only return correct result when called from the context of a callback.
Returns: string  Status text.
code »
getTimeoutInterval() number
Returns the number of milliseconds after which an incomplete request will be aborted, or 0 if no timeout is set.
Returns: number  Timeout interval in milliseconds.
code »
getWithCredentials() boolean
Gets whether a "credentialed" request is to be sent.
Returns: boolean  The desired type for the response.
code »
isActive() boolean
No description.
Returns: boolean  Whether there is an active request.
code »
isComplete() boolean
Has the request completed.
Returns: boolean  Whether the request has completed.
code »
isSuccess() boolean
Has the request compeleted with a success.
Returns: boolean  Whether the request compeleted successfully.
code »
send(urlopt_methodopt_contentopt_headers)
Simulates the XhrIo send.
Arguments:
url : string
Uri to make request too.
opt_method : string=
Send method, default: GET.
opt_content : string=
Post data.
opt_headers : Object | goog.structs.Map=
Map of headers to add to the request.
code »
setResponseType(type)
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.
Arguments:
type : goog.net.XhrIo.ResponseType
The desired type for the response.
code »
setTimeoutInterval(ms)
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.
Arguments:
ms : number
Timeout interval in milliseconds; 0 means none.
code »
setWithCredentials(withCredentials)
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.
Arguments:
withCredentials : boolean
Whether this should be a "credentialed" request.
code »
simulatePartialResponse(partialResponseopt_headers)
Simulate receiving some bytes but the request not fully completing, and the XHR entering the 'INTERACTIVE' state.
Arguments:
partialResponse : string
A string to append to the response text.
opt_headers : Object=
Simulated response headers.
code »
simulateReady()
Simulates the Xhr is ready for the next request.
code »
simulateReadyStateChange(readyState)
Simulates changing to the new ready state.
Arguments:
readyState : number
Ready state to change to.
code »
simulateResponse(statusCoderesponseopt_headers)
Simulates receiving a response.
Arguments:
statusCode : number
Simulated status code.
response : string | Document | null
Simulated response.
opt_headers : Object=
Simulated response headers.
code »
simulateTimeout()
Causes timeout events to be fired.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() goog.events.EventTarget
Returns the parent of this event target to use for bubbling.
Returns: goog.events.EventTarget  The parent EventTarget or null if there is no parent.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

active_ :
Whether MockXhrIo is active.
Code »
constructor :
No description.
Code »
headers : goog.structs.Map
Map of default headers to add to every request, use: XhrIo.headers.set(name, value)
Code »
lastContent_ :
Last POST content that was requested.
Code »
lastErrorCode_ :
Last error code.
Code »
lastError_ :
Last error message.
Code »
lastHeaders_ :
Additional headers that were requested in the last query.
Code »
lastMethod_ :
Last HTTP method that was requested.
Code »
lastUri_ :
Last URI that was requested.
Code »
readyState_ :
Mock ready state.
Code »
responseHeaders_ :
Stores the simulated response headers for the requests which are sent through this XhrIo.
Code »
responseType_ :
The requested type for the response. The empty string means use the default XHR behavior.
Code »
response_ :
The response object.
Code »
testQueue_ : goog.testing.TestQueue
Queue of events write to.
Code »
timeoutId_ :
Window timeout ID used to cancel the timeout event handler if the request completes successfully.
Code »
timeoutInterval_ :
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.
Code »
withCredentials_ :
Whether a "credentialed" request is to be sent (one that is aware of cookies and authentication) . This is applicable only for cross-domain requests and more recent browsers that support this part of the HTTP Access Control standard.
Code »
xhr_ :
Whether there's currently an underlying XHR object.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Methods

goog.testing.net.XhrIo.cleanup()
Disposes all non-disposed instances of goog.testing.net.XhrIo created by goog.testing.net.XhrIo.send.
code »
goog.testing.net.XhrIo.cleanupSend_(XhrIo)
Disposes of the specified goog.testing.net.XhrIo created by goog.testing.net.XhrIo.send and removes it from goog.testing.net.XhrIo.pendingStaticSendInstances_.
Arguments:
XhrIo : goog.testing.net.XhrIo
An XhrIo created by goog.testing.net.XhrIo.send.
code »
goog.testing.net.XhrIo.getSendInstances() Array
Returns an Array containing all non-disposed instances of goog.testing.net.XhrIo created by goog.testing.net.XhrIo.send.
Returns: Array  Array of goog.testing.net.XhrIo instances.
code »
goog.testing.net.XhrIo.send(urlopt_callbackopt_methodopt_contentopt_headersopt_timeoutInterval)
Simulates the static XhrIo send method.
Arguments:
url : string
Uri to make request to.
opt_callback : Function=
Callback function for when request is complete.
opt_method : string=
Send method, default: GET.
opt_content : string=
Post data.
opt_headers : Object | goog.structs.Map=
Map of headers to add to the request.
opt_timeoutInterval : number=
Number of milliseconds after which an incomplete request will be aborted; 0 means no timeout is set.
code »

Static Properties

goog.testing.net.XhrIo.sendInstances_ :
All non-disposed instances of goog.testing.net.XhrIo created by goog.testing.net.XhrIo.send are in this Array.
Code »
goog.testing.net.XhrIo.superClass_ :
No description.
Code »

Enumerations

goog.testing.net.XhrIo.ResponseType :
Alias this enum here to make mocking of goog.net.XhrIo easier.
Constants:
Code »

Package testing.net

Package Reference