Packagefin.desktop
Classpublic class RuntimeConfiguration
InheritanceRuntimeConfiguration Inheritance Object

Configuration for launching OpenFin Runtime


Public Properties
 PropertyDefined By
  additionalRuntimeArguments : String
[write-only] Set additional arguments for Runtime
RuntimeConfiguration
  additionalRvmArguments : String
Get additional arguments for RVM and Installer
RuntimeConfiguration
  appAssets : Array
RuntimeConfiguration
  appManifestUrl : String
Get URL of app manifest
RuntimeConfiguration
  assetUrl : String
Get Runtime asset URL
RuntimeConfiguration
  connectionTimeout : Number
Get timeout in milli-seconds
RuntimeConfiguration
  connectionUuid : String
[read-only]
RuntimeConfiguration
  launchWithRVM : Boolean
return value of launchWithRVM
RuntimeConfiguration
  licenseKey : String
Get license key for Runtime
RuntimeConfiguration
  maxMessageSize : uint
Get max frame message size
RuntimeConfiguration
  maxReceivedFrameSize : uint
Get max message size
RuntimeConfiguration
  onConnectionClose : Function
Get callback function for connection close event
RuntimeConfiguration
  onConnectionError : Function
Get callback function for connection error event
RuntimeConfiguration
  onConnectionReady : Function
Get callback function for connection ready event
RuntimeConfiguration
  rdmURL : String
Get URL of RDM service
RuntimeConfiguration
  runtimeAssetURL : String
Get URL of Runtime assets
RuntimeConfiguration
  runtimeFallbackVersion : String
Get fallback version number of Runtime to launch
RuntimeConfiguration
  runtimeInstallPath : String
Get path of Runtime install location
RuntimeConfiguration
  runtimeVersion : String
Get version number of Runtime
RuntimeConfiguration
  securityRealm : String
Get security realm
RuntimeConfiguration
  showInstallerUI : Boolean
Get if OpenFinInstaller should be invoked with UI
RuntimeConfiguration
  startupApp : Object
[write-only] Set configuration of startup application.
RuntimeConfiguration
Public Methods
 MethodDefined By
  
RuntimeConfiguration(uuid:String)
Constructor
RuntimeConfiguration
  
addConfigurationItem(name:String, value:*):void
RuntimeConfiguration
  
enableConsoleLogging():void
[static]
RuntimeConfiguration
  
enableFileLogging(logFilename:String = null):void
[static] Enable logging to a log file
RuntimeConfiguration
  
enableNativeExtensionLogging(logFilePath:String, verbose:Boolean = false):void
[static] Enable logging from native extension
RuntimeConfiguration
  
enableTraceLogging():void
[static] Enable logging with trace(...)
RuntimeConfiguration
  
generateRuntimeConfig():String
RuntimeConfiguration
Property Detail
additionalRuntimeArgumentsproperty
additionalRuntimeArguments:String  [write-only]

Set additional arguments for Runtime


Implementation
    public function set additionalRuntimeArguments(value:String):void
additionalRvmArgumentsproperty 
additionalRvmArguments:String

Get additional arguments for RVM and Installer


Implementation
    public function get additionalRvmArguments():String
    public function set additionalRvmArguments(value:String):void
appAssetsproperty 
appAssets:Array


Implementation
    public function get appAssets():Array
    public function set appAssets(value:Array):void
appManifestUrlproperty 
appManifestUrl:String

Get URL of app manifest


Implementation
    public function get appManifestUrl():String
    public function set appManifestUrl(value:String):void
assetUrlproperty 
assetUrl:String

Get Runtime asset URL


Implementation
    public function get assetUrl():String
    public function set assetUrl(value:String):void
connectionTimeoutproperty 
connectionTimeout:Number

Get timeout in milli-seconds


Implementation
    public function get connectionTimeout():Number
    public function set connectionTimeout(value:Number):void
connectionUuidproperty 
connectionUuid:String  [read-only]


