(Beta)
| Package | air.update.events |
| Class | public class UpdateEvent |
| Inheritance | UpdateEvent  Event Object |
| Subclasses | StatusFileUpdateEvent, StatusUpdateEvent |
| Runtime Versions: | AIR 1.5 |
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public PropertiesPublic Methods
| Method | Defined By | ||
|---|---|---|---|
The constructor function. | UpdateEvent | ||
[override]
Creates a copy of the object and sets the value of each property to match that of the original. | UpdateEvent | ||
 |
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the object. | UpdateEvent | ||
|
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.
Parameterstype: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)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
|
Method Detail
clone | () | method |
toString | () | method |
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. |
Wed Nov 21 2018, 06:34 AM -08:00