JSDoc: Tutorial: System.EventEmitter

fin.System has inherited an EventEmitter with the below methods so that it is possible to listen to OpenFin events. The below methods are asynchronous as they must cross process boundaries and setup the listener in the browser process. When the EventEmitter receives an event from the browser process and emits on the renderer, all of the functions attached to that specific event are called synchronously. Any values returned by the called listeners are ignored and will be discarded. If the execution context of the window is destroyed by page navigation or reload, any events that have been setup in that context will be destroyed.

addListener(event, listener)

Adds a listener to the end of the listeners array for the specified event.

fin.System.addListener('monitor-info-changed', function(event) {
    console.log("The monitor information has changed to: ", event);
});

on(event, listener)

Adds a listener to the end of the listeners array for the specified event.

fin.System.on('monitor-info-changed', function(event) {
    console.log("The monitor information has changed to: ", event);
});

once(event, listener)

Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.

fin.System.once('monitor-info-changed', function(event) {
    console.log("The monitor information has changed to: ", event);
});

prependListener(event, listener)

Adds a listener to the beginning of the listeners array for the specified event.

fin.System.prependListener('monitor-info-changed', function(event) {
    console.log("The monitor information has changed to: ", event);
});

prependOnceListener(event, listener)

Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed. The listener is added to the beginning of the listeners array.

fin.System.prependOnceListener('monitor-info-changed', function(event) {
    console.log("The monitor information has changed to: ", event);
});

removeListener(event, listener)

Remove a listener from the listener array for the specified event. Caution: Calling this method changes the array indices in the listener array behind the listener.

const callback = function(event) {
  console.log("The monitor information has changed to: ", event);
};

fin.System.on('monitor-info-changed', callback);
fin.System.removeListener("monitor-info-changed", callback);

removeAllListeners([event])

Removes all listeners, or those of the specified event.

fin.System.removeAllListeners("monitor-info-changed");

Supported system event types

application-closed
application-connected (see Application.EventEmitter)
application-crashed
application-created
application-initialized (see Application.EventEmitter)
application-manifest-changed (see Application.EventEmitter)
application-not-responding (see Application.EventEmitter)
application-responding (see Application.EventEmitter)
application-run-requested (see Application.EventEmitter)
application-started
application-tray-icon-clicked (see Application.EventEmitter)
desktop-icon-clicked
idle-state-changed
monitor-info-changed
session-changed
window-blurred
window-bounds-changed (see Window.addEventListener)
window-bounds-changing (see Window.addEventListener)
window-closed
window-closing
window-crashed
window-created
window-disabled-movement-bounds-changed (see Window.addEventListener)
window-disabled-movement-bounds-changing (see Window.addEventListener)
window-embedded (see Window.addEventListener)
window-end-load (see Window.addEventListener)
window-external-process-exited (see Window.addEventListener)
window-external-process-started (see Window.addEventListener)
window-file-download-completed (see Window.addEventListener)
window-file-download-progress (see Window.addEventListener)
window-file-download-started (see Window.addEventListener)
window-focused
window-group-changed (see Window.addEventListener)
window-hidden (see Window.addEventListener)
window-initialized (see Window.addEventListener)
window-maximized (see Window.addEventListener)
window-minimized (see Window.addEventListener)
window-navigation-rejected (see Window.addEventListener)
window-not-responding (see Window.addEventListener)
window-preload-scripts-state-changed (see Window.addEventListener)
window-preload-scripts-state-changing (see Window.addEventListener)
window-reloaded (see Window.addEventListener)
window-responding (see Window.addEventListener)
window-restored (see Window.addEventListener)
window-shown (see Window.addEventListener)
window-start-load (see Window.addEventListener)
window-user-movement-disabled (see Window.addEventListener)
window-user-movement-enabled (see Window.addEventListener)

System Events

application-closed

Generated when an application has closed.

//This response has the following shape:
{
    topic: "system",
    type: "application-closed",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

application-crashed

Generated when an application has crashed.

//This response has the following shape:
{
    topic: "system",
    type: "application-crashed",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

application-created

Generated when an application is created.

//This response has the following shape:
{
    topic: "system",
    type: "application-created",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

application-started

Generated when an application has started.

//This response has the following shape:
{
    topic: "system",
    type: "application-started",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

external-application-connected

Generated when an external application has connected

 {
    topic: "system",
    type: "external-application-connected",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the external application
}

external-application-disconnected

Generated when an external application has disconnected

 {
    topic: "system",
    type: "external-application-disconnected",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the external application
}

desktop-icon-clicked

Generated when the desktop icon is clicked while it's already running.

//This response has the following shape:
{
    mouse: {
        left: 13, //the left virtual screen coordinate of the mouse
        top: 14  // the top virtual screen coordinate of the mouse
    },
    tickCount: 233000, //the number of milliseconds that have elapsed since the system was started,
    topic: "system",
    type: "desktop-icon-clicked",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application launching
}

idle-state-changed

Generated when a user enters or returns from idle state. This method is continuously generated every minute while the user is in idle. A user enters idle state when the computer is locked or when there has been no keyboard/mouse activity for 1 minute. A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.

//This response has the following shape:
{
    elapsedTime: 6000, //How long in milliseconds since the user has been idle.
    isIdle: true, //true when the user is idle,false when the user has returned;
    topic: "system",
    type: "idle-state-changed"
}

monitor-info-changed

Generated on changes of a monitor's size/location. A monitor's size changes when the taskbar is resized or relocated. The available space of a monitor defines a rectangle that is not occupied by the taskbar.

//This response has the following shape:
{
    nonPrimaryMonitors: [{
        availableRect: {
            bottom: 55, //bottom-most available monitor coordinate,
            left: 55, //left-most available monitor coordinate,
            right: 55, //right-most available monitor coordinate,
            top: 55 //top-most available monitor coordinate
        },
        deviceId: "device", //device id of the display
        displayDeviceActive: true, //true if the display is active
        monitorRect: {
            bottom: 55, //bottom-most monitor coordinate,
            left: 55, //left-most monitor coordinate,
            right: 55, //right-most monitor coordinate,
            top: 55 //top-most monitor coordinate
        },
        name: "display two" //name of the display
    }],
    primaryMonitor: {
        availableRect: {
            bottom: 55, //bottom-most available monitor coordinate,
            left: 55, //left-most available monitor coordinate,
            right: 55, //right-most available monitor coordinate,
            top: 55 //top-most available monitor coordinate
        },
        deviceId: "device", //device id of the display
        displayDeviceActive: true, //true if the display is active
        monitorRect: {
            bottom: 55, //bottom-most monitor coordinate,
            left: 55, //left-most monitor coordinate,
            right: 55, //right-most monitor coordinate,
            top: 55 //top-most monitor coordinate
        },
        name: "display one" //name of the display
    },
    reason: "display", //the action that triggered this event. Can be "taskbar", "display" or "unknown"
    taskbar: {
        edge: "top" // which edge of a monitor the taskbar is on,
        rect: {
            bottom: 55, //bottom-most coordinate of the taskbar
            left: 55, //left-most coordinate of the taskbar
            right: 55, //right-most coordinate of the taskbar
            top: 55 //top-most coordinate of the taskbar
        }
    },
    topic: "system",
    type: "monitor-info-changed",
    virtualScreen: {
        bottom: 55, //bottom-most coordinate of the virtual screen,
        left: 55, //left-most coordinate of the virtual screen,
        right: 55, //right-most coordinate of the virtual screen,
        top: 55 //top-most coordinate of the virtual screen
    }
}

session-changed

Generated on changes to a user’s local computer session.

//This response has the following shape:
{
    reason: "lock", //the action that triggered this event:
                    //"lock"
                    //"unlock"
                    //"remote-connect"
                    //"remote-disconnect"
                    //"unknown"
    topic: "system",
    type: "session-changed"
}

window-blurred

Generated when a window loses focus.

//This response has the following shape:
{
    name: "windowName",
    topic: "system",
    type: "window-blurred",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

window-closed

Generated when a window closes.

//This response has the following shape:
{
    name: "windowName",
    topic: "system",
    type: "window-closed",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

window-closing

Generated when a window has initiated the closing routine.

//This response has the following shape:
{
    name: "windowName",
    topic: "system",
    type: "window-closing",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

window-crashed

Generated when a window crashes.

//This response has the following shape:
{
    name: "windowName",
    topic: "system",
    type: "window-crashed",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

window-created

Generated when a window is created.

//This response has the following shape:
{
    name: "windowName",
    topic: "system",
    type: "window-created",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}

window-focused

Generated when a window gains focus.

//This response has the following shape:
{
    name: "windowName",
    topic: "system",
    type: "window-focused",
    uuid: "454C7F31-A915-4EA2-83F2-CFA655453C52" // the UUID of the application
}