air.update.events.StatusUpdateEvent (ActionScript 3.0)

	Property	Defined by
		available : Boolean = false Indicates if an update is available.	StatusUpdateEvent
		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
		details : Array An array defining the `details` string for each of the supported languages.	StatusUpdateEvent
		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
		target : Object The event target.	Event
		type : String The type of event.	Event
		version : String = "" The version string of the update.	StatusUpdateEvent
		versionLabel : String = "" The version label string of the update.	StatusUpdateEvent

	Method	Defined by
		StatusUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", details:Array = null, versionLabel:String = "") The constructor function.	StatusUpdateEvent
		clone():Event Creates a copy of the object and sets the value of each property to match that of the original.	StatusUpdateEvent
		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 Returns a string that contains all the properties of the object.	StatusUpdateEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public 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
		BEFORE_INSTALL : String = "beforeInstall" [static] The `UpdateEvent.BEFORE_INSTALL` constant defines the value of the `type` property of the event object for a `beforeInstall` event.	UpdateEvent
		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
		CHECK_FOR_UPDATE : String = "checkForUpdate" [static] The `UpdateEvent.CHECK_FOR_UPDATE` constant defines the value of the `type` property of the event object for a `checkForUpdate` event.	UpdateEvent
		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
		DOWNLOAD_COMPLETE : String = "downloadComplete" [static] The `UpdateEvent.DOWNLOAD_COMPLETE` constant defines the value of the `type` property of the event object for a `downloadComplete` event.	UpdateEvent
		DOWNLOAD_START : String = "downloadStart" [static] The `UpdateEvent.DOWNLOAD_START` constant defines the value of the `type` property of the event object for a `downloadStart` event.	UpdateEvent
		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
		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
		INITIALIZED : String = "initialized" [static] The `UpdateEvent.INITIALIZED` constant defines the value of the `type` property of the event object for a `initialized` event.	UpdateEvent
		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
		UPDATE_STATUS : String = "updateStatus" [static] The `StatusUpdateEvent.UPDATE_STATUS` constant defines the value of the `type` property of the event object for a `updateStatus` event.	StatusUpdateEvent
		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

Property detail

available

property

public var available:Boolean = false

Language version:

ActionScript 3.0

Runtime version:

AIR 1.5

Indicates if an update is available. This property is true if the update descriptor file specifies a version that is different than that of the current application; it is false otherwise (the version is the same).

details

property

public var details:Array

Language version:

ActionScript 3.0

Runtime version:

AIR 1.5

An array defining the details string for each of the supported languages. If there is no localized description, this is defined as an array in which the first element is an empty string ("") and the second element is the details string. When there are localized descriptions, each element in the array is an array itself with two elements. The first element is the locale code, and the second is the description. For example, the following array has sub-arrays for two languages (U.S. English and French): ["en-US", "Hello World"], ["fr", "Bonjour monde"]. The languages are listed in the same order as in the update descriptor.

version

property

public var version:String = ""

Language version:

ActionScript 3.0

Runtime version:

AIR 1.5

The version string of the update.

In AIR 2.5 and later, the version string is specified in the versionNumber element of the application descriptor file. In earlier versions of AIR, the version string is specified in the version element.

versionLabel

property

public var versionLabel:String = ""

Language version:

ActionScript 3.0

Runtime version:

AIR 2.5

The version label string of the update.

Constructor detail

StatusUpdateEvent

()

constructor

public function StatusUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", details:Array = null, versionLabel:String = "")

Language version:

ActionScript 3.0

Runtime version:

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.

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

	`version:String` (default = "") — A reference number to associate with the specific error.

	`details:Array` (default = `null`) — the version string of the update.

	`versionLabel:String` (default = "") — an array containing the description of update. The elements of the array alternate between local codes and a localized version of the description.

Method detail

clone

()

method

public override function clone():Event

Language version:

ActionScript 3.0

Runtime version:

AIR 1.5

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

Returns

Event

toString

()

method

public override function toString():String

Language version:

ActionScript 3.0

Runtime version:

AIR 1.5

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

Returns

String

Constant detail

UPDATE_STATUS

constant

public static const UPDATE_STATUS:String = "updateStatus"

Language version:

ActionScript 3.0

Runtime version:

AIR 1.5

The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the type property of the event object for a updateStatus event.

This event has the following properties:

Property	Value
`available`	Set to `true` if the update descriptor file specifies a version that is different than that of the current application; `false` otherwise (the version is the same).
`version`	The string representing the new available version.
`details`	An array defining the `details` string for each of the supported languages. If there is no localized description, this is defined as an array in which the first element is an empty string (`""`) and the second element is the details string. When there are localized descriptions, each element in the array is an array itself with two elements. The first element is the locale code, and the second is the description. For example, the following array has sub-arrays for two languages (U.S. English and French): `["en-US", "Hello World"], ["fr", "Bonjour monde"]`. The languages are listed in the same order as in the update descriptor. The text for the details property is specified in the update descriptor file.
`versionLabel`	(AIR 2.5+) The version label from the application descriptor of the update. The version label should be displayed to users instead of version. If no version label is specified, this property is an empty string.

Submit Feedback

ActionScript 3.0 Language Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendices \| Conventions \| Frames No Frames
Class StatusUpdateEvent	Properties \| Methods \| Constants

Package	air.update.events
Class	public class StatusUpdateEvent
Inheritance	StatusUpdateEvent UpdateEvent Event Object