Client Framework API

Namespace: OrionFramework

OrionFramework

Contains useful information about the Framework and the System.

Source:

Members

<static> apiURL :String

Current API server location.

Type:
Source:

<static> developerMode :Boolean

Whether developer mode is enabled.

Type:
Source:

<static> deviceID :String

Current device ID.

Type:
Source:

<static> devServer :Boolean

Whether the Framework is running on the development network.

Type:
Source:

<static> loadAllStarlets :Boolean

Whether Connection should load all Starlets at once when starting up, determined by presence of loadAllStarlets.txt. (Deprecated)

Type:
Source:

<static> managedInstall :Boolean

Whether the Framework is running in a managed environment (Windows only).

Type:
Source:
See:

<static> pathSeparator :String

Character used to delimit local paths on the current platform.

Type:
Source:

<static> platform :String

Current hardware platform, "mac"|"windows"

Type:
Source:

<static> systemDownloadPath :String

ocal system's default download path.

Type:
Source:

<static> userPath :String

Local Application support path.

Type:
Source:

<static> userToken :String

Token for determining which API server to use. (apitoken.txt)

Type:
Source:

<static> version :String

Current Framework version.

Type:
Source:

Methods

<static> getLegacyNotificationSettings(objectName, callbackName)

Retrieves <=1.5 notification settings.

Parameters:
Name Type Argument Default Description
objectName String <optional>
 'window'

Namespace containing method.
callbackName String

Name of method.
Source:
Fires:
Example
OrionFramework.getLegacyNotificationSettings('','notificationSettings');

function notificationSettings(notificationObject)
{
   // notificationObject contains legacy settings
}

<static> setResizeCallback(objectName, callbackName)

Sets a callback to be notified when the main framework window resizes. Uses the generic callback event.

Parameters:
Name Type Argument Default Description
objectName String <optional>
 'window'

Namespace containing method.
callbackName String

Name of method.
Source:
See:
Fires:
Example
OrionFramework.setResizeCallback('','resizeCallback');

function resizeCallback(event)
{
   if (event.eventName == 'frameworkResize')
   {
       OrionSystem.logToConsole('Framework window resized to width : ' + event.width + ', ' + event.height);
   }
}

<static> unsetResizeCallback()

Clears the framework resize callback so events are no longer sent.

Source:
See: