Returns the number of bytes of data available for reading in the input buffer. Your code must call the bytesAvailable property to ensure that sufficient data is available before you try to read it with one of the read methods.

Indicates whether this URLStream object is currently connected. A call to this property returns a value of true if the URLStream object is connected, or false otherwise.

Indicates the byte order for the data. Possible values are Endian.BIG_ENDIAN or Endian.LITTLE_ENDIAN.

The default value is Endian.BIG_ENDIAN.

See also

Controls the version of Action Message Format (AMF) used when writing or reading an object.

See also

Immediately closes the stream and cancels the download operation. No data can be read from the stream after the close() method is called.

Begins downloading the URL specified in the request parameter.

Note: If a file being loaded contains non-ASCII characters (as found in many non-English languages), it is recommended that you save the file with UTF-8 or UTF-16 encoding, as opposed to a non-Unicode format like ASCII.

If the loading operation fails immediately, an IOError or SecurityError (including the local file security error) exception is thrown describing the failure. Otherwise, an open event is dispatched if the URL download starts downloading successfully, or an error event is dispatched if an error occurs.

By default, the calling SWF file and the URL you load must be in exactly the same domain. For example, a SWF file at www.adobe.com can load data only from sources that are also at www.adobe.com. To load data from a different domain, place a URL policy file on the server hosting the data.

In AIR, a URLRequest object can register for the httpResponse status event. Unlike the httpStatus event, the httpResponseStatus event is delivered before any response data. Also, the httpResponseStatus event includes values for the responseHeaders and responseURL properties (which are undefined for an httpStatus event. Note that the httpResponseStatus event (if any) will be sent before (and in addition to) any complete or error event.

If there is an httpResponseStatus event listener, the body of the response message is always sent; and HTTP status code responses always results in a complete event. This is true in spite of whether the HTTP response status code indicates a success or an error.

If there is no httpResponseStatus event listener, the behavior differs based on the AIR version:

• In an AIR file in which the application descriptor specifies AIR 1.0 or 1.1 as the runtime version, the body of the HTTP response message is sent only if the HTTP response status code indicates success. Otherwise (if there is an error), no body is sent and the URLRequest object dispatches an IOError event.
• In an AIR file in which the application descriptor specifies AIR 1.5 as the runtime version, the body of the HTTP response message is always sent. If there is an error, the URLRequest object dispatches an IOError event.

Parameters

Reads a Boolean value from the stream. A single byte is read, and true is returned if the byte is nonzero, false otherwise.

Reads a signed byte from the stream.

The returned value is in the range -128...127.

Reads length bytes of data from the stream. The bytes are read into the ByteArray object specified by bytes, starting offset bytes into the ByteArray object.

Parameters

Reads an IEEE 754 double-precision floating-point number from the stream.

Reads an IEEE 754 single-precision floating-point number from the stream.

Reads a signed 32-bit integer from the stream.

The returned value is in the range -2147483648...2147483647.

Reads a multibyte string of specified length from the byte stream using the specified character set.

Parameters

Reads an object from the socket, encoded in Action Message Format (AMF).

See also

Reads a signed 16-bit integer from the stream.

The returned value is in the range -32768...32767.

Reads an unsigned byte from the stream.

The returned value is in the range 0...255.

Reads an unsigned 32-bit integer from the stream.

The returned value is in the range 0...4294967295.

Reads an unsigned 16-bit integer from the stream.

The returned value is in the range 0...65535.

Reads a UTF-8 string from the stream. The string is assumed to be prefixed with an unsigned short indicating the length in bytes.

Reads a sequence of length UTF-8 bytes from the stream, and returns a string.

Parameters

Dispatched when data has loaded successfully.

This event has the following properties:

Dispatched if a call to the URLStream.load() method attempts to access data over HTTP and Adobe AIR is able to detect and return the status code for the request.

If a URLStream object registers for an httpStatusEvent event, error responses are delivered as though they are content. So instead of dispatching an ioError event, the URLStream dispatches progress and complete events as the error data is loaded into the URLStream.

The HTTPStatusEvent.HTTP_RESPONSE_STATUS constant defines the value of the type property of a httpResponseStatus event object.

This event has the following properties:

See also

Dispatched if a call to URLStream.load() attempts to access data over HTTP, and Adobe AIR is able to detect and return the status code for the request. (Some browser environments may not be able to provide this information.) Note that the httpStatus (if any) will be sent before (and in addition to) any complete or error event.

This event has the following properties:

See also

Dispatched when an input/output error occurs that causes a load operation to fail.

This event has the following properties:

See also

Dispatched when a load operation starts.

This event has the following properties:

See also

Dispatched when data is received as the download operation progresses. Data that has been received can be read immediately using the methods of the URLStream class.

This event has the following properties:

See also

Dispatched if a call to URLStream.load() attempts to load data from a server outside the security sandbox.

This event has the following properties:

See also

Note: To test this example:

1. Add the AIRAliases.js file to the project directory.
2. Place a file named URLStreamExample.zip in the project directory
3. Create an application descriptor file for the project, and test the project using ADL.

<html>
    <head>
      <script src="AIRAliases.js" />
      <script>
        function init() {
            stream = new air.URLStream();
            var request = new air.URLRequest("URLStreamExample.zip");
            configureListeners(stream);
            try {
                stream.load(request);
            } catch (error) {
                air.trace("Unable to load requested URL.");
            }
        }

        function configureListeners(dispatcher) {
            dispatcher.addEventListener(air.Event.COMPLETE, completeHandler);
            dispatcher.addEventListener(air.HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
            dispatcher.addEventListener(air.IOErrorEvent.IO_ERROR, ioErrorHandler);
            dispatcher.addEventListener(air.Event.OPEN, openHandler);
            dispatcher.addEventListener(air.ProgressEvent.PROGRESS, progressHandler);
            dispatcher.addEventListener(air.SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
        }

        function parseHeader() {
            air.trace("parseHeader");
            air.trace("isCompressed: " + isCompressed());
            air.trace("version: " + stream.readByte());
        }

        function isCompressed() {
            return stream.readUTFBytes(3) == air.CompressionAlgorithm.ZLIB ;
        }

        function completeHandler(event) {
            air.trace("completeHandler: " + event);
            parseHeader();
        }

        function openHandler(event) {
            air.trace("openHandler: " + event);
        }

        function progressHandler(event) {
            air.trace("progressHandler: " + event);
        }

        function securityErrorHandler(event) {
            air.trace("securityErrorHandler: " + event);
        }

        function httpStatusHandler(event) {
            air.trace("httpStatusHandler: " + event);
        }

        function ioErrorHandler(event) {
            air.trace("ioErrorHandler: " + event);
        }
      </script>
    </head>
    <body onload='init()'>
    </body>
</html>