| Package | air.update |
| Class | public class ApplicationUpdater |
| Inheritance | ApplicationUpdater  EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
This class is included in the applicationupdater_ui.swc file, included in the Adobe AIR SDK. The applicationupdater_ui.swc file is in the frameworks/libs/air directory of the AIR SDK.
Adobe® Flex™ Builder™ loads this class automatically when you create a project for Adobe AIR. You should include the SWC file when compiling the application using the Adobe® Flex™ SDK.
Managing updates of applications can be complicated. The AIR update framework provides APIs to assist developers in providing good update capabilities in AIR applications. The functionality in the AIR update framework assists developers in the following:
-
Periodically checking for updates based on an interval or at the request of the user
-
Downloading AIR files (updates) from a web source
-
Alerting the user on the first run of the newly installed version
-
Confirming that the user wants to check for updates
-
Displaying information on the new update version to the user
-
Displaying download progress and error information to the user
The AIR update framework lets you store information about the update version of an AIR application in simple XML configuration files. For most applications, setting up these configuration files and including some basic code provides good update functionality to the end user.
Use the AIRUpdater class if you want to define your own user interface for use with the AIR update framework.
The update process includes a sequence of states. The currentState
property of the updater object reflects the current state of the updater:
| currentState value | Description |
|---|---|
| "UNINITIALIZED" | The updater has not been initialized. |
| "INITIALIZING" | The updater is initializing. |
| "READY" | The updater has been initialized |
| "BEFORE_CHECKING" | The updater has not yet checked for the update descriptor file. |
| "CHECKING" | The updater is checking for an update descriptor file. |
| "AVAILABLE" | The update descriptor file is available. |
| "DOWNLOADING" | The updater is downloading the AIR file. |
| "DOWNLOADED" | The updater has downloaded the AIR file. |
| "INSTALLING" | The updater is installing the AIR file. |
| "PENDING_INSTALLING" | The updater has initialized and there are pending updates. |
When testing an application using the AIR Debug Launcher (ADL) application, attempting to update the application results in an IllegalOperationError exception.
The AIR update framework is only supported in the desktop profile. It is not supported
for extended desktop applications (applications installed with a native installer),
and it is not supported on the mobile profile (iPhone applications written with
ActionScript 3.0). Check the Updater.isSupported property at runtime
to see if the update framework is supported.
For details on using the AIR update framework, see the "Updating AIR Applications" chapter of Building Adobe AIR Applications.
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| configurationFile : File
The location of the configuration file that sets the values for delay and
updateURL properties. | ApplicationUpdater | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentState : String [read-only]
The internal state of the updater. | ApplicationUpdater | ||
| currentVersion : String [read-only]
The current version of the application. | ApplicationUpdater | ||
| delay : Number
The interval, in days, between periodic checks of new updates. | ApplicationUpdater | ||
| isFirstRun : Boolean [read-only]
Whether this is the first run after a successful update (true) or not
(false). | ApplicationUpdater | ||
| isNewerVersionFunction : Function
A function that the updater should use to perform version comparisons. | ApplicationUpdater | ||
| previousApplicationStorageDirectory : File [read-only]
The previous location of the application storage directory, if it changed
after an update. | ApplicationUpdater | ||
| previousVersion : String [read-only]
The previous version of the application. | ApplicationUpdater | ||
| updateDescriptor : XML [read-only]
The content of the update descriptor file downloaded from the update URL. | ApplicationUpdater | ||
| updateURL : String
The location of the update descriptor file. | ApplicationUpdater | ||
| wasPendingUpdate : Boolean [read-only]
Whether there was a postponed update, even if it failed
to install (true); false otherwise. | ApplicationUpdater | ||
| Method | Defined By | ||
|---|---|---|---|
The constructor function. | ApplicationUpdater | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
Cancels the update process. | ApplicationUpdater | ||
Asynchronously downloads and interprets
the update descriptor file. | ApplicationUpdater | ||
Starts the update process. | ApplicationUpdater | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
Asynchronously downloads the update file. | ApplicationUpdater | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
Initializes the updater. | ApplicationUpdater | ||
Starts the update process using a local AIR file. | ApplicationUpdater | ||
Installs the update file. | ApplicationUpdater | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched just before installing the update, after the installUpdate() method was called. | ApplicationUpdater | |||
| Dispatched before the update process begins, just before the updater tries to download the update descriptor file. | ApplicationUpdater | |||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when the download of the update file is complete. | ApplicationUpdater | |||
| Dispatched if there is an error while connecting or downloading the update file. | ApplicationUpdater | |||
| Dispatched after a call to the downloadUpdate() method and the connection to the server is established. | ApplicationUpdater | |||
| Dispatched when an error occurred either during initialization or during the update process (if something unexpected happens). | ApplicationUpdater | |||
| Dispatched when an error occurs validating the file passed as the airFile parameter in a call to the installFromAIRFile() method. | ApplicationUpdater | |||
| Dispatched after the updater successfully validates the file in the call to the installFromAIRFile() method. | ApplicationUpdater | |||
| Dispatched after the initialization is complete. | ApplicationUpdater | |||
| Dispatched as the update file is downloaded. | ApplicationUpdater | |||
| Dispatched if an error occurs while trying to download or parse the update descriptor file. | ApplicationUpdater | |||
| Dispatched after the updater successfully downloads and interprets the update descriptor file. | ApplicationUpdater | |||
configurationFile | property |
configurationFile:File| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The location of the configuration file that sets the values for delay and
updateURL properties. If this property points to a non-existent file, calling
the initialize() method results in an Error being thrown.
Here is a sample configuration file:
<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0" >
<url>app:/server/update.xml</url>
<delay>1</delay>
</configuration>Instead of loading a configuration file, you can use ActionScript
code to set the delay and updateURL
properties.
Implementation
public function get configurationFile():File public function set configurationFile(value:File):voidRelated API Elements
currentState | property |
currentState:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The internal state of the updater. The property can be set to the following values:
-
"UNINITIALIZED"—The updater has not been initialized. -
"INITIALIZING"—The updater is initializing. -
"READY"—The updater has been initialized -
"BEFORE_CHECKING"—The updater has not yet checked for the update descriptor file. -
"CHECKING"—The updater is checking for an update descriptor file. -
"AVAILABLE"—The update descriptor file is available. -
"DOWNLOADING"—The updater is downloading the AIR file. -
"DOWNLOADED"—The updater has downloaded the AIR file. -
"INSTALLING"—The updater is installing the AIR file. -
"PENDING_INSTALLING"—The updater has initialized and there are pending updates.
Implementation
public function get currentState():String currentVersion | property |
currentVersion:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The current version of the application. This property is set during
a call to the initialize() method. It is set to
the version from the application descriptor file.
Implementation
public function get currentVersion():String delay | property |
delay:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The interval, in days, between periodic checks of new updates.
A value of 0 (the default value) indicates that the timer is not active, so no periodic check is done. This can be set either via this property or via the configuration file. When the value is set using both methods, the value set using the property is used.
The default value is 0.
Implementation
public function get delay():Number public function set delay(value:Number):void isFirstRun | property |
isFirstRun:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Whether this is the first run after a successful update (true) or not
(false). The updater sets this value during the call to the initialize()
method. The developer should check that isFirstRun is set to true if
there is a need to migrate data from one version to another.
Implementation
public function get isFirstRun():BooleanRelated API Elements
isNewerVersionFunction | property |
isNewerVersionFunction:Function| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
A function that the updater should use to perform version comparisons. By default, the update framework does a version comparison to detect whether the version from the remote site is newer than the version of the installed application. However, sometimes the default comparison does not match the developer's versioning scheme. Set this property to provide a new function that does the comparison.
The default comparision function accepts
versions like x.y.z, where x, y, and z can contain letters
and digits. There are some special conditions that the default comparision function
recognizes. If the test function finds "alpha", "beta",
or "rc" in the version strings,
the order is alpha < beta < rc.
Implementation
public function get isNewerVersionFunction():Function public function set isNewerVersionFunction(value:Function):voidExample ( How to use this example )
customFn, for the appUpdate updater object.
The example function is intentionally simple. Your custom function should return a Boolean value based on the rules of your
versioning scheme.
appUpdate.isNewerVersionFunction = customFn;
function customFn (currentVersion:String, updateVersion:String):Boolean
{
return updateVersion > currentVersion;
}
previousApplicationStorageDirectory | property |
previousApplicationStorageDirectory:File [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The previous location of the application storage directory, if it changed
after an update. The application storage directory location changes after
an upgrade with a certificate migration. If there is no certificate
migration, the application storage directory does not change when the
user updates the application. and this property is set to null.
This property is set during a call to the initialize() method.
A developer can sign new version of AIR application with a new certificate
if the developer uses the -migrate option when packaging the AIR
file with ADT. If a new version of an AIR application uses a new signing certificate,
the local storage directory of the application changes when the user installs
the new version. Use this property to transfer data from the old application
storage directory to the new application storage directory
(File.applicationStorageDirectory). For more information,
see "Signing an AIR file to change the application certificate" in the
"Creating an AIR application using the command line tools" chapter of the
Adobe AIR developer's guide.
Implementation
public function get previousApplicationStorageDirectory():File previousVersion | property |
previousVersion:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The previous version of the application. This property is set during
a call to the initialize() method. Returns the previous version of
the application before the upgrade (set only if isfirstRun is true);
otherwise it is set to null.
Implementation
public function get previousVersion():String updateDescriptor | property |
updateDescriptor:XML [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The content of the update descriptor file downloaded from the update URL. This property is
non-null only the updater object dispatches an updateStatus event.
Implementation
public function get updateDescriptor():XML updateURL | property |
updateURL:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The location of the update descriptor file. Any location valid for a URLRequest path is accepted. This is the only mandatory setting required by the updater. You can set the update URL either via this property or via the configuration file. When the value is set using both methods, the updater uses the value set using this property.
Implementation
public function get updateURL():String public function set updateURL(value:String):void wasPendingUpdate | property |
wasPendingUpdate:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Whether there was a postponed update, even if it failed
to install (true); false otherwise.
The updater sets this property during a call to the initialize() method.
Use the wasPendingUpdate and isFirstRun properties
to check if an update failed to install (in which case wasPendingUpdate
is set to true and isFirstRun is set to false).
Implementation
public function get wasPendingUpdate():BooleanRelated API Elements
ApplicationUpdater | () | Constructor |
public function ApplicationUpdater()| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
The constructor function.
cancelUpdate | () | method |
public function cancelUpdate():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Cancels the update process. Calling this method cancels any pending downloads, deleting any incomplete downloaded files, and restarts the periodic check timer.
The update process can be canceled at any time except when the state machine is in "UNINITIALIZED" or "INITIALIZING" state. It does nothing when it is called in one of the "UNINITIALIZED" or "INITIALIZING" states.
checkForUpdate | () | method |
public function checkForUpdate():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Asynchronously downloads and interprets
the update descriptor file. Calling this method advances the updater
state to "CHECKING". Call this method only if the checkForUpdate event
was cancelled.
This method only executes when the updater is in the "BEFORE_CHECKING" state.
Events
updateStatus: — The updater has successfully downloaded and interpreted the update descriptor file.
| |
updateError: — An error occured while trying to download or parse the update descriptor file.
|
checkNow | () | method |
public function checkNow():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Starts the update process. Calling this method does not stop the periodic timer; however, the method detects that an update process is running and will skip the current iteration.
This method only executes if the current state is "READY".
This method can result in the updater object dispatching the following event:
Events
checkForUpdate: — Dispatched just before the update process begins.
|
downloadUpdate | () | method |
public function downloadUpdate():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Asynchronously downloads the update file. Calling this method advances the state machine to "DOWNLOADING". This method needs to be called only if the StatusUpdateEvent.UPDATE_STATUS event was cancelled when the available property of the event was true.
This method only executes if the current state is "AVAILABLE".
Events
downloadStart: — Dispatched after the connection to the server is established.
| |
progress: — Dispatched after the initialization is complete.
| |
downloadError: — Dispatched if there is an error while connecting or downloading the update file.
It is also dispatched for invalid HTTP statuses (such as 404 - File not found).
|
initialize | () | method |
public function initialize():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Initializes the updater. Calling this method does the following:
-
It initializes the update framework, silently (and synchronously) installing any pending updates. You should call this method during application startup, since it may restart the application.
-
It checks if there is a postponed update and installs it.
-
If something went wrong with a prior update, it clears the update file and version information from the storage area.
-
If the periodic timer delay has expired, it starts the update process; otherwise it starts the periodic timer. However, when testing an application using the AIR Debug Launcher (ADL) application, attempting to update the application results in a IllegalOperationError exception.
Events
initialized: — The initialization is complete.
| |
error: — There is an error during initialization.
|
installFromAIRFile | () | method |
public function installFromAIRFile(file:File):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Starts the update process using a local AIR file.
Calling this
method has no effect if an update process is running (if the state
is not "DOWNLOADED").
This function is useful
for an application that has the customUpdateUI element
set to true in the application descriptor file.
When testing an application using the AIR Debug Launcher (ADL) application, calling this method results in an IllegalOperationError exception.
Parameters
file:File — The local AIR file to install.
|
Events
fileUpdateStatus: — Dispatched after the updater successfully
validates the AIR file.
| |
updateError: — Dispatched if an error occurs while trying
parse the update descriptor file.
|
installUpdate | () | method |
public function installUpdate():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Installs the update file. Calling the method
advances the state machine to "INSTALLING" and needs to be called
only if the downLoadComplete event was cancelled.
Call this method when the updater is in the "DOWNLOADED" state. Calling it in any other state will do nothing.
When testing an application using the AIR Debug Launcher (ADL) application, calling this method results in an IllegalOperationError exception.
Events
beforeInstall: — Dispatched just before installing the update. Sometimes it is useful
to prevent the installation of the update at this time, because the user could lose all current work when
the runtime exits the application to install the update.
|
beforeInstall | Event |
air.update.events.UpdateEventproperty UpdateEvent.type =
air.update.events.UpdateEvent.BEFORE_INSTALL| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched just before installing the update, after the installUpdate() method
was called. Sometimes, it is useful to prevent the installation
of the update at this time, because the user could lose all current work when
the runtime exits the application to install the update.
Calling this event's preventDefault() method
postpones the installation until the next restart. If you call
the preventDefault() method, no additional update
process can be started during this application session (via a call
to the installUpdate() method or because of the periodic check).
The default behavior for ApplicationUpdater library is to download
the update descriptor file. You can call the preventDefault() method
to cancel this behavior.
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. |
checkForUpdate | Event |
air.update.events.UpdateEventproperty UpdateEvent.type =
air.update.events.UpdateEvent.CHECK_FOR_UPDATE| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched before the update process begins, just before the
updater tries to download the update descriptor file.
The updater can dispatch this event as a result of directly
calling the checkNow() method or because the periodic
check timer expired.
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. |
downloadComplete | Event |
air.update.events.UpdateEventproperty UpdateEvent.type =
air.update.events.UpdateEvent.DOWNLOAD_COMPLETE| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched when the download of the update file is complete.
Usually this event is used to display a message asking if the user wants to proceed with the installation of the update.
The default behavior for the the ApplicationUpdater library is
to automatically call the installUpdate() method.
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. |
downloadError | Event |
air.update.events.DownloadErrorEventproperty DownloadErrorEvent.type =
air.update.events.DownloadErrorEvent.DOWNLOAD_ERROR| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched if there is an error while connecting or downloading the update file. It is also dispatched for invalid HTTP statuses (such as 404 - File not found).
When this event is dispatched the periodic timer is automatically restarted (if the delay is greater than 0).
TheDownloadErrorEvent.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. |
downloadStart | Event |
air.update.events.UpdateEventproperty UpdateEvent.type =
air.update.events.UpdateEvent.DOWNLOAD_START| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched after a call to the downloadUpdate() method
and the connection to the server is established. When using ApplicationUpdater
library, you may want the event handler for this event to display
a progress bar to report the download progress to the user.
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. |
error | Event |
flash.events.ErrorEventproperty ErrorEvent.type =
flash.events.ErrorEvent.ERROR| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched when an error occurred either during initialization or during the update process (if something unexpected happens).
Defines the value of thetype property of an error event object.
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 object experiencing a network operation failure. |
text | Text to be displayed as an error message. |
fileUpdateError | Event |
air.update.events.StatusFileUpdateErrorEventproperty StatusFileUpdateErrorEvent.type =
air.update.events.StatusFileUpdateErrorEvent.FILE_UPDATE_ERROR| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched when an error occurs validating the file passed
as the airFile parameter in a call to the installFromAIRFile() method.
StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the
type property of the event object for a statusUpdateError event.
fileUpdateStatus | Event |
air.update.events.StatusFileUpdateEventproperty StatusFileUpdateEvent.type =
air.update.events.StatusFileUpdateEvent.FILE_UPDATE_STATUS| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched after the updater successfully validates the
file in the call to the installFromAIRFile() method.
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 | Indicates if if there is a different version
available than one of the current application (true); false otherwise (same version). |
path | The nativePath property of
the update File object specified by the airFile parameter
in a call to the installFromAIRFile() method. |
version | Indicates the version of the new update. |
initialized | Event |
air.update.events.UpdateEventproperty UpdateEvent.type =
air.update.events.UpdateEvent.INITIALIZED| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched after the initialization is complete.
TheUpdateEvent.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. |
progress | Event |
flash.events.ProgressEventproperty ProgressEvent.type =
flash.events.ProgressEvent.PROGRESS| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched as the update file is downloaded.
Defines the value of thetype property of a progress event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
bytesLoaded | The number of items or bytes loaded at the time the listener processes the event. |
bytesTotal | The total number of items or bytes that ultimately will be loaded if the loading process succeeds. |
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 object reporting progress. |
updateError | Event |
air.update.events.StatusUpdateErrorEventproperty StatusUpdateErrorEvent.type =
air.update.events.StatusUpdateErrorEvent.UPDATE_ERROR| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched if an error occurs while trying to download or parse the update descriptor file.
When the updater dispatches this event, the periodic timer
is automatically restarted (if the delay setting is greater than
0). The application should consider hiding any error dialog boxes
when the updater dispatches a new checkForUpdate event.
StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the
type property of the event object for a statusUpdateError event.
updateStatus | Event |
air.update.events.StatusUpdateEventproperty StatusUpdateEvent.type =
air.update.events.StatusUpdateEvent.UPDATE_STATUS| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.5 |
Dispatched after the updater successfully downloads and interprets the update descriptor file.
The default behavior is to start downloading the update if the
available of the available property of the StatusUpdateEvent object
is set to true. The default behavior can be prevented
only when using the ApplicationUpdater class, not when using the
ApplicationUpdatorUI class..
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. |
Mon Apr 10 2017, 12:28 PM -07:00