UpdateEvent

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

Runtime Versions:

AIR 1.5

A UpdateEvent is dispatched by a ApplicationUpdater object during the update process.

Related API Elements

air.update.ApplicationUpdater
air.update.ApplicationUpdaterUI

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
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		UpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) The constructor function.	UpdateEvent
		clone():Event [override] Creates a copy of the object and sets the value of each property to match that of the original.	UpdateEvent
		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.	UpdateEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		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
		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
		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
		INITIALIZED : String = "initialized" [static] The UpdateEvent.INITIALIZED constant defines the value of the type property of the event object for a initialized event.	UpdateEvent

Constructor Detail

UpdateEvent

()

Constructor

public function UpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

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.

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

BEFORE_INSTALL

Constant

public static const BEFORE_INSTALL:String = "beforeInstall"

Runtime Versions:

AIR 1.5

The UpdateEvent.BEFORE_INSTALL constant defines the value of the type property of the event object for a beforeInstall event.

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 updater object.

CHECK_FOR_UPDATE

Constant

public static const CHECK_FOR_UPDATE:String = "checkForUpdate"

Runtime Versions:

AIR 1.5

The UpdateEvent.CHECK_FOR_UPDATE constant defines the value of the type property of the event object for a checkForUpdate event.

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 updater object.

DOWNLOAD_COMPLETE

Constant

public static const DOWNLOAD_COMPLETE:String = "downloadComplete"

Runtime Versions:

AIR 1.5

The UpdateEvent.DOWNLOAD_COMPLETE constant defines the value of the type property of the event object for a downloadComplete event.

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 updater object.

DOWNLOAD_START

Constant

public static const DOWNLOAD_START:String = "downloadStart"

Runtime Versions:

AIR 1.5

The UpdateEvent.DOWNLOAD_START constant defines the value of the type property of the event object for a downloadStart event.

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 updater object.

INITIALIZED

Constant

public static const INITIALIZED:String = "initialized"

Runtime Versions:

AIR 1.5

The UpdateEvent.INITIALIZED constant defines the value of the type property of the event object for a initialized event.

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 updater object.

Legal Notices | Online Privacy Policy

UpdateEvent - AS3

Classes x

UpdateEvent

clone

toString

BEFORE_INSTALL

CHECK_FOR_UPDATE

DOWNLOAD_COMPLETE

DOWNLOAD_START

INITIALIZED