DownloadErrorEvent

Package	air.update.events
Class	public class DownloadErrorEvent
Inheritance	DownloadErrorEvent ErrorEvent TextEvent Event Object

Runtime Versions:

AIR 1.5

A DownloadErrorEvent object is dispatched by an ApplicationUpdater or ApplicationUpdaterUI object when an error happens while downloading the update file.

Related API Elements

air.update.ApplicationUpdater
air.update.ApplicationUpdaterUI

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
		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
		subErrorID : int = 0 Provides information in addition to the errorId property.	DownloadErrorEvent
		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
		DownloadErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0, subErrorID:int = 0) The constructor function.	DownloadErrorEvent
		clone():Event [override] Creates a copy of the object and sets the value of each property to match that of the original.	DownloadErrorEvent
		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 object.	DownloadErrorEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		DOWNLOAD_ERROR : String = "downloadError" [static] The DownloadErrorEvent.DOWNLOAD_ERROR constant defines the value of the type property of the event object for a downloadError event.	DownloadErrorEvent

Property Detail

subErrorID

property

public var subErrorID:int = 0

Runtime Versions:

AIR 1.5

Provides information in addition to the errorId property.

Constructor Detail

()

Constructor

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

Runtime Versions:

AIR 1.5

The constructor function. Do not call this function. The update framework calls it to create the event object.

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.

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

	`subErrorID:int` (default = `0`) — Provides details about the error event, in addition to the `errorID`.

Method Detail

clone

()

method

override public function clone():Event

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

Returns

Event

toString

()

method

override public function toString():String

Returns a string that contains all the properties of the object.

Returns

String

Constant Detail

DOWNLOAD_ERROR

Constant

public static const DOWNLOAD_ERROR:String = "downloadError"

Runtime Versions:

AIR 1.5

The DownloadErrorEvent.DOWNLOAD_ERROR constant defines the value of the type property of the event object for a downloadError event.

The errorID property of a DownloadErrorEvent object is an integer defining error information (see the following table). An additional subErrorID property may contain more error information.

errorID Error code	Description
16800	Occurs during validating the downloaded update file. The `subErrorID` property may contain additional information.
16801	Invalid Adobe AIR file (missing application.xml).
16802	Invalid Adobe AIR file (missing MIME type).
16803	Invalid Adobe AIR file (format).
16804	Invalid Adobe AIR file (invalid flags).
16805	Invalid Adobe AIR file (unknown compression).
16806	Invalid Adobe AIR file (invalid filename).
16807	Invalid Adobe AIR file (corrupt).
16808	Configuration file does not exist.
16809	The `updateURL` property is not set.
16810	Reserved.
16811	Invalid configuration file (unknown configuration version).
16812	Invalid configuration file (URL missing).
16813	Invalid configuration file (delay format).
16814	Invalid configuration file (invalid defaultUI values).
16815	Invalid update descriptor (unknown descriptor version).
16816	Invalid update descriptor (missing update version).
16817	Invalid update descriptor (invalid description).
16818	IO error while saving data to disk. The `subErrorID` property may provide more information.
16819	Security error while downloading. The `subErrorID` property may provide more information.
16820	Invalid HTTP status code. The `subErrorID` property may contain the invalid status code.
16821	Reserved.
16822	I/O error while downloading. The `subErrorID` property may provide more information.
16823	End-of-file error while saving data to disk. The `subErrorID` property may provide more information.
16824	Invalid update descriptor. The `subErrorID` property may provide more information.
16825	The update file contains an application with a different application ID.
16826	The update file does not contain a newer version of the application.
16827	The version contained in the update file does not match the version from the update descriptor.
16828	Cannot update application, usually because the application is running in the AIR Debug Launcher (ADL).
16829	Missing update file at install time.

DownloadErrorEvent - AS3

Classes x

subErrorID