Packagecom.adobe.csxs.types
Classpublic class HostEnvironment

Stores information about the environment in which the extension is loaded.



Public Properties
 PropertyDefined by
  appId : String
Retrieves the unique identifier of the application in which this extension is loaded.
HostEnvironment
  appLocale : String
Retrieves the license locale; that is, the language/country for which the application was purchased.
HostEnvironment
  appName : String
Retrieves the name of the application in which this extension is loaded.
HostEnvironment
  appSkinInfo : AppSkinInfo
Retrieves skin information settings for the hosting application.
HostEnvironment
  appUILocale : String
Retrieves the UI locale setting of the hosting application.
HostEnvironment
  appVersion : String
Retrieves the version of the application in which this extension is loaded.
HostEnvironment
  isAppOffline : Boolean
Reports whether the hosting application is currently offline.
HostEnvironment
Public Methods
 MethodDefined by
  
HostEnvironment(appName:String = "", appVersion:String = "", appLocale:String = "", appId:String = "", isAppOffline:Boolean = false, appSkinInfo:AppSkinInfo = null, appUILocale:String = "")
Creates the host environment object.
HostEnvironment
  
toString():String
Creates a string that contains all the properties of this object.
HostEnvironment
Property detail
appIdproperty
appId:String  [read-write]

Retrieves the unique identifier of the application in which this extension is loaded.

Implementation
    public function get appId():String
    public function set appId(value:String):void
appLocaleproperty 
appLocale:String  [read-write]

Retrieves the license locale; that is, the language/country for which the application was purchased.

Implementation
    public function get appLocale():String
    public function set appLocale(value:String):void
appNameproperty 
appName:String  [read-write]

Retrieves the name of the application in which this extension is loaded.

Implementation
    public function get appName():String
    public function set appName(value:String):void
appSkinInfoproperty 
appSkinInfo:AppSkinInfo  [read-write]

Retrieves skin information settings for the hosting application.

Implementation
    public function get appSkinInfo():AppSkinInfo
    public function set appSkinInfo(value:AppSkinInfo):void
appUILocaleproperty 
appUILocale:String  [read-write]

Retrieves the UI locale setting of the hosting application. Use this to determine which language to use for localized display strings.

Implementation
    public function get appUILocale():String
    public function set appUILocale(value:String):void
appVersionproperty 
appVersion:String  [read-write]

Retrieves the version of the application in which this extension is loaded.

Implementation
    public function get appVersion():String
    public function set appVersion(value:String):void
isAppOfflineproperty 
isAppOffline:Boolean  [read-write]

Reports whether the hosting application is currently offline.

Implementation
    public function get isAppOffline():Boolean
    public function set isAppOffline(value:Boolean):void
Constructor detail
HostEnvironment()constructor
public function HostEnvironment(appName:String = "", appVersion:String = "", appLocale:String = "", appId:String = "", isAppOffline:Boolean = false, appSkinInfo:AppSkinInfo = null, appUILocale:String = "")

Creates the host environment object.

Parameters
appName:String (default = "") — The application's name.
 
appVersion:String (default = "") — The application's version.
 
appLocale:String (default = "") — The application's current license locale.
 
appId:String (default = "") — The application's unique identifier.
 
isAppOffline:Boolean (default = false) — True if the application is currently offline.
 
appSkinInfo:AppSkinInfo (default = null) — A skin-information object containing the application's default color and font styles.
 
appUILocale:String (default = "") — The application's current UI locale.
Method detail
toString()method
public function toString():String

Creates a string that contains all the properties of this object.

Returns
String — The properties string.