AsyncErrorEvent

Package	flash.events
Class	public class AsyncErrorEvent
Inheritance	AsyncErrorEvent ErrorEvent TextEvent Event Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Lite 4

An object dispatches an AsyncErrorEvent when an exception is thrown from native asynchronous code, which could be from, for example, LocalConnection, NetConnection, SharedObject, or NetStream. There is only one type of asynchronous error event: AsyncErrorEvent.ASYNC_ERROR.

Related API Elements

ASYNC_ERROR

Public Properties

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
		error : Error The exception that was thrown.	AsyncErrorEvent
		errorID : int [read-only] Contains the reference number associated with the specific error.	ErrorEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		text : String For a textInput event, the character or sequence of characters entered by the user.	TextEvent
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		AsyncErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", error:Error = null) Creates an AsyncErrorEvent object that contains information about asyncError events.	AsyncErrorEvent
		clone():Event [override] Creates a copy of the AsyncErrorEvent object and sets the value of each property to match that of the original.	AsyncErrorEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string that contains all the properties of the AsyncErrorEvent object.	AsyncErrorEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ASYNC_ERROR : String = "asyncError" [static] The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the type property of an asyncError event object.	AsyncErrorEvent

Property Detail

error

property

public var error:Error

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Lite 4

The exception that was thrown.

Constructor Detail

()

Constructor

public function AsyncErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", error:Error = null)

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Lite 4

Creates an AsyncErrorEvent object that contains information about asyncError events. AsyncErrorEvent objects are passed as parameters to event listeners.

Parameters

	`type:String` — The type of the event. Event listeners can access this information through the inherited `type` property. There is only one type of error event: `ErrorEvent.ERROR`.

	`bubbles:Boolean` (default = `false`) — Determines whether the Event object bubbles. 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.

	`text:String` (default = "") — Text to be displayed as an error message. Event listeners can access this information through the `text` property.

	`error:Error` (default = `null`) — The exception that occurred. If error is non-null, the event's `errorId` property is set from the error's `errorId` property.

Method Detail

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 AsyncErrorEvent object and sets the value of each property to match that of the original.

Returns

Event — A new AsyncErrorEvent 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 AsyncErrorEvent object. The string is in the following format:

[AsyncErrorEvent type=value bubbles=value cancelable=value ... error=value errorID=value] The errorId is only available in Adobe AIR

Returns

String — A string that contains all the properties of the AsyncErrorEvent object.

Constant Detail

ASYNC_ERROR

Constant

public static const ASYNC_ERROR:String = "asyncError"

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Lite 4

The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the type property of an asyncError 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.
`target`	The object dispatching the event.
`error`	The error that triggered the event.

AsyncErrorEvent - AS3

Classes x

error