Global

Type Definitions

customRequestHeaders

An element of the `customRequestHeaders` list.

If URL matches any of the patterns, headers are added to the http request.

Type:
  • object
Properties:
Name Type Description
urlPatterns Array.<string>

List of URL patterns. See here for more details.
headers Array.<object>

List of headers (key:value)

errorCallback(reason, errorObj)

Called if there was an error during object instantiation.

Parameters:
Name Type Description
reason string

The reason of the error.
errorObj networkError

See errorCallbackPayload.

networkError

Type:
  • Object
Properties:
Name Type Description
networkErrorCode number

The network error code from Chromium.
stack string

Stack trace for the error.
message string

The message string from the error.

preloadScript

An element of the `preload` list.

Unless marked optional (optional: true), scripts are considered required.

If any required script in the list fails to fetch or load, none of the scripts in the list are executed.

Each script in the list is:

  1. Fetched from it's location into the Chromium cache
  2. Loaded from the Chromium cache into memory
  3. Executed:
    • Before regular page scripts (in <script>...</script> elements)
    • In the order given
    • Even when the previous script in the list throws an error. (To detect this, developer can check for a flag set at the end of the previous script.)
Type:
  • object
Properties:
Name Type Attributes Default Description
url string

Location of the resource. May be a local file (using file:// scheme).
optional boolean <optional>
 false

true means that if script is unavailable, other scripts may run.

rect

Type:
  • object
Properties:
Name Type Description
x number
y number
width number
height number

successCallback(successObj)

Called if object instantiation was successful.

Parameters:
Name Type Description
successObj successPayload

See successCallbackPayload.

successPayload

Type:
  • Object
Properties:
Name Type Description
httpResponseCode number

HTTP response code

trayIconClickEvent

Notes:

  1. Coordinate units are virtual screen pixels.
  2. x === bounds.x and y === bounds.y
Type:
  • object
Properties:
Name Type Description
x number

Horizontal coordinate of left edge of icon receiving the click.
y number

Vertical coordinate of top edge of icon receiving the click.
button number

Mouse button clicked where 0==left, 1==middle, 2==right.
bounds rect

Position and dimensions of icon rectangle.
monitorInfo object

trayIconClickEventListener()

A handler set by calling fin.desktop.Application#setTrayIcon.

Parameters:
Type Description
trayIconClickEvent

The event object.

trayIconHoverEvent

Notes:

  1. Coordinate units are virtual screen pixels.
  2. x === bounds.x and y === bounds.y
Type:
  • object
Properties:
Name Type Description
x number

Horizontal coordinate of left edge of icon under the mouse pointer.
y number

Vertical coordinate of top edge of icon under the mouse pointer.
bounds rect

Position and dimensions of icon rectangle.
monitorInfo object

trayIconHoverEventListener()

A handler set by calling fin.desktop.Application#setTrayIcon.

Parameters:
Type Description
trayIconHoverEvent

The event object.