Package | flash.events |
Class | public class HTTPStatusEvent |
Inheritance | HTTPStatusEvent Event Object |
Language version: | ActionScript 3.0 |
Runtime version: |
HTTPStatusEvent objects are always sent before error or completion events. An HTTPStatusEvent 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.
Property | Defined by | ||
---|---|---|---|
bubbles : Boolean
Indicates whether an event is a bubbling event.
| Event | ||
cancelable : Boolean
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
The object that is actively processing the Event object with an event listener.
| Event | ||
eventPhase : uint
The current phase in the event flow.
| Event | ||
prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | ||
redirected : Boolean
Indicates whether the request was redirected.
| HTTPStatusEvent | ||
responseHeaders : Array
The response headers that the response returned, as an array of URLRequestHeader objects.
| HTTPStatusEvent | ||
responseURL : String
The URL that the response was returned from.
| HTTPStatusEvent | ||
status : int
[read-only]
The HTTP status code returned by the server.
| HTTPStatusEvent | ||
target : Object
The event target.
| Event | ||
type : String
The type of event.
| Event |
Method | Defined by | ||
---|---|---|---|
HTTPStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:int = 0, redirected:Boolean = false)
Creates an Event object that contains specific information about HTTP status events.
| HTTPStatusEvent | ||
Creates a copy of the HTTPStatusEvent object and sets the value of each property to match that of the original.
| HTTPStatusEvent | ||
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 | ||
Returns a string that contains all the properties of the HTTPStatusEvent object.
| HTTPStatusEvent | ||
Returns the primitive value of the specified object.
| Object |
Constant | Defined by | ||
---|---|---|---|
ACTIVATE : String = "activate" [static]
The
ACTIVATE constant defines the value of the type property of an activate event object. | Event | ||
ADDED : String = "added" [static]
The
Event.ADDED constant defines the value of the type property of
an added event object. | Event | ||
ADDED_TO_STAGE : String = "addedToStage" [static]
The
Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | ||
BROWSER_ZOOM_CHANGE : String = "browserZoomChange" [static]
The
Event.BROWSER_ZOOM_CHANGE constant defines the value of the type
property of an browserZoomChange event object. | Event | ||
CANCEL : String = "cancel" [static]
The
Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | ||
CHANGE : String = "change" [static]
The
Event.CHANGE constant defines the value of the type property of a change event object. | Event | ||
CHANNEL_MESSAGE : String = "channelMessage" [static]
The
Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object. | Event | ||
CHANNEL_STATE : String = "channelState" [static]
The
Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object. | Event | ||
CLEAR : String = "clear" [static]
The
Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | ||
CLOSE : String = "close" [static]
The
Event.CLOSE constant defines the value of the type property of a close event object. | Event | ||
CLOSING : String = "closing" [static]
The
Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | ||
COMPLETE : String = "complete" [static]
The
Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | ||
CONNECT : String = "connect" [static]
The
Event.CONNECT constant defines the value of the type property of a connect event object. | Event | ||
CONTEXT3D_CREATE : String = "context3DCreate" [static]
The
Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object. | Event | ||
COPY : String = "copy" [static]
Defines the value of the
type property of a copy event object. | Event | ||
CUT : String = "cut" [static]
Defines the value of the
type property of a cut event object. | Event | ||
DEACTIVATE : String = "deactivate" [static]
The
Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | ||
DISPLAYING : String = "displaying" [static]
The
Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | ||
ENTER_FRAME : String = "enterFrame" [static]
The
Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | ||
EXIT_FRAME : String = "exitFrame" [static]
The
Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | ||
EXITING : String = "exiting" [static]
The
Event.EXITING constant defines the value of the type property of an exiting event object. | Event | ||
FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The
Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | ||
FRAME_LABEL : String = "frameLabel" [static]
The
Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object. | Event | ||
FULLSCREEN : String = "fullScreen" [static]
The
Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | ||
HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The
Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | ||
HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The
Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | ||
HTML_RENDER : String = "htmlRender" [static]
The
Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | ||
HTTP_RESPONSE_STATUS : String = "httpResponseStatus" [static]
Unlike the
httpStatus event, the httpResponseStatus event is
delivered before any response data. | HTTPStatusEvent | ||
HTTP_STATUS : String = "httpStatus" [static]
The
HTTPStatusEvent.HTTP_STATUS constant defines the value of the
type property of a httpStatus event object. | HTTPStatusEvent | ||
ID3 : String = "id3" [static]
The
Event.ID3 constant defines the value of the type property of an id3 event object. | Event | ||
INIT : String = "init" [static]
The
Event.INIT constant defines the value of the type property of an init event object. | Event | ||
LOCATION_CHANGE : String = "locationChange" [static]
The
Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | ||
MOUSE_LEAVE : String = "mouseLeave" [static]
The
Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | ||
NETWORK_CHANGE : String = "networkChange" [static]
The
Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | ||
OPEN : String = "open" [static]
The
Event.OPEN constant defines the value of the type property of an open event object. | Event | ||
PASTE : String = "paste" [static]
The
Event.PASTE constant defines the value of the type property of a paste event object. | Event | ||
PREPARING : String = "preparing" [static]
The
Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | ||
REMOVED : String = "removed" [static]
The
Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | ||
REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The
Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | ||
RENDER : String = "render" [static]
The
Event.RENDER constant defines the value of the type property of a render event object. | Event | ||
RESIZE : String = "resize" [static]
The
Event.RESIZE constant defines the value of the type property of a resize event object. | Event | ||
SCROLL : String = "scroll" [static]
The
Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | ||
SELECT : String = "select" [static]
The
Event.SELECT constant defines the value of the type property of a select event object. | Event | ||
SELECT_ALL : String = "selectAll" [static]
The
Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | ||
SOUND_COMPLETE : String = "soundComplete" [static]
The
Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | ||
STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The
Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | ||
STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The
Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | ||
STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The
Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | ||
SUSPEND : String = "suspend" [static]
The
Event.SUSPEND constant defines the value of the type property of an suspend event object. | Event | ||
TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The
Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | ||
TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The
Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | ||
TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The
Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | ||
TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The
Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object. | Event | ||
TEXTURE_READY : String = "textureReady" [static]
The
Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. | Event | ||
UNLOAD : String = "unload" [static]
The
Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | ||
USER_IDLE : String = "userIdle" [static]
The
Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | ||
USER_PRESENT : String = "userPresent" [static]
The
Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | ||
VIDEO_FRAME : String = "videoFrame" [static]
The
Event.VIDEO_FRAME constant defines the value of the
type property of a videoFrame event object. | Event | ||
WORKER_STATE : String = "workerState" [static]
The
Event.WORKER_STATE constant defines the value of the type property of a workerState event object. | Event |
redirected | property |
redirected:Boolean
[read-write]
Language version: | ActionScript 3.0 |
Runtime version: | AIR 3.8 |
Indicates whether the request was redirected.
Implementation public function get redirected():Boolean
public function set redirected(value:Boolean):void
See also
responseHeaders | property |
responseHeaders:Array
[read-write]
Language version: | ActionScript 3.0 |
Runtime version: | AIR 1.0 |
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):void
See also
responseURL | property |
responseURL:String
[read-write]
Language version: | ActionScript 3.0 |
Runtime version: | AIR 1.0 |
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):void
status | property |
status:int
[read-only]
Language version: | ActionScript 3.0 |
Runtime version: |
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():int
HTTPStatusEvent | () | constructor |
public function HTTPStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:int = 0, redirected:Boolean = false)
Language version: | ActionScript 3.0 |
Runtime version: |
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: HTTPStatusEvent.HTTP_STATUS .
|
|
bubbles:Boolean (default = false ) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property.
|
|
cancelable:Boolean (default = false ) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
|
|
status:int (default = 0 ) — Numeric status. Event listeners can access this information through the status property.
|
|
redirected:Boolean (default = false ) — Whether the request was redirected. Event listeners can access this information through the redirected property.
|
See also
clone | () | method |
public override function clone():Event
Language version: | ActionScript 3.0 |
Runtime version: |
Creates a copy of the HTTPStatusEvent object and sets the value of each property to match that of the original.
ReturnsEvent —
A new HTTPStatusEvent object with property values that match those of the original.
|
toString | () | method |
public override function toString():String
Language version: | ActionScript 3.0 |
Runtime version: |
Returns a string that contains all the properties of the HTTPStatusEvent object. The string is in the following format:
[HTTPStatusEvent type=value bubbles=value cancelable=value status=value]
String —
A string that contains all the properties of the HTTPStatusEvent object.
|
HTTP_RESPONSE_STATUS | constant |
public static const HTTP_RESPONSE_STATUS:String = "httpResponseStatus"
Language version: | ActionScript 3.0 |
Runtime version: | AIR 1.0 |
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 HTTPStatusEvent.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. |
redirected | Whether the reponse is the result of a redierct. |
target | The network object receiving an HTTP status code. |
See also
HTTP_STATUS | constant |
public static const HTTP_STATUS:String = "httpStatus"
Language version: | ActionScript 3.0 |
Runtime version: |
The HTTPStatusEvent.HTTP_STATUS
constant defines the value of the
type
property of a httpStatus
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. |
status | The HTTP status code returned by the server. |
target | The network object receiving an HTTP status code. |
See also
httpStatusHandler
event with a status of 404, indicating that
the file was not found. The httpStatusHandler
event is handled by httpStatusHandler()
,
which simply prints two lines of information about the event.
Notes:
securityError
event in this example.httpStatusHandler
event with status code 0 instead of 404.httpStatusHandler
event.package { import flash.display.Sprite; import flash.net.URLLoader; import flash.net.URLRequest; import flash.events.HTTPStatusEvent; public class HTTPStatusEventExample extends Sprite { public function HTTPStatusEventExample() { var loader:URLLoader = new URLLoader(); loader.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler); var request:URLRequest = new URLRequest("http://www.[yourDomain].com/MissingFile.html"); loader.load(request); } private function httpStatusHandler(event:HTTPStatusEvent):void { trace("httpStatusHandler: " + event); trace("status: " + event.status); } } }