Titanium.Network.HTTPClient

object
0.3.0
An HTTPClient which can be used as an alternative to XMLHttpRequest.

Methods

abort Aborts an in progress connection
clearCookies Clear any cookies set on the request
getCookie Get a HTTP cookie from the response.
getMaxRedirects Get the maximum number of redirects to follow. The default is -1, which means that there is no maximum limit to the number of redirects to follow.
getResponseHeader Return the value of a response header, given it's name. If the given name occurs multiple times, this method will only return one occurence.
getResponseHeaders Return all response headers as an array of two element arrays.
getTimeout Return the current timeout setting of this Network.HTTPClient object in milliseconds. Thie value may be -1 to indicate no timeout. The default timeout value is five minutes.
open Opens an HTTP connection
receive Sends a request to the server and receive data with the provided handler.
send Sends data through the HTTP connection
sendFile Sends the contents of a file as body content
setBasicCredentials Set the basic authentication credentials
setCookie Set a HTTP cookie in the request.
setCredentials Set the authentication credentials for the HTTPClient.
setMaxRedirects Set the maximum number of redirects to follow. The default is -1, which means that there is no maximum limit to the number of redirects to follow.
setRequestHeader Sets a request header for the connection
setTimeout Set the timeout setting of this Network.HTTPClient. Thie value may be -1 to indicate no timeout. The default timeout value is five minutes.

Properties

Name Type Description
DONE String The DONE readyState property
HEADERS_RECEIVED String The HEADERS_RECEIVED readyState property
LOADING String The LOADING readyState property
OPENED String The OPENED readyState property
UNSENT String The UNSENT readyState property.
connected String Whether an HTTPClient object is connected or not
dataReceived String Amount of data received from server so far. Updated on HTTP_DATA_RECEIVED event.
dataSent String Amount of data sent to server so far. Updated on HTTP_DATA_SENT event.
ondatastream String The handler function that will be fired as stream data is received from an HTTP request
onload String The handler function that will be fired when request is completed
onreadystatechange String The handler function that will be fired when the readyState code of an HTTPClient object changes.
onsendstream String The handler function that will be fired as the stream data is sent.
readyState String The ready-state status for the connection
responseData String The response of an HTTP request as a Blob. Currently this property is only valid after the request has been completed.
responseText String The response of an HTTP request as text
responseXML String The response of an HTTP request as parsable XML
status String The response status code of an HTTP request
statusText String The response status text of an HTTP Request
timedOut String True if HTTP request timed out
url String The request URL. This value will be updated on redirect events.
userAgent String User agent string to use for requests. (Default: PRODUCTNAME/PRODUCT_VERSION)

Desktop API Reference