Client Framework API

Global

Members

<readonly> BrowserArchitecture :Number

Values identifying browser architecture.

Type:
Properties:
Name Type Default Description
Unknown Number 0
x86 Number 1
x86_64 Number 2
ARM Number 3
PPC Number 4
ia64 Number 5
Source:
See:

<readonly> BrowserPlatform :Number

Values identifying browser platform.

Type:
Properties:
Name Type Default Description
Unknown Number 0
Mac Number 1
Windows Number 2
Linux Number 3
iOS Number 4
Android Number 5
Source:
See:

<constant> CHATSESSIONS_LIMIT :Number

Maximum number of concurrent chat sessions.

Type:
Source:

desiredFPS

Maximum framerate for all jQuery based animations.

Source:

<constant> DEVELOPER :Boolean

Indicates whether Framework is running in developer mode.

Type:
Source:

<constant> F_COMPONENT :Boolean

Indicates whether the features comprising components are supported.

Type:
Source:

<constant> F_CUSTOM :Boolean

Indicates whether custom elements are supported.

Type:
Source:

<constant> F_IMPORT :Boolean

Indicates whether HTML imports are supported. Even if true, a <link>'s 'import' property will be null if: The <link> doesn't have rel="import". The <link> has not been added to the DOM. The <link> has been removed from the DOM. The resource is not CORS-enabled.

Type:
Source:

<constant> F_OBSERVE :Boolean

Indicates whether Objects are observable.

Type:
Source:

<constant> F_SERVICE :Boolean

Indicates whether ServiceWorkers are supported.

Type:
Source:

<constant> F_SHADOW :Boolean

Indicates whether Shadow DOM is supported.

Type:
Source:

<constant> F_SOCKET :Boolean

Indicates whether WebSockets are supported.

Type:
Source:

<constant> F_TEMPLATE :Boolean

Indicates whether HTML templates are supported.

Type:
Source:

<constant> F_WORKER :Boolean

Indicates whether WebWorkers are supported.

Type:
Source:

<constant> HASH :String

Fragment of current location.

Type:
Source:

<constant> HOST :String

Hostname of current location.

Type:
Source:

<constant> ISORION :Boolean

Indicates whether code is running in the Star2Star Application Framework.

Type:
Source:

<readonly> KEYCODES :Number

Hashlike index of keycodes and corresponding values.

