air.update.events

# StatusUpdateErrorEvent - AS3

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

Runtime Versions: | AIR 1.5

A StatusUpdateErrorEvent is dispatched when a call to the `checkForUpdate()` method of an ApplicationUpdater object encounters an error while downloading or parsing the update descriptor 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. | StatusUpdateErrorEvent
|  | 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
--- | --- | ---
|  | StatusUpdateErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0, subErrorID:int = 0) The constructor function. | StatusUpdateErrorEvent
|  | clone():Event [override] Creates a copy of the object and sets the value of each property to match that of the original. | StatusUpdateErrorEvent
|  | 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. | StatusUpdateErrorEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | UPDATE_ERROR : String = "updateError" [static] The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the type property of the event object for a statusUpdateError event. | StatusUpdateErrorEvent

Property Detail

### subErrorID

property

`public var subErrorID:int = 0`

Runtime Versions: | AIR 1.5

Provides information in addition to the `errorId` property.

Constructor Detail

### StatusUpdateErrorEvent

()
Constructor

`public function StatusUpdateErrorEvent(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

### UPDATE_ERROR

Constant

`public static const UPDATE_ERROR:String = "updateError"`

Runtime Versions: | AIR 1.5

The `StatusUpdateErrorEvent.UPDATE_ERROR` constant defines the value of the `type` property of the event object for a `statusUpdateError` event.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00