flash.events.IOErrorEvent - Adobe® AIR® API Reference for HTML Developers

window.runtime property	window.runtime.flash.events.IOErrorEvent

Inheritance	IOErrorEvent ErrorEvent TextEvent Event Object

Runtime Versions:

AIR 1.0,

An IOErrorEvent object is dispatched when an error causes input or output operations to fail.

You can check for error events that do not have any listeners by using the debugger version of Flash Player or the AIR Debug Launcher (ADL). The string defined by the text parameter of the IOErrorEvent constructor is displayed.

View the examples

See also

IO_ERROR

Properties

Hide Inherited Public Properties

Show Inherited 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
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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 Methods

	Method		Defined By
		IOErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0) Creates an Event object that contains specific information about ioError events.	IOErrorEvent
		clone():Event [override] Creates a copy of the IOErrorEvent object and sets the value of each property to match that of the original.	IOErrorEvent
		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 IOErrorEvent object.	IOErrorEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Constants

	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
		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
		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
		ERROR : String = "error" [static] Defines the value of the type property of an error event object.	ErrorEvent
		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
		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
		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
		IO_ERROR : String = "ioError" [static] Defines the value of the type property of an ioError event object.	IOErrorEvent
		LINK : String = "link" [static] Defines the value of the type property of a link event object.	TextEvent
		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_ERROR_IO_ERROR : String = "standardErrorIoError" [static] The standardErrorIoError event is dispatched when an error occurs while reading data from the standardError stream of a NativeProcess object.	IOErrorEvent
		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_INPUT_IO_ERROR : String = "standardInputIoError" [static] The standardInputIoError event is dispatched when an error occurs while writing data to the standardInput of a NativeProcess object.	IOErrorEvent
		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
		STANDARD_OUTPUT_IO_ERROR : String = "standardOutputIoError" [static] The standardOutputIoError event is dispatched when an error occurs while reading data from the standardOutput stream of a NativeProcess object.	IOErrorEvent
		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_INPUT : String = "textInput" [static] Defines the value of the type property of a textInput event object.	TextEvent
		TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static] The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode 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

Constructor Detail

IOErrorEvent

()

Constructor

public function IOErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0)

Runtime Versions:

AIR 1.0,

Creates an Event object that contains specific information about ioError events. Event 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 input/output error event: `IOErrorEvent.IO_ERROR`.

	`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.

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

	`id:int` (default = `0`) — A reference number to associate with the specific error (supported in Adobe AIR only).

clone

()

method

public function clone():Event

Runtime Versions:

AIR 1.0,

Creates a copy of the IOErrorEvent object and sets the value of each property to match that of the original.

Returns

Event — A new IOErrorEvent object with property values that match those of the original.

toString

()

method

public function toString():String

Runtime Versions:

AIR 1.0,

Returns a string that contains all the properties of the IOErrorEvent object. The string is in the following format:

[IOErrorEvent type=value bubbles=value cancelable=value text=value errorID=value] The errorId is only available in Adobe AIR

Returns

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

Constant Detail

IO_ERROR

Constant

public static const IO_ERROR:String = "ioError"

Runtime Versions:

AIR 1.0,

Defines the value of the type property of an ioError 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.
`errorID`	A reference number associated with the specific error (AIR only).
`target`	The network object experiencing the input/output error.
`text`	Text to be displayed as an error message.

STANDARD_ERROR_IO_ERROR

Constant

public static const STANDARD_ERROR_IO_ERROR:String = "standardErrorIoError"

Runtime Versions:

The standardErrorIoError event is dispatched when an error occurs while reading data from the standardError stream of a NativeProcess object.

This event has the following properties:

Property	Value
`bubbles`	No.
`cancelable`	No. There is no default behavior to cancel.
`errorID`	The reference number associated with the specific error.
`target`	The object on which the error occurred.
`text`	Text to be displayed as an error message.

STANDARD_INPUT_IO_ERROR

Constant

public static const STANDARD_INPUT_IO_ERROR:String = "standardInputIoError"

Runtime Versions:

The standardInputIoError event is dispatched when an error occurs while writing data to the standardInput of a NativeProcess object.

This event has the following properties:

Property	Value
`bubbles`	No.
`cancelable`	No. There is no default behavior to cancel.
`errorID`	The reference number associated with the specific error.
`target`	The object on which the error occurred.
`text`	Text to be displayed as an error message.

STANDARD_OUTPUT_IO_ERROR

Constant

public static const STANDARD_OUTPUT_IO_ERROR:String = "standardOutputIoError"

Runtime Versions:

The standardOutputIoError event is dispatched when an error occurs while reading data from the standardOutput stream of a NativeProcess object.

This event has the following properties:

Property	Value
`bubbles`	No.
`cancelable`	No. There is no default behavior to cancel.
`errorID`	The reference number associated with the specific error.
`target`	The object on which the error occurred.
`text`	Text to be displayed as an error message.

Examples

The following example shows how an error event object is dispatched when an attempt is made to load a nonexistent file. The example carries out the following tasks:

The init() function creates a loader URLLoader object.
The loader object registers a ioError event listener.
The constructor creates a new instance of a URLRequest object, request, passing a missing URL to the constructor.
The request variable is then passed to loader.load(), which attempts to load the missing URL, causing the loader object to dispatch an ioError event.

Note: To test this example, do the following:

Add the AIRAliases.js file to the project directory.
Create an application descriptor file for the project, and test the project using ADL.

<html>
    <head>
      <script src="AIRAliases.js" />
      <script>
        function init() {
            var loader = new air.URLLoader();
            loader.addEventListener(air.IOErrorEvent.IO_ERROR, ioErrorHandler);
            var request = new air.URLRequest("http://www.example.com/nonExistantFile.qqq");
            loader.load(request);
        }

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

[an error occurred while processing this directive][an error occurred while processing this directive]

Legal Notices | Online Privacy Policy