Type:
Properties:
Name Type Default Description
Number 9
0 Number 48
) Number 48
1 Number 49
! Number 49
2 Number 50
@ Number 50
3 Number 51
Number 51
4 Number 52
$ Number 52
5 Number 53
% Number 53
6 Number 54
^ Number 54
7 Number 55
& Number 55
8 Number 56
* Number 56
9 Number 57
( Number 57
a Number 65
b Number 66
c Number 67
d Number 68
e Number 69
f Number 70
g Number 71
h Number 72
i Number 73
j Number 74
k Number 75
l Number 76
m Number 77
n Number 78
o Number 79
p Number 80
q Number 81
r Number 82
s Number 83
t Number 84
u Number 85
v Number 86
w Number 87
x Number 88
y Number 89
z Number 90
; Number 186
: Number 186
= Number 187
+ Number 187
Number 188
< Number 188
- Number 189
_ Number 189
Number 190
> Number 190
/ Number 191
? Number 191
` Number 192
Number 192
[ Number 219
{ Number 219
\ Number 220
| Number 220
] Number 221
} Number 221
' Number 222
" Number 222
Source:

<constant> L_ALWAYS :Number

Log level: Show regardless of display level (avoid).

Type:
Source:

<constant> L_DEBUG :Number

Log level: Arguments and presence are devaled.

Type:
Source:

<constant> L_ERROR :Number

Log level: Something's gone wrong.

Type:
Source:

<constant> L_FUNC :Number

Log level: Noting a function ran, stepping stone on a path.

Type:
Source:

<constant> L_INFO :Number

Log level: Processing details.

Type:
Source:

<constant> L_MAIN :Number

Log level: Primary occurrences only, e.g. foundational happenings.

Type:
Source:

<constant> L_NEVER :Number

Log level: Silence, only for setting squelch display level.

Type:
Source:

<constant> L_OFF :Number

Log level: Silence, only for setting display level.

Type:
Source:

<constant> L_WARN :Number

Log level: Potential problem or something to avoid.

Type:
Source:

<constant> M_ALT :Number

Modifiers: OR-able value for Alt.

Type:
Source:
See:

<constant> M_COMMAND :Number

Modifiers: OR-able value for Command.

Type:
Source:
See:

<constant> M_CONTROL :Number

Modifiers: OR-able value for Control.

Type:
Source:
See:

<constant> M_SHIFT :Number

Modifiers: OR-able value for Shift.

Type:
Source:
See:

<constant> MAC :Boolean

Indicates whether Framework is running on the Mac platform.

Type:
Source:
See:

<constant> MINISHOEBOX_MODES :Array:.<String:>

Minishoebox: List of possible modes.

Type:
Source:

<readonly> Modifiers :Number

Modifiers: OR-able values representing cross-platform keys.

Type:
Properties:
Name Type Default Description
Alt Number 1
Crtl Number 2
Command Number 4
Shift Number 8
Source:
See:

<constant> ORIGIN :String

Protocol + hostname of current location.

Type:
Source:

<constant> PATH :String

Full path of current location including filename.

Type:
Source:

PDFFindBar

Creates a "search bar" given set of DOM elements that act as controls for searching, or for setting search preferences in the UI. This object also sets up the appropriate events for the controls. Actual searching is done by PDFFindController

Source:

PDFFindController

Provides a "search" or "find" functionality for the PDF. This object actually performs the search for a given string.

Source:

<constant> POPOVER_PLACEMENTS :Array:.<String:>

Popovers: List of accepted placement strings.

Type:
Source:

Preferences

Preferences - Utility for storing persistent settings. Used for settings that should be applied to all opened documents, or every time the viewer is loaded.

Source:

<constant> PRODUCTION :Boolean

Indicates whether resources are to be loaded from Production server.

Type:
Source:
See:

<constant> ROOT :String

Base path of current location.

Type:
Source:

<constant> S_CLOSED :Number

Starlet state: Starlet not loaded.

Type:
Source:

<constant> S_MODES :Array:.<String:>

Starlet details: List of possible Starlet modes.

Type:
Source:

<constant> S_NAMES_LIGHTBOXES :Array:.<String:>

Starlet details: List of recognized lightbox names.

Type:
Source:

<constant> S_NAMES_OVERLAYS :Array:.<String:>

Starlet details: List of Starlet overlay types.

Type:
Source:

<constant> S_OPENED :Number

Starlet state: Starlet's WebView instantiated, location set.

Type:
Source:

<constant> S_PROPERTIES :Array:.<String:>

Starlet details: List of crucial Starlet properties.

Type:
Source:

<constant> S_READY :Number

Starlet state: Starlet's onRun has fired and UI initialized.

Type:
Source:

<constant> S_REGISTERED :Number

Starlet state: Starlet initialized and responsive.

Type:
Source:

<constant> S_STATES :Array:.<String:>

Starlet details: List of application window states.

Type:
Source:

<constant> S_TYPES :Array:.<String:>

Starlet details: List of accepted Starlet types.

Type:
Source:

<constant> S_TYPES_MAIN :Array:.<String:>

Starlet details: List of Starlet types within main application window.

Type:
Source:

<constant> T_DAY :Number

Time: Precomputed ms value of 1 day.

Type:
Source:

<constant> T_HALF :Number

Time: Precomputed ms value of 1/2 of 1 second.

Type:
Source:

<constant> T_HOUR :Number

Time: Precomputed ms value of 1 hour.

Type:
Source:

<constant> T_HUNDREDTH :Number

Time: Precomputed ms value of 1/100th of 1 second.

Type:
Source:

<constant> T_LEAPYEAR :Number

Time: Precomputed ms value of 1 leap year (366 days).

Type:
Source:

<constant> T_MINUTE :Number

Time: Precomputed ms value of 1 minute.

Type:
Source:

<constant> T_MONTH :Number

Time: Precomputed ms value of 1 month (30 days).

Type:
Source:

<constant> T_QUARTER :Number

Time: Precomputed ms value of 1/4th of 1 second.

Type:
Source:

<constant> T_SECOND :Number

Time: Precomputed ms value of 1 second.

Type:
Source:

<constant> T_TENTH :Number

Time: Precomputed ms value of 1/10th of 1 second.

Type:
Source:

<constant> T_THIRD :Number

Time: Precomputed ms value of 1/3rd of 1 second.

Type:
Source:

<constant> T_WEEK :Number

Time: Precomputed ms value of 1 week.

Type:
Source:

<constant> T_YEAR :Number

Time: Precomputed ms value of 1 year (365 days).

Type:
Source:

<readonly> templates :Object:.<function()>

Globally accessible index of template generator functions.

Type:
Source:

<constant> TEST :Boolean

Indicates whether resources are to be loaded from Test server.

Type:
Source:
See:

<constant> TRACKABLES :Array:.<String:>

Analytics: List of query selectors outlining elements to track.

Type:
Source:

ViewHistory

View History - This is a utility for saving various view parameters for recently opened files.

The way that the view parameters are stored depends on how PDF.js is built, for 'node make ' the following cases exist:

  • FIREFOX or MOZCENTRAL - uses sessionStorage.
  • B2G - uses asyncStorage.
  • GENERIC or CHROME - uses localStorage, if it is available.
Source:

<constant> WIN :Boolean

Indicates whether Framework is running on the Windows platform.

Type:
Source:
See:

Methods

autoExpand($element, callback)

Used as a callback on keydown/press in textareas, resizes them to accommodate full height of text while typing.

Parameters:
Name Type Description
$element Element | jQuery

Textarea to resize.
callback function

Function to call with new height after resizing.
Source:

convertToLocalTime(timeUTC) → {Object}

Adds local timezone offset to a numeric UTC timestamp.

Parameters:
Name Type Description
timeUTC Number

UTC timestamp.
Source:
Returns:

New Date instance.

Type
Object

dataArrayToObject(data) → {String}

Transforms a list of data objects into an object of data objects. Each key in the containing object corresponds to a specific property value of each data object. Each data object must contain the property used for indexing. Useful for fast lookups without looping.

Parameters:
Name Type Description
data Array

List of data to transform.
Source:
See:
Returns:

  • indexed - Property within each data object whose value to use as key in indexed object.

    Type
    String

  • Indexed data object.

    Type
    Object

dataObjectToArray(data, indexed) → {Array}

Transform indexed data object into plain list of data objects, optionally populating each with value formerly used as keys.

Parameters:
Name Type Argument Description
data Object

Indexed data object.
indexed String <optional>

Property within each data object to restore using containing object's keys as values.
Source:
See:
Returns:

List of data objects.

Type
Array

decodeURIComponentSafe(encoded) → {String}

A version of decodeURIComponent that catches exceptions, allowing code to continue execution.

Parameters:
Name Type Description
encoded String

String to decode safely.
Source:
Returns:

Decoded string.

Type
String

detectStyles() → {Number}

Searches DOM for unprocessed less styleheets, and processes them.

Source:
Returns:

Count of stylesheets detected and processed.

Type
Number

detectTemplates(prefix, force) → {Number}

Searches document for unprocessed templates, compiles them, and saves generator functions as both properties in the globally accessible templates object, and partials usable by id within other templates.

Parameters:
Name Type Argument Default Description
prefix String

Used to filter what template ids are to be processed.
force Boolean <optional>
 false

Whether to replace saved generators if a duplicate is found.
Source:
Returns:

Count of templates detected and processed.

Type
Number

deval(thing) → {String}

As close as possible to the opposite of eval. Like JSON.stringify without type restrictions.

Parameters:
Name Type Description
thing Mixed

Any value.
Source:
Returns:

Representation of value suitable for direct eval.

Type
String

exists(thing) → {Boolean}

Checks if a value isn't undefined. Detects false, null, and NaN.

Parameters:
Name Type Description
thing Mixed

Any value.
Source:
Returns:

Whether thing exists.

Type
Boolean

fork(func, delay) → {Number}

Faux-forks a function call via setTimeout. This allows procedural execution to continue while the function executes in semi-parallel (round-robin). Useful for allowing layout/reflow/repaint so up to date values can be queried from the DOM.

Parameters:
Name Type Argument Default Description
func function

Function to call, less-than-procedurally.
delay Number <optional>
 0

-
Source:
Returns:

Positive if f was actually a function and was forked.

Type
Number

format_mysql_date(date, day_offset) → {String}

Transforms a timestamp into a mysql-style formatted date string.

Parameters:
Name Type Argument Default Description
date Number

Integer UTC timestamp.
day_offset String <optional>
 '0'

Number of days to offset. Actually only responds to '0' vs any other value.
Deprecated:
  • since version 1.9
Source:
Returns:

Formatted date.

Type
String

getAttributes($element) → {Object}

Reads element attributes into an object.

Parameters:
Name Type Description
$element jQuery | Element

Source of attributes.
Source:
Returns:

Populated object.

Type
Object

getOutputScale() → {Object}

Returns scale factor for the canvas. It makes sense for the HiDPI displays.

Source:
Returns:

The object with horizontal (sx) and vertical (sy) scales. The scaled property is set to false if scaling is not required, true otherwise.

Type
Object

getPDFFileNameFromURL() → {String}

Returns the filename or guessed filename from the url (see issue 3455). url {String} The original PDF location.

Source:
Returns:

Guessed PDF file name.

Type
String

html(element) → {String}

Transforms element into representative markup.

Parameters:
Name Type Description
element jQuery | Element

Element to transform.
Source:
Returns:

Representative HTML.

Type
String

htmlDecode(html) → {String}

Unescapes HTML entities within a string.

Parameters:
Name Type Description
html String

String to decode.
Source:
Returns:

Decoded string.

Type
String

htmlEncode(text) → {String}

Escapes HTML-unsafe characters within a string.

Parameters:
Name Type Description
text String

String to encode.
Source:
Returns:

Encoded string.

Type
String

isExternal(url) → {Boolean}

Tries to determine if a given URL points within the scope of the current page.

Parameters:
Name Type Description
url String

Location to analyze.
Source:
Returns:

Whether url is external.

Type
Boolean

jUnwrap($element) → {Element}

Removes jQuery wrapper from element, if any.

Parameters:
Name Type Description
$element jQuery | Element

Reference to strip of jQuery wrapper.
Source:
Returns:

Guaranteed bare element.

Type
Element

jWrap($element) → {Element}

Adds jQuery wrapper to element if not already wrapped.

Parameters:
Name Type Description
$element jQuery | Element

Reference to wrap with jQuery.
Source:
Returns:

Guaranteed wrapped element.

Type
Element

killEvent(event)

Shorthand way of stopping propagation and preventing default action for a given event.

Parameters:
Name Type Description
event Object

Event to neutralize.
Source:

linkCallback(callback, context, persist, deferred) → {String}

Wraps a function reference in a global uniquely named function, and returns that name. Useful for passing arbitrary or anonymous functions into Framework methods, which only accept strings.

Parameters:
Name Type Argument Default Description
callback function

Function to represent via string.
context Object <optional>
 window

value when calling wrapped function.
persist Boolean <optional>
 false

Whether the wrapper should persist after one call, or destruct itself.
deferred Object <optional>

Deferred object to resolve in addition to calling wrapped function.
Properties:
Name Type Description
counter Number

How many wrapper functions have been generated.
expire Number

How long before non-persisting functions automatically destruct themselves.
Source:
See:
Returns:

Global callback wrapper function name.

Type
String

linkCallback() → {Boolean}

Logs current settings (static properties).

Properties:
Name Type Description
counter Number

How many wrapper functions have been generated.
expire Number

How long before non-persisting functions automatically destruct themselves.
Source:
See:
Returns:

false

Type
Boolean

log(value) → {Boolean}

Send stringified values to console or file for debugging or analytics. Will always output regardless of verbosity and squelch settings.

Parameters:
Name Type Argument Description
value Mixed <repeatable>

Any number of any value.
Properties:
Name Type Description
verbosity Object

Range of message levels to output.

Properties
Name Type Description
min Number

Minimum depth of message levels to log, set with logging constants.
max Number

Maximum depth of message levels to log, set with logging constants.
squelch Object

Range of message levels to deval arguments/html/xml.

Properties
Name Type Description
min Number

Minimum depth of message levels to pass squelch, set with logging constants.
max Number

Maximum depth of message levels to pass squelch, set with logging constants.
truncate Object

Max length of stringified arguments or output, 0 = unlimited.

Properties
Name Type Description
argument Number

Max length of each argument logged.
output Number

Max length of total output.
compress Boolean

Whether to LZ compress data portion of log line, requires LZString.
names Array:.<String:>

Custom identifiers for message levels, pad to same length to align log lines.
separator String

Characters to delineate values within a line.
console Boolean

Whether to redirect messages to the console instead of file.
ms Boolean

Whether to display millisecond timestamp.
msPad Number

How many places to pad timestamps.
timer Object

Timer instance for generating timestamps.
identifier String

String used to indicate which WebView emitted a message, defaults to Starlet.identifier or 'connection'.
leaderLength Number

Used to adaptively pad the leader of each line to align data into columns for readability.
exclude Array:.<RegExp:>

List of patterns to test on final output, logs nothing if any match.
Source:
See:
Returns:

true

Type
Boolean

log(level, value) → {Boolean}

Send stringified values to console or file for debugging or analytics.

Parameters:
Name Type Argument Description
level Number

Message level of line, use logging constants.
value Mixed <repeatable>

Any number of any value.
Properties:
Name Type Description
verbosity Object

Range of message levels to output.

Properties
Name Type Description
min Number

Minimum depth of message levels to log, set with logging constants.
max Number

Maximum depth of message levels to log, set with logging constants.
squelch Object

Range of message levels to deval arguments/html/xml.

Properties
Name Type Description
min Number

Minimum depth of message levels to pass squelch, set with logging constants.
max Number

Maximum depth of message levels to pass squelch, set with logging constants.
truncate Object

Max length of stringified arguments or output, 0 = unlimited.

Properties
Name Type Description
argument Number

Max length of each argument logged.
output Number

Max length of total output.
compress Boolean

Whether to LZ compress data portion of log line, requires LZString.
names Array:.<String:>

Custom identifiers for message levels, pad to same length to align log lines.
separator String

Characters to delineate values within a line.
console Boolean

Whether to redirect messages to the console instead of file.
ms Boolean

Whether to display millisecond timestamp.
msPad Number

How many places to pad timestamps.
timer Object

Timer instance for generating timestamps.
identifier String

String used to indicate which WebView emitted a message, defaults to Starlet.identifier or 'connection'.
leaderLength Number

Used to adaptively pad the leader of each line to align data into columns for readability.
exclude Array:.<RegExp:>

List of patterns to test on final output, logs nothing if any match.
Source:
See:
Returns:

true

Type
Boolean

noContextMenuHandler()

Event handler to suppress context menu.

Source:

pad(value, places, character) → {String}

Prepends characters to a value.

Parameters:
Name Type Description
value Number | String

Item to pad.
places Number

Desired minimum length.
character String

Item to pad with.
Source:
Returns:

Padded string of length >= places.

Type
String

sanitizeParams(params) → {Object}

Converts properties to strings for safer assembly of URLs.

Parameters:
Name Type Description
params Object

Parameters object to sanitize.
Source:
Returns:

Sanitized parameters object

Type
Object

scrollIntoView()

Scrolls specified element into view of its parent. element {Object} The element to be visible. spot {Object} An object with optional top and left properties, specifying the offset from the top left edge.

Source:

TextLayerBuilder()

TextLayerBuilder provides text-selection functionality for the PDF. It does this by creating overlay divs over the PDF text. This divs contain text that matches the PDF text they are overlaying. This object also provides for a way to highlight text that is being searched for.

Source:

touch(obj, property, value) → {Mixed}

Creates a property on an object if it doesn't exist, defaults to value given, and returns the reference.

Parameters:
Name Type Argument Description
obj Object

Container object.
property String

Key to create if undefined.
value Mixed <optional>

Item to set key to, otherwise null.
Source:
Returns:

Reference to obj.property.

Type
Mixed

unlinkCallback(callback) → {Boolean}

Removes a callback wrapper generated with linkCallback.

Parameters:
Name Type Description
callback String | function

Generated function name or original callback.
Source:
Returns:

Success or failure.

Type
Boolean

Type Definitions

animateStarletCallback(starletName, direction)

Parameters:
Name Type Description
starletName String

Framework name of Starlet | 'next' | 'prev'.
direction String

'up' | 'down' | 'left' | 'right' | 'none'
Source:
See:

callbackData(packet)

Receiver of DataPackets from Bus.ask calls.

Parameters:
Name Type Description
packet Object

OrionObjects.DataPacket
Source:
See:

callbackEvent(event)

This:
  • {Element:}
Parameters:
Name Type Description
event Object

Native or jQuery DOM event object.
Source:

callbackFrameworkEvent(state, instruction)

Parameters:
Name Type Argument Description
state Boolean

Whether the adjective the callback is named after is true.
instruction Boolean <optional>

Whether the change is a result of an instruction from Connection as opposed to a genuine event.
Source:

callbackGeneric()

Simply executed on some event.

Source:

callbackProv(provData)

Receiver of user's initial provisioning data.

Parameters:
Name Type Description
provData Object

Contains user details and server credentials.
Source:

crashCallback(starletName, status)

Parameters:
Name Type Description
starletName String

Framework name of Starlet.
status Number

0 = abnormal termination, 1 = killed, 2 = crashed
Source:
See:

DocumentInitParameters

Document initialization / loading parameters object.

Type:
Properties:
Name Type Description
url string

The URL of the PDF.
data TypedArray

A typed array with PDF data.
httpHeaders Object

Basic authentication headers.
withCredentials boolean

Indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies or authorization headers. The default is false.
password string

For decrypting password-protected PDFs.
initialData TypedArray

A typed array with the first portion or all of the pdf data. Used by the extension since some data is already loaded before the switch to range requests.
Source:

keyboardCallback(eventType, repeat)

Parameters:
Name Type Description
eventType Number

0|1 = keyDown, 2 = keyUp, 3 = keyChar
repeat Boolean

Whether the event is the result of a repeating key.
Source:
See:

RenderParameters

Page render parameters.

Type:
Properties:
Name Type Description
canvasContext Object

A 2D context of a DOM Canvas object.
viewport PageViewport

Rendering viewport obtained by calling of PDFPage.getViewport method.
intent string

Rendering intent, can be 'display' or 'print' (default value is 'display').
imageLayer Object

(optional) An object that has beginLayout, endLayout and appendImage functions.
continueCallback function

(optional) A function that will be called each time the rendering is paused. To continue rendering call the function that is the first argument to the callback.
Source:

TextContent

Page text content.

Type:
Properties:
Name Type Description
items array

array of TextItem
styles Object

TextStyles objects, indexed by font name.
Source:

TextItem

Page text content part.

Type:
Properties:
Name Type Description
str string

text content.
dir string

text direction: 'ttb', 'ltr' or 'rtl'.
transform array

transformation matrix.
width number

width in device space.
height number

height in device space.
fontName string

font name used by pdf.js for converted font.
Source:

TextStyle

Text style.

Type:
Properties:
Name Type Description
ascent number

font ascent.
descent number

font descent.
vertical boolean

text is in vertical mode.
fontFamily string

possible font family
Source:

Events

animationComplete

Starlet transition animation is complete.

Type:
  • Undefined
Source:

animationReady

Whether Starlet transition is ready to proceed.

Type:
Source:

animationStep

Type:
Properties:
Name Type Description
eventName String

'animationStep'
x Number

Horizontal step distance (px).
y Number

Vertical step distance (px).
Source:
See:

apiURL

Fully hashed API URL, ready to request.

Type:
Source:

childClosed

Type:
Properties:
Name Type Description
eventName String

'childClosed'
key String

Framework name of starlet.
Source:
See:

childLoaded

Type:
Properties:
Name Type Description
eventName String

'childLoaded'
key String

Framework name of starlet.
Source:
See:

clipboardData

Contents of system clipboard.

Type:
  • Mixed
Source:

downloadError

Type:
Properties:
Name Type Description
eventName String

'downloadError'
key String

Unique download key.
errorText String

Description of the error.
Source:
See:

downloadFinish

Type:
Properties:
Name Type Description
eventName String

'downloadFinish'
key String

Unique download key.
totalDown Number

Amount downloaded, hopefully total filesize.
Source:
See:

downloadProgress

Type:
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:
See:

downloadResponse

Type:
Properties:
Name Type Description
eventName String

'downloadResponse'
key String

Unique download key.
responseCode Number

Server response code.
eventName String

Message from server.
Source:
See:

flashVersion

Version of Flash installed on the System.

Type:
Source:

frameworkExit

Type:
Properties:
Name Type Description
eventName String

'frameworkExit'
Source:
See:
  • OrionStarletWindow.setExitCallback

frameworkResize

Type:
Properties:
Name Type Description
eventName String

'frameworkResize'
width Number

Width of Application window (px).
height Number

Height of Application window (px).
Source:
See:

frameworkSettings

Saved settings.

Type:
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:
See:

generateUniqueKey

Type:
Properties:
Name Type Description
eventName String

'generateUniqueKey'
identifier String

Identifier passed in when generating key.
key String

The unique key.
Source:
See:

hasMicrophone

Whether a microphone is present.

Type:
Source:

hasWebcam

Whether a webcam is present.

Type:
Source:

idleTime

System idle time in seconds.

Type:
Source:

legacySettings

Legacy (<= 1.5) settings in live JSON.

Type:
Source:

lightboxClosed

Type:
Properties:
Name Type Description
eventName String

'lightboxClosed'
name Number

Framework name of Starlet.
Source:
See:

localPath

Path in the local filesystem.

Type:
Source:

localStarlets

Indexed representation of content in starlets.sql.

Type:
Source:

localUrl

Local "file:///" URL.

Type:
Source:

mouseEnter

Type:
Properties:
Name Type Description
eventName String

'mouseEnter'
mouseX Number

X coordinate of mouse.
mouseY Number

Y coordinate of mouse.
Source:
See:

mouseLeave

Type:
Properties:
Name Type Description
eventName String

'mouseLeave'
mouseX Number

X coordinate of mouse.
mouseY Number

Y coordinate of mouse.
Source:
See:

orionappUrl

URL received via orionapp link.

Type:
Source:

starletVisible

Type:
Properties:
Name Type Description
eventName String

'starletVisible'
visible Boolean

Whether Starlet's WebView is visible.
Source:
See:

systemSleep

Type:
Properties:
Name Type Description
eventName String

'systemSleep'
Source:
See:

systemWake

Type:
Properties:
Name Type Description
eventName String

'systemWake'
Source:
See:

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:
Properties:
Name Type Description
eventName String

'updateErrorEvent'
errorCode Number

Server response code.
Source:
See:

updateProgressEvent

Type:
Properties:
Name Type Description
eventName String

'updateProgressEvent'
current Number

Amount downloaded so far.
total Number

Filesize, requires content length response header.
Source:
See:

uploadError

Type:
Properties:
Name Type Description
eventName String

'uploadError'
key String

Unique upload key.
errorText String

Description of the error.
Source:
See:

uploadFinish

Type:
Properties:
Name Type Description
eventName String

'uploadFinish'
key String

Unique upload key.
totalDown Number

Amount uploaded, hopefully total filesize.
Source:
See:

uploadProgress

Type:
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:
See:

uploadResponse

Type:
Properties:
Name Type Description
eventName String

'uploadResponse'
key String

Unique upload key.
responseCode Number

Server response code.
eventName String

Message from server.
Source:
See:

visibleStarlet

Name of currently visible Starlet.

Type:
Source:

windowFocus

Type:
Properties:
Name Type Description
eventName String

'windowFocus'
Source:
See:

windowHidden

Type:
Properties:
Name Type Description
eventName String

'windowHidden'
Source:
See:

windowMinimize

Type:
Properties:
Name Type Description
eventName String

'windowMinimize'
Source:
See:

windowUnfocus

Type:
Properties:
Name Type Description
eventName String

'windowUnfocus'
Source:
See:

windowUnhidden

Type:
Properties:
Name Type Description
eventName String

'windowUnhidden'
Source:
See:

windowUnminimize

Type:
Properties:
Name Type Description
eventName String

'windowUnminimize'
Source:
See: