JSDoc: Module: Application

An object representing an application. Allows the developer to create, execute, show/close an application as well as listen to application events.

Method Index

Synchronous

getCurrent()
wrap(uuid)
getWindow()

Asynchronous

addEventListener(type, listener, callback, errorCallback)
close(force, callback, errorCallback)
getChildWindows(callback, errorCallback)
getGroups(callback, errorCallback)
getManifest(callback, errorCallback)
getParentUuid(callback, errorCallback)
getShortcuts(callback, errorCallback)
isRunning(callback, errorCallback)
registerCustomData(data, callback, errorCallback)
removeEventListener(type, listener, callback, errorCallback)
removeTrayIcon(callback, errorCallback)
restart(callback, errorCallback)
run(callback, errorCallback)
scheduleRestart(callback, errorCallback)
setShortcuts(config, callback, errorCallback)
setTrayIcon(iconUrl, listener, callback, errorCallback)
terminate(callback, errorCallback)
wait(callback, errorCallback)

Methods

(static) getCurrent() → {fin.desktop.Application}

Returns an instance of the currently running application.

Tutorials:

application.getCurrent

Returns:

fin.desktop.Application Object.

Type: fin.desktop.Application

(static) wrap(uuid) → {fin.desktop.Application}

Returns an Application object that represents an existing application.

Parameters:

Name	Type	Description
`uuid`	string	The UUID of the application to be wrapped.

Tutorials:

application.wrap

Returns:

fin.desktop.Application Object.

Type: fin.desktop.Application

addEventListener(type, listener, callbackopt, errorCallbackopt)

Registers an event listener on the specified event.

Parameters:

Name	Type	Attributes	Description
`type`	string		The type of the event.
`listener`	function		Called whenever an event of the specified type occurs. It is passed an event object containing information related to the event.
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.addEventListener

close(forceopt, callbackopt, errorCallbackopt)

Closes the application and any child windows created by the application.

Parameters:

Name	Type	Attributes	Default	Description
`force`	boolean	<optional>	false	Close will be prevented from closing when force is false and ‘close-requested’ has been subscribed to for application’s main window.
`callback`	function	<optional>		called if the method succeeds.
`errorCallback`	function	<optional>		called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.close

getChildWindows(callbackopt, errorCallbackopt)

Retrieves an array of wrapped fin.desktop.Windows for each of the application’s child windows.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.getChildWindows

getGroups(callbackopt, errorCallbackopt)

Retrieves an array of active window groups for all of the application's windows. Each group is represented as an array of wrapped fin.desktop.Windows.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.getGroups

getManifest(callbackopt, errorCallbackopt)

Retrieves the JSON manifest that was used to create the application. Invokes the error callback if the application was not created from a manifest.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.getManifest

getParentUuid(callbackopt, errorCallbackopt)

Retrieves UUID of the application that launches this application. Invokes the error callback if the application was created from a manifest.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.getParentUuid

getShortcuts(callbackopt, errorCallbackopt)

Retrieves current application's shortcut configuration.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.getShortcuts

getWindow() → {fin.desktop.Window}

Returns an instance of the main Window of the application

Tutorials:

application.getWindow

Returns:

window - fin.desktop.Window

Type: fin.desktop.Window

isRunning(callbackopt, errorCallbackopt)

Determines if the application is currently running.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.isRunning

registerCustomData(data, callbackopt, errorCallbackopt)

Passes in custom data that will be relayed to the RVM

Parameters:

Name	Type	Attributes	Description
`data`	Object		Data to be passed to the RVM.
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.registerCustomData

removeEventListener(type, listener, callbackopt, errorCallbackopt)

Removes a previously registered event listener from the specified event.

Parameters:

Name	Type	Attributes	Description
`type`	string		The type of the event.
`listener`	function		Called whenever an event of the specified type occurs. It is passed an event object containing information related to the event.
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.removeEventListener

removeTrayIcon(callbackopt, errorCallbackopt)

Removes the application’s icon from the tray.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.removeTrayIcon

restart(callbackopt, errorCallbackopt)

Restarts the application.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.restart

run(callbackopt, errorCallbackopt)

Runs the application. When the application is created, run must be called.

Parameters:

Name	Type	Attributes	Description
`callback`	fin.desktop.Application~successCallback	<optional>	called if the method succeeds. See success callback for shape.
`errorCallback`	fin.desktop.Application~errorCallback	<optional>	called if there is a network error. See error callback for shape.

Tutorials:

application.run

scheduleRestart(callbackopt, errorCallbackopt)

Instructs the RVM to schedule one restart of the application.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.scheduleRestart

setShortcuts(config, callbackopt, errorCallbackopt)

Sets new application's shortcut configuration.

Parameters:

Name Type Attributes Description

config

Object

New application's shortcut configuration.

Properties

Name	Type	Attributes	Description
`desktop`	Boolean	<optional>	Enable/disable desktop shortcut.
`startMenu`	Boolean	<optional>	Enable/disable start menu shortcut.
`systemStartup`	Boolean	<optional>	Enable/disable system startup shortcut.

callback

function

called if the method succeeds.

errorCallback

function

called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.setShortcuts

setTrayIcon(iconUrl, listener, callbackopt, errorCallbackopt)

Adds a customizable icon in the system tray and notifies the application when clicked.

Parameters:

Name	Type	Attributes	Description
`iconUrl`	string		Image URL to be used as the icon.
`listener`	function		Called whenever an event of the specified type occurs. It is passed an event object containing information related to the event.
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.setTrayIcon

terminate(callbackopt, errorCallbackopt)

Closes the application by terminating its process.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.terminate

wait(callbackopt, errorCallbackopt)

Waits for a hanging application. This method can be called in response to an application "not-responding" to allow the application to continue and to generate another "not-responding" message after a certain period of time.

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	called if the method succeeds.
`errorCallback`	function	<optional>	called if the method fails. The reason for failure is passed as an argument.

Tutorials:

application.wait