Implementation
    public function get connectionUuid():String
launchWithRVMproperty 
launchWithRVM:Boolean

return value of launchWithRVM


Implementation
    public function get launchWithRVM():Boolean
    public function set launchWithRVM(value:Boolean):void
licenseKeyproperty 
licenseKey:String

Get license key for Runtime


Implementation
    public function get licenseKey():String
    public function set licenseKey(value:String):void
maxMessageSizeproperty 
maxMessageSize:uint

Get max frame message size


Implementation
    public function get maxMessageSize():uint
    public function set maxMessageSize(value:uint):void
maxReceivedFrameSizeproperty 
maxReceivedFrameSize:uint

Get max message size


Implementation
    public function get maxReceivedFrameSize():uint
    public function set maxReceivedFrameSize(value:uint):void
onConnectionCloseproperty 
onConnectionClose:Function

Get callback function for connection close event


Implementation
    public function get onConnectionClose():Function
    public function set onConnectionClose(value:Function):void
onConnectionErrorproperty 
onConnectionError:Function

Get callback function for connection error event


Implementation
    public function get onConnectionError():Function
    public function set onConnectionError(value:Function):void
onConnectionReadyproperty 
onConnectionReady:Function

Get callback function for connection ready event


Implementation
    public function get onConnectionReady():Function
    public function set onConnectionReady(value:Function):void
rdmURLproperty 
rdmURL:String

Get URL of RDM service


Implementation
    public function get rdmURL():String
    public function set rdmURL(value:String):void
runtimeAssetURLproperty 
runtimeAssetURL:String

Get URL of Runtime assets


Implementation
    public function get runtimeAssetURL():String
    public function set runtimeAssetURL(value:String):void
runtimeFallbackVersionproperty 
runtimeFallbackVersion:String

Get fallback version number of Runtime to launch


Implementation
    public function get runtimeFallbackVersion():String
    public function set runtimeFallbackVersion(value:String):void
runtimeInstallPathproperty 
runtimeInstallPath:String

Get path of Runtime install location


Implementation
    public function get runtimeInstallPath():String
    public function set runtimeInstallPath(value:String):void
runtimeVersionproperty 
runtimeVersion:String

Get version number of Runtime


Implementation
    public function get runtimeVersion():String
    public function set runtimeVersion(value:String):void
securityRealmproperty 
securityRealm:String

Get security realm


Implementation
    public function get securityRealm():String
    public function set securityRealm(value:String):void
showInstallerUIproperty 
showInstallerUI:Boolean

Get if OpenFinInstaller should be invoked with UI


Implementation
    public function get showInstallerUI():Boolean
    public function set showInstallerUI(value:Boolean):void
startupAppproperty 
startupApp:Object  [write-only]

Set configuration of startup application.


Implementation
    public function set startupApp(value:Object):void
Constructor Detail
RuntimeConfiguration()Constructor
public function RuntimeConfiguration(uuid:String)

Constructor

Parameters
uuid:String — uuid of the connection to Runtime
Method Detail
addConfigurationItem()method
public function addConfigurationItem(name:String, value:*):void

Parameters

name:String
 
value:*

enableConsoleLogging()method 
public static function enableConsoleLogging():void

enableFileLogging()method 
public static function enableFileLogging(logFilename:String = null):void

Enable logging to a log file

Parameters

logFilename:String (default = null) — name of the log file in %LocalAppData%/OpenFin/logs

enableNativeExtensionLogging()method 
public static function enableNativeExtensionLogging(logFilePath:String, verbose:Boolean = false):void

Enable logging from native extension

Parameters

logFilePath:String — path to log file.
 
verbose:Boolean (default = false) — true to enable verbose logging

enableTraceLogging()method 
public static function enableTraceLogging():void

Enable logging with trace(...)

generateRuntimeConfig()method 
public function generateRuntimeConfig():String

Returns
String




Tue Oct 24 2017, 10:17 PM -04:00