The location of the configuration file that sets the values for updateURL and delay. If this property points to a non-existent file, calling the initialize() method results in an Error being thrown.

The internal state of the updater. The property can be set to the following values:

• "Unitialized" 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_Install" The updater has initialized and there are pending updates.

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.

The interval used for the periodical checker of the new updates.

The default value is 0, which indicates that the timer is not active, so no periodical 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.

Set to true if this is the first run after a successful update. This property is set 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.

By default, the update framework does a version comparison in order 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 set a new function that does the comparison.

The default compare functions will accept versions like x.y.z, where x, y, and z can contain letters and digits.

There are some special conditions that the updater recognizes. If the test function finds alpha, beta or rc, the order is alpha < beta < rc.

Example:

appUpdate.isNewerVersionFunction = customFn; 
  function customFn (currentVersion:String, updateVersion:String):Boolean {// A simple examplereturn updateVersion > currentVersion;}

The application storage directory location. This property is set during a call to the initialize() method. Returns the previous local storage of the application before an upgrade with a certificate migration; otherwise it is set to null.

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.

The content of the update descriptor file downloaded from the update URL. It will return a non-null value only if it is called after a StatusUpdateEvent.UPDATE_STATUS was dispatched.

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 this either via this property or via the configuration file. When the value is set using both methods, the updater uses the value set using the property.

Set to true if there was a postponed update, even if it failed to install; false otherwise. This property is set during a call to the initialize() method. Use the wasPendingUpdate and isFirstRun properties to check if an update failed to install (wasPendingUpdate && !isFirstRun).

The constructor function.

Cancels the update process. Cancels any pending downloads, deleting any incomplete downloaded files and restarts the periodical check timer.

The update process can be canceled at any time except when the state machine is in "Unitialized" or "Initializing" state. It does nothing when it is called in one of the "Unitialized" or "Initializing" states.

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.

Starts the update process on demand. Calling this method does not stop the periodical timer; however it 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:

Asynchronously downloads the update file. It advances the state machine to "Downloading". It 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". (For information on states, see The update process.)

Initializes the updater. Calling this method does the following:

• 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.

• 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 delay expired, it starts the update process; otherwise it starts the periodical timer.

• Initialized (defined by UpdateEvent.INITIALIZED The initialization is complete.

• Error (defined by ErrorEvent.ERROR) There is an error during initialization.

This method takes no parameters and returns no value (void).

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.

Parameters

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.

Dispatched just before installing the update (cancellable)

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 will lose all current work as the runtime gets total control of the installation.

Calling this event?s preventDefault() method postpones the installation until the next restart. Canceling this and no additional update process can be started (via a call to the method or because of the periodical check).

The default behavior for ApplicationUpdater library is to download the update descriptor file. You can call the preventDefault() method to cancel this behavior.

Dispatched just before the update process begins

Dispatched just before trying to download the update descriptor file. The updater can dispatch this event as a result of directly calling the checkNow() method or because the periodical check timer expired.

Dispatched when the download of the update file is complete.

Usually this event will be used to show the install update dialog box to ask the user if he wants to install the update.

The default behavior for the the ApplicationUpdater library is to automatically call the installUpdate() method. The default behavior can be prevented only when using the ApplicationUpdater class.

Dispatched if there is an error during 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 periodical timer is automatically restarted (if the delay is greater than 0).

This event has an errorID property. This is an integer defining additional error information (see the following table). An additional subErrorID property may contain more error information.

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.

Dispatched when an error occurred either during initialization or during the update process (if something unexpected happens).

This event has the following properties:

Dispatched when an error occurs validating the file passed as the airFile parameter in a call to the installFromAIRFile() method.

Dispatched after the updater successfully validates the file in the call to the installFromAIRFile() method.

The default behavior is to install the update if the available of the available property of the StatusFileUpdateEvent object is set to true. The default behavior can be prevented only when using the ApplicationUpdater class.

This event has the following properties:

• available (Boolean) true if there is a different version available than one of the current application, false otherwise (same version)

• version (String) The new available version.

• path (String) The nativePath property of the update File object specified by the airFile parameter in a call to the installFromAIRFile() method.

Dispatched after the initialization is complete

This event has the following read-only properties:

• isFirstRun (Boolean) true if this is the first run after a successful update; false otherwise.

• previousVersion (String) The previous version of the application before the upgrade (set only if isfirstRun is true).

• currentVersion (String) The version from the application descriptor file of the currently installed version.

Dispatched after the initialization is complete.

This event has the following properties:

Dispatched when an error occured while trying to download or parse the update descriptor file.

When the updater dispatches this event, the periodical 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.

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.

This event has the following properties:

• available (Boolean) 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 (String) The string representing the new available version.

• details (Array) 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.