air.update.events

# StatusFileUpdateEvent - AS3

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

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.

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.

Related API Elements

air.update.ApplicationUpdater
air.update.ApplicationUpdaterUI

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | available : Boolean = false Indicates if if there is a different version available than one of the current application (true); false otherwise (same version). | StatusFileUpdateEvent
|  | 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
|  | path : String = "null" The nativePath property of the update File object specified by the airFile parameter in a call to the installFromAIRFile() method. | StatusFileUpdateEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event
|  | version : String The version string of the update. | StatusFileUpdateEvent
|  | versionLabel : String The version label string of the update. | StatusFileUpdateEvent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

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

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | FILE_UPDATE_STATUS : String = "fileUpdateStatus" [static] The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the type property of the event object for a updateStatus event. | StatusFileUpdateEvent

Property Detail

### available

property

`public var available:Boolean = false`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

Indicates if if there is a different version available than one of the current application (`true`); `false` otherwise (same version).

### path

property

`public var path:String = "null"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

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

### version

property

`public var version:String`

Language Version: | ActionScript 3.0

Runtime Versions: | 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 Versions: | AIR 2.5

The version label string of the update.

Constructor Detail

### StatusFileUpdateEvent

()
Constructor

`public function StatusFileUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", path:String = "")`

Language Version: | ActionScript 3.0

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.
| `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.
| `path:String` (default = "``")``

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | 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

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

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

Returns

| `String`

Constant Detail

### FILE_UPDATE_STATUS

Constant

`public static const FILE_UPDATE_STATUS:String = "fileUpdateStatus"`

Language Version: | ActionScript 3.0

Runtime Versions: | 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` | 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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00