Class google.gdata.client.TransportResponse

Object
   |
   +--google.gdata.client.TransportResponse

class google.gdata.client.TransportResponse

Defined in gdata.js

Constructor Detail

google.gdata.client.TransportResponse

google.gdata.client.TransportResponse()

addHeader

void addHeader(<string> headerKey, <string> headerValue)

Adds a header to the response.

Parameters:
headerKey - The key used to access the header.
headerValue - The value of the header.

getResponseHeader

string getResponseHeader(<string> headerKey)

Retrieves the header value with the given key.

Parameters:
headerKey - The key used to access the header.

Returns:
The value of the header.

getResponseText

string getResponseText()

Retreives the response text.

Returns:
The response text.

getResponseXml

string getResponseXml()

Retreives the response text as xml.

Returns:
The response text as xml.

getStatus

number getStatus()

Retrieves the http status code of the response.

Returns:
The http status code of the response.

getStatusText

string getStatusText()

Retreives the text associated with the http status code of the response.

Returns:
The text associated with the http status code of the response.

setResponseText

void setResponseText( <string> responseText)

Sets the response text.

Parameters:
responseText - The response text.

setResponseXml

void setResponseXml( <string> responseXml)

Sets the response text as xml.

Parameters:
responseXml - The response text as xml.

setStatus

void setStatus(<number> status)

Sets the http status code of the response.

Parameters:
status - The http status code of the response.

setStatusText

void setStatusText( <string> statusText)

Sets the text associated with the http status code of the response.

Parameters:
statusText - The text associated with the http status code of the response.

create

<static> google.gdata.client.TransportResponse create(<Object> sourceResponse)

Creates a google.gdata.client.TransportResponse object. The input parameters is a response object from an http request (such as the response from an XmlHttpRequest). This method will try its best to massage the input into a valid google.gdata.client.TransportResponse object.

Parameters:
sourceResponse - The response object from an http request.

Returns:
The response object transformed into a google.gdata.client.TransportResponse object.