| Package | flash.events |
| Class | public class AVHTTPStatusEvent |
| Inheritance | AVHTTPStatusEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
AVHTTPStatusEvent objects are always sent before error or completion events. An AVHTTPStatusEvent object does not necessarily indicate an error condition; it simply reflects the HTTP status code (if any) that is provided by the networking stack. Some Flash Player environments may be unable to detect HTTP status codes; a status code of 0 is always reported in these cases.
In Flash Player, there is only one type of HTTPStatus event:
httpStatus. In the AIR runtime, a FileReference, URLLoader, or URLStream
can register to listen for an httpResponseStatus, which includes responseURL
and responseHeaders properties. These properties are undefined in a httpStatus
event.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| responseHeaders : Array
The response headers that the response returned, as an array of URLRequestHeader objects. | AVHTTPStatusEvent | ||
| responseURL : String
The URL that the response was returned from. | AVHTTPStatusEvent | ||
| status : int [read-only]
The HTTP status code returned by the server. | AVHTTPStatusEvent | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| Method | Defined By | ||
|---|---|---|---|
AVHTTPStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:int = 0, responseUrl:String = null, responseHeaders:Array = null)
Creates an Event object that contains specific information about HTTP status events. | AVHTTPStatusEvent | ||
[override]
Creates a copy of the AVHTTPStatusEvent object and sets the value of each property to match that of the original. | AVHTTPStatusEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the AVHTTPStatusEvent object. | AVHTTPStatusEvent | ||
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| AV_HTTP_RESPONSE_STATUS : String = "avHttpResponseStatus" [static]
Unlike the httpStatus event, the httpResponseStatus event is
delivered before any response data. | AVHTTPStatusEvent | ||
responseHeaders | property |
responseHeaders:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Lite 4 |
The response headers that the response returned, as an array of URLRequestHeader objects.
Implementation
public function get responseHeaders():Array public function set responseHeaders(value:Array):voidRelated API Elements
responseURL | property |
responseURL:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Lite 4 |
The URL that the response was returned from. In the case of redirects, this will be different from the request URL.
Implementation
public function get responseURL():String public function set responseURL(value:String):voidstatus | property |
status:int [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
The HTTP status code returned by the server. For example, a value of 404 indicates that the server has not found a match for the requested URI. HTTP status codes can be found in sections 10.4 and 10.5 of the HTTP specification at http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
If Flash Player or AIR cannot get a status code from the server, or if it cannot communicate with the server, the default value of 0 is passed to your code. A value of 0 can be generated in any player (for example, if a malformed URL is requested), and a value of 0 is always generated by the Flash Player plug-in when it is run in the following browsers, which do not pass HTTP status codes to the player: Netscape, Mozilla, Safari, Opera, and Internet Explorer for the Macintosh.
Implementation
public function get status():intAVHTTPStatusEvent | () | Constructor |
public function AVHTTPStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:int = 0, responseUrl:String = null, responseHeaders:Array = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Creates an Event object that contains specific information about HTTP status events. Event objects are passed as parameters to event listeners.
Parameterstype:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of HTTPStatus event: AVHTTPStatusEvent.HTTP_STATUS.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
status:int (default = 0)status property.
| |
responseUrl:String (default = null) | |
responseHeaders:Array (default = null) |
Related API Elements
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Creates a copy of the AVHTTPStatusEvent object and sets the value of each property to match that of the original.
ReturnsEvent — A new AVHTTPStatusEvent object with property values that match those of the original.
|
toString | () | method |
override public function toString():String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Returns a string that contains all the properties of the AVHTTPStatusEvent object. The string is in the following format:
[AVHTTPStatusEvent type=value bubbles=value cancelable=value status=value]
String — A string that contains all the properties of the AVHTTPStatusEvent object.
|
AV_HTTP_RESPONSE_STATUS | Constant |
public static const AV_HTTP_RESPONSE_STATUS:String = "avHttpResponseStatus"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Lite 4 |
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.
The AVHTTPStatusEvent.HTTP_RESPONSE_STATUS constant defines the value of the
type property of a httpResponseStatus event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
responseURL | The URL from which the response was returned. |
responseHeaders | The response headers that the response returned, as an array of URLRequestHeader objects. |
status | The HTTP status code returned by the server. |
target | The network object receiving an HTTP status code. |
Related API Elements
Mon Apr 10 2017, 12:28 PM -07:00