Package | com.adobe.csxs.types |
Class | public class HostEnvironment |
Property | Defined 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 |
Method | Defined 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 |
appId | property |
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
appLocale | property |
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
appName | property |
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
appSkinInfo | property |
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
appUILocale | property |
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
appVersion | property |
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
isAppOffline | property |
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
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.
ParametersappName: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.
|
toString | () | method |
public function toString():String
Creates a string that contains all the properties of this object.
ReturnsString — The properties string.
|