Classes

Classes

Array

Boolean

Browser

Date

Function

Number

Object

Activity

CallPop

ChatMessage

ChatParticipant

ChatPresence

ChatSession

DataPacket

FaxesFromXMPP

FaxFromXMPP

FeaturesFromAPI

Notification

Starlet

StarletsFromAPI

StarletsFromFramework

UpdateNotification

VideoToChatSession

RegExp

SpinnerClass

String

TimerClass

ControllerClass

Namespaces

Bus

Connection

Defaults

Options

OrionAPI

OrionConnection

OrionDownload

OrionFileSystem

OrionFramework

OrionLightbox

OrionNavigation

OrionNotification

OrionObjects

OrionShoebox

OrionSimpleSoundPlayer

OrionStarletWindow

OrionSystem

OrionTearoff

OrionTearoffChild

OrionTearoffParent

OrionUpdate

OrionUpload

Starlet

Widget

XMPP

Events

animationComplete

Starlet transition animation is complete.

Type:

• Undefined

Source:

• js/library.framework.js, line 355

animationReady

Whether Starlet transition is ready to proceed.

Type:

• Boolean

Source:

• js/library.framework.js, line 351

animationStep

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'animationStep'
x	Number	Horizontal step distance (px).
y	Number	Vertical step distance (px).

Source:

• js/library.framework.js, line 262

See:

• OrionConnection.setAnimationStepCallback

apiURL

Fully hashed API URL, ready to request.

Type:

• String

Source:

• js/library.framework.js, line 363

childClosed

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'childClosed'
key	String	Framework name of starlet.

Source:

• js/library.framework.js, line 243

See:

• OrionTearoffParent.setChildClosedCallback

childLoaded

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'childLoaded'
key	String	Framework name of starlet.

Source:

• js/library.framework.js, line 249

See:

• OrionTearoffParent.setChildLoadedCallback

clipboardData

Contents of system clipboard.

Type:

• Mixed

Source:

• js/library.framework.js, line 367

downloadError

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'downloadError'
key	String	Unique download key.
errorText	String	Description of the error.

Source:

• js/library.framework.js, line 198

See:

• OrionDownload.setErrorCallback

downloadFinish

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'downloadFinish'
key	String	Unique download key.
totalDown	Number	Amount downloaded, hopefully total filesize.

Source:

• js/library.framework.js, line 191

See:

• OrionDownload.setFinishCallback

downloadProgress

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'downloadProgress'
downloads	Object:.<Object:>	List of active downloads indexed by key. Properties Name Type Description curBytes Number Amount downloaded so far. totalBytes Number Filesize, requires content length response header.

Source:

• js/library.framework.js, line 183

See:

• OrionDownload.setProgressCallback

downloadResponse

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'downloadResponse'
key	String	Unique download key.
responseCode	Number	Server response code.
eventName	String	Message from server.

Source:

• js/library.framework.js, line 205

See:

• OrionDownload.setResponseCallback

flashVersion

Version of Flash installed on the System.

Type:

• String

Source:

• js/library.framework.js, line 316

frameworkExit

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'frameworkExit'

Source:

• js/library.framework.js, line 157

See:

• OrionStarletWindow.setExitCallback

frameworkResize

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'frameworkResize'
width	Number	Width of Application window (px).
height	Number	Height of Application window (px).

Source:

• js/library.framework.js, line 255

See:

• OrionFramework.setResizeCallback

frameworkSettings

Saved settings.

Type:

• Object

Properties:

Name	Type	Description
start	Boolean	Whether the Framework will start on logging into the OS.
minimize	Boolean	When start is true, whether framework will start minimized.

Source:

• js/library.framework.js, line 344

See:

• OrionConnection.getFrameworkSettings

generateUniqueKey

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'generateUniqueKey'
identifier	String	Identifier passed in when generating key.
key	String	The unique key.

Source:

• js/library.framework.js, line 162

See:

• OrionSystem.generateUniqueKey

hasMicrophone

Whether a microphone is present.

Type:

• Boolean

Source:

• js/library.framework.js, line 332

hasWebcam

Whether a webcam is present.

Type:

• Boolean

Source:

• js/library.framework.js, line 328

idleTime

System idle time in seconds.

Type:

• Number

Source:

• js/library.framework.js, line 312

legacySettings

Legacy (<= 1.5) settings in live JSON.

Type:

• Object

Source:

• js/library.framework.js, line 308

lightboxClosed

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'lightboxClosed'
name	Number	Framework name of Starlet.

Source:

• js/library.framework.js, line 301

See:

• OrionLightbox.setClosedCallback

localPath

Path in the local filesystem.

Type:

• String

Source:

• js/library.framework.js, line 320

localStarlets

Indexed representation of content in starlets.sql.

Type:

• Object

Source:

• js/library.framework.js, line 336

localUrl

Local "file:///" URL.

Type:

• String

Source:

• js/library.framework.js, line 324

mouseEnter

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'mouseEnter'
mouseX	Number	X coordinate of mouse.
mouseY	Number	Y coordinate of mouse.

Source:

• js/library.framework.js, line 169

See:

• OrionStarletWindow.setMouseCallback

mouseLeave

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'mouseLeave'
mouseX	Number	X coordinate of mouse.
mouseY	Number	Y coordinate of mouse.

Source:

• js/library.framework.js, line 176

See:

• OrionStarletWindow.setMouseCallback

orionappUrl

URL received via orionapp link.

Type:

• String

Source:

• js/library.framework.js, line 340

starletVisible

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'starletVisible'
visible	Boolean	Whether Starlet's WebView is visible.

Source:

• js/library.framework.js, line 269

See:

• OrionStarletWindow.setStarletVisibleCallback

systemSleep

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'systemSleep'

Source:

• js/library.framework.js, line 117

See:

• OrionSystem.setSleepCallback

systemWake

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'systemWake'

Source:

• js/library.framework.js, line 122

See:

• OrionSystem.setWakeCallback

updateErrorEvent

Error codes: 2502 Update file not found on server, 2504 Error trying to save update file on disk, 2506 General download error, 2514 Access denied, 2515 URL for update file not found, 2622 Local file locked, 2624 Local file error, 2628 Local file permission error, 3000 Invalid CRC for update file, 3600 Network connectivity error, 3611 Network connectivity error, 4000 Generic/Unknown Error

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'updateErrorEvent'
errorCode	Number	Server response code.

Source:

• js/library.framework.js, line 282

See:

• OrionUpdate.setErrorCallback

updateProgressEvent

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'updateProgressEvent'
current	Number	Amount downloaded so far.
total	Number	Filesize, requires content length response header.

Source:

• js/library.framework.js, line 275

See:

• OrionUpdate.setProgressCallback

uploadError

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'uploadError'
key	String	Unique upload key.
errorText	String	Description of the error.

Source:

• js/library.framework.js, line 228

See:

• OrionUpload.setErrorCallback

uploadFinish

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'uploadFinish'
key	String	Unique upload key.
totalDown	Number	Amount uploaded, hopefully total filesize.

Source:

• js/library.framework.js, line 221

See:

• OrionUpload.setFinishCallback

uploadProgress

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'uploadProgress'
uploads	Object:.<Object:>	List of active uploads indexed by key. Properties Name Type Description curBytes Number Amount uploaded so far. totalBytes Number Local filesize.

Source:

• js/library.framework.js, line 213

See:

• OrionUpload.setProgressCallback

uploadResponse

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'uploadResponse'
key	String	Unique upload key.
responseCode	Number	Server response code.
eventName	String	Message from server.

Source:

• js/library.framework.js, line 235

See:

• OrionUpload.setResponseCallback

visibleStarlet

Name of currently visible Starlet.

Type:

• String

Source:

• js/library.framework.js, line 359

windowFocus

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'windowFocus'

Source:

• js/library.framework.js, line 137

See:

• OrionStarletWindow.setFocusCallback

windowHidden

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'windowHidden'

Source:

• js/library.framework.js, line 147

See:

• OrionStarletWindow.setHiddenCallback

windowMinimize

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'windowMinimize'

Source:

• js/library.framework.js, line 127

See:

• OrionStarletWindow.setMinimizeCallback

windowUnfocus

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'windowUnfocus'

Source:

• js/library.framework.js, line 142

See:

• OrionStarletWindow.setFocusCallback

windowUnhidden

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'windowUnhidden'

Source:

• js/library.framework.js, line 152

See:

• OrionStarletWindow.setHiddenCallback

windowUnminimize

Type:

• Object

Properties:

Name	Type	Description
eventName	String	'windowUnminimize'

Source:

• js/library.framework.js, line 132

See:

• OrionStarletWindow.setMinimizeCallback