ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
air.update.events 

StatusUpdateEvent  - AS3

Packageair.update.events
Classpublic class StatusUpdateEvent
InheritanceStatusUpdateEvent Inheritance UpdateEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.5

An updater object dispatches a StatusUpdateEvent object after the updater successfully downloads and interprets the update descriptor file.

The default behavior is to start downloading the update if the available property of the StatusUpdateEvent 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
 PropertyDefined By
      available : Boolean = false
Indicates if an update is available.
StatusUpdateEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
      details : Array
An array defining the details string for each of the supported languages.
StatusUpdateEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
      version : String
The version string of the update.
StatusUpdateEvent
      versionLabel : String
The version label string of the update.
StatusUpdateEvent
Public Methods
 MethodDefined By
  
    StatusUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", details:Array = null, versionLabel:String = "")
The constructor function.
StatusUpdateEvent
  
    clone():Event
[override] Creates a copy of the object and sets the value of each property to match that of the original.
StatusUpdateEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
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.
StatusUpdateEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
      UPDATE_STATUS : String = "updateStatus"
[static] The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the type property of the event object for a updateStatus event.
StatusUpdateEvent
Property Detail
    

available

property
public var available:Boolean = false

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.5

Indicates if an update is available. This property is true if the update descriptor file specifies a version that is different than that of the current application; it is false otherwise (the version is the same).

    

details

property 
public var details:Array

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.5

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.

    

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
    

StatusUpdateEvent

()Constructor
public function StatusUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", details:Array = null, versionLabel: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.
 
details:Array (default = null) — the version string of the update.
 
versionLabel:String (default = "") — an array containing the description of update. The elements of the array alternate between local codes and a localized version of the description.
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
    

UPDATE_STATUS

Constant
public static const UPDATE_STATUS:String = "updateStatus"

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:

PropertyValue
availableSet 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).
versionThe string representing the new available version.
detailsAn 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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy