mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-05 23:37:04 +00:00
Openfin v16 - new version of API (#14093)
* Initial commit of typings for OpenFin API * Initial commit for v16 of openfin api Moved v15 to v15 folder. Updated both v16 and v15 with better separation of static and instance methods.
This commit is contained in:
Chris Barker
committed by
Mohamed Hegazy
Mohamed Hegazy
parent
7fd79c061f
commit
a5530fccaf
Vendored
+125
-37
@@ -1,12 +1,11 @@
|
||||
// Type definitions for OpenFin API 15.0
|
||||
// Type definitions for OpenFin API 16.0
|
||||
// Project: https://openfin.co/
|
||||
// Definitions by: Chris Barker <https://github.com/chrisbarker/>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
// based on v6.49.15.18
|
||||
// based on v6.49.16.16
|
||||
// see https://openfin.co/support/technical-faq/#what-do-the-numbers-in-the-runtime-version-mean
|
||||
|
||||
|
||||
/**
|
||||
* JavaScript API
|
||||
* The JavaScript API allows you to create an HTML/JavaScript application that has access to the native windowing environment, can communicate with other applications and has access to sandboxed system-level features.
|
||||
@@ -22,19 +21,15 @@ declare namespace fin {
|
||||
|
||||
interface OpenFinDesktop {
|
||||
main(f: () => any): void;
|
||||
Application: OpenFinApplication;
|
||||
ExternalApp: OpenFinExternalApplication;
|
||||
Application: OpenFinApplicationStatic;
|
||||
ExternalApp: OpenFinExternalApplicationStatic;
|
||||
InterApplicationBus: OpenFinInterApplicationBus;
|
||||
Notification: OpenFinNotification;
|
||||
Notification: OpenFinNotificationStatic;
|
||||
System: OpenFinSystem;
|
||||
Window: OpenFinWindow;
|
||||
Window: OpenFinWindowStatic;
|
||||
}
|
||||
|
||||
/**
|
||||
* Application
|
||||
* An object representing an application.Allows the developer to create, execute, show / close an application as well as listen to application events.
|
||||
*/
|
||||
interface OpenFinApplication {
|
||||
interface OpenFinApplicationStatic {
|
||||
/**
|
||||
* Creates a new Application.
|
||||
* An object representing an application. Allows the developer to create, execute, show/close an application as well as listen to application events.
|
||||
@@ -48,6 +43,13 @@ declare namespace fin {
|
||||
* Returns an Application object that represents an existing application.
|
||||
*/
|
||||
wrap(uuid: string): OpenFinApplication;
|
||||
}
|
||||
|
||||
/**
|
||||
* Application
|
||||
* An object representing an application.Allows the developer to create, execute, show / close an application as well as listen to application events.
|
||||
*/
|
||||
interface OpenFinApplication {
|
||||
/**
|
||||
* Returns an instance of the main Window of the application
|
||||
*/
|
||||
@@ -155,9 +157,25 @@ declare namespace fin {
|
||||
}
|
||||
|
||||
interface ApplicationOptions {
|
||||
url?: string;
|
||||
uuid?: string;
|
||||
/**
|
||||
* The name of the application.
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* The url to the application.
|
||||
*/
|
||||
url?: string;
|
||||
/**
|
||||
* The UUID of the application, unique within the set of all other applications running in the OpenFin Runtime. name and uuid must match.
|
||||
*/
|
||||
uuid?: string;
|
||||
/**
|
||||
* Enable Flash at the application level. Default: false.
|
||||
*/
|
||||
plugins?: boolean;
|
||||
/**
|
||||
* The options of the main window of the application.
|
||||
*/
|
||||
mainWindowOptions?: WindowOptions;
|
||||
}
|
||||
|
||||
@@ -341,15 +359,17 @@ declare namespace fin {
|
||||
writeText(data: string, type: string | null, callback?: () => void, errorCallback?: (reason: string, error: ErrorInfo) => void): void;
|
||||
}
|
||||
|
||||
interface OpenFinExternalApplicationStatic {
|
||||
/**
|
||||
* Returns an External Application object that represents an existing external application.
|
||||
*/
|
||||
wrap(uuid: string): OpenFinExternalApplication;
|
||||
}
|
||||
/**
|
||||
* ExternalApplication
|
||||
* An object representing an application. Allows the developer to create, execute, show and close an application, as well as listen to application events.
|
||||
*/
|
||||
interface OpenFinExternalApplication {
|
||||
/**
|
||||
* Returns an External Application object that represents an existing external application.
|
||||
*/
|
||||
wrap(uuid: string): OpenFinExternalApplication;
|
||||
/**
|
||||
* Registers an event listener on the specified event.
|
||||
*/
|
||||
@@ -402,19 +422,22 @@ declare namespace fin {
|
||||
unsubscribe(senderUuid: string, topic: string, listener: (message: any, uuid: string, name: string) => void, callback?: () => void, errorCallback?: (reason: string) => void): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Notification
|
||||
* Notification represents a window on OpenFin Runtime which is shown briefly to the user on the bottom-right corner of the primary monitor. A notification is typically used to alert the user of some important event which requires his or her attention. Notifications are a child or your application that are controlled by the runtime.
|
||||
*/
|
||||
interface OpenFinNotification {
|
||||
interface OpenFinNotificationStatic {
|
||||
/**
|
||||
*
|
||||
* ctor
|
||||
*/
|
||||
new (options: NotificationOptions, callback?: () => void, errorCallback?: (reason: string, errorObj: NetworkErrorInfo) => void): OpenFinNotification;
|
||||
/**
|
||||
* Gets an instance of the current notification. For use within a notification window to close the window or send a message back to its parent application.
|
||||
*/
|
||||
getCurrent(): OpenFinNotification;
|
||||
}
|
||||
|
||||
/**
|
||||
* Notification
|
||||
* Notification represents a window on OpenFin Runtime which is shown briefly to the user on the bottom-right corner of the primary monitor. A notification is typically used to alert the user of some important event which requires his or her attention. Notifications are a child or your application that are controlled by the runtime.
|
||||
*/
|
||||
interface OpenFinNotification {
|
||||
/**
|
||||
* Closes the notification.
|
||||
*/
|
||||
@@ -525,6 +548,10 @@ declare namespace fin {
|
||||
* Gets the value of a given environment variable on the computer on which the runtime is installed.
|
||||
*/
|
||||
getEnvironmentVariable(envVar: string, callback?: (variable: string) => void, errorCallback?: (reason: string) => void): void;
|
||||
/**
|
||||
* Retrieves system information.
|
||||
*/
|
||||
getHostSpecs(callback?: (info: HostSpecInfo) => void, errorCallback?: (reason: string) => void): void;
|
||||
/**
|
||||
* Retrieves the contents of the log with the specified filename.
|
||||
*/
|
||||
@@ -670,6 +697,64 @@ declare namespace fin {
|
||||
left?: number;
|
||||
}
|
||||
|
||||
interface HostSpecInfo {
|
||||
/**
|
||||
* "x86" for 32-bit or "x86_64" for 64-bit
|
||||
*/
|
||||
arch: string;
|
||||
/**
|
||||
* Same payload as Node's os.cpus()
|
||||
*/
|
||||
cpus: NodeCpuInfo[];
|
||||
/**
|
||||
*
|
||||
*/
|
||||
gpu: {
|
||||
/**
|
||||
* Graphics card name
|
||||
*/
|
||||
name: string;
|
||||
};
|
||||
/**
|
||||
* Same payload as Node's os.totalmem()
|
||||
*/
|
||||
memory: number;
|
||||
/**
|
||||
* OS name and version/edition
|
||||
*/
|
||||
name: string;
|
||||
}
|
||||
|
||||
interface NodeCpuInfo {
|
||||
model: string;
|
||||
/**
|
||||
* in MHz
|
||||
*/
|
||||
speed: number;
|
||||
times: {
|
||||
/**
|
||||
* The number of milliseconds the CPU has spent in user mode.
|
||||
*/
|
||||
user: number;
|
||||
/**
|
||||
* The number of milliseconds the CPU has spent in nice mode.
|
||||
*/
|
||||
nice: number;
|
||||
/**
|
||||
* The number of milliseconds the CPU has spent in sys mode.
|
||||
*/
|
||||
sys: number;
|
||||
/**
|
||||
* The number of milliseconds the CPU has spent in idle mode.
|
||||
*/
|
||||
idle: number;
|
||||
/**
|
||||
* The number of milliseconds the CPU has spent in irq mode.
|
||||
*/
|
||||
irq: number;
|
||||
};
|
||||
}
|
||||
|
||||
interface LogInfo {
|
||||
/**
|
||||
* the filename of the log
|
||||
@@ -834,11 +919,7 @@ declare namespace fin {
|
||||
}) => void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Window
|
||||
* A basic window that wraps a native HTML window. Provides more fine-grained control over the window state such as the ability to minimize, maximize, restore, etc. By default a window does not show upon instantiation; instead the window's show() method must be invoked manually. The new window appears in the same process as the parent window.
|
||||
*/
|
||||
interface OpenFinWindow {
|
||||
interface OpenFinWindowStatic {
|
||||
/**
|
||||
* Class: Window
|
||||
*
|
||||
@@ -852,15 +933,26 @@ declare namespace fin {
|
||||
* @param {number} [callback.successObj] - httpResponseCode
|
||||
*/
|
||||
new (options: WindowOptions, callback?: (successObj: { httpResponseCode: number }) => void, errorCallback?: (reason: string, errorObj: NetworkErrorInfo) => void): OpenFinWindow;
|
||||
/**
|
||||
* Name of window
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* Returns an instance of the current window.
|
||||
* @returns {OpenFinWindow} Current window
|
||||
*/
|
||||
getCurrent(): OpenFinWindow;
|
||||
/**
|
||||
* Returns a Window object that wraps an existing window.
|
||||
*/
|
||||
wrap(appUuid: string, windowName: string): OpenFinWindow;
|
||||
}
|
||||
|
||||
/**
|
||||
* Window
|
||||
* A basic window that wraps a native HTML window. Provides more fine-grained control over the window state such as the ability to minimize, maximize, restore, etc. By default a window does not show upon instantiation; instead the window's show() method must be invoked manually. The new window appears in the same process as the parent window.
|
||||
*/
|
||||
interface OpenFinWindow {
|
||||
/**
|
||||
* Name of window
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* Returns the native JavaScript "window" object for the window. This method can only be used by the parent application or the window itself, otherwise it will return undefined. The same Single-Origin-Policy (SOP) rules apply for child windows created by window.open(url) in that the contents of the window object are only accessible if the URL has the same origin as the invoking window. See example below. Also, will not work with fin.desktop.Window objects created with fin.desktop.Window.wrap().
|
||||
* @returns {Window} Native window
|
||||
@@ -875,10 +967,6 @@ declare namespace fin {
|
||||
* Gets the parent window.
|
||||
*/
|
||||
getParentWindow(): OpenFinWindow;
|
||||
/**
|
||||
* Returns a Window object that wraps an existing window.
|
||||
*/
|
||||
wrap(appUuid: string, windowName: string): OpenFinWindow;
|
||||
/**
|
||||
* Registers an event listener on the specified event.
|
||||
*/
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
url: "application.html",
|
||||
uuid: "74BED629-2D8E-4141-8582-73E364BDFA74",
|
||||
name: "Application Name",
|
||||
plugins: false,
|
||||
mainWindowOptions: {
|
||||
defaultHeight: 600,
|
||||
defaultWidth: 800,
|
||||
@@ -287,6 +288,12 @@ function test_system() {
|
||||
fin.desktop.System.getEnvironmentVariable("APPDATA", function (variable) {
|
||||
console.log("this is the APPDATA value", variable);
|
||||
});
|
||||
// getHostSpecs
|
||||
fin.desktop.System.getHostSpecs(function (info) {
|
||||
console.log(info);
|
||||
}, function (error) {
|
||||
console.log('There was an error:', error);
|
||||
});
|
||||
// getLog
|
||||
fin.desktop.System.getLog('debug-2015-01-08-22-27-53.log', function (log) {
|
||||
console.log(log);
|
||||
|
||||
Vendored
+1504
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,718 @@
|
||||
|
||||
function test_application() {
|
||||
let application: fin.OpenFinApplication;
|
||||
// constructor
|
||||
application = new fin.desktop.Application({
|
||||
url: "application.html",
|
||||
uuid: "74BED629-2D8E-4141-8582-73E364BDFA74",
|
||||
name: "Application Name",
|
||||
mainWindowOptions: {
|
||||
defaultHeight: 600,
|
||||
defaultWidth: 800,
|
||||
defaultTop: 300,
|
||||
defaultLeft: 300,
|
||||
autoShow: true
|
||||
}
|
||||
}, function (successObj) {
|
||||
console.log("Application successfully created, HTTP response code:", successObj);
|
||||
application.run();
|
||||
}, function (error) {
|
||||
console.log("Error creating application:", error);
|
||||
});
|
||||
// getCurrent
|
||||
application = fin.desktop.Application.getCurrent();
|
||||
// wrap
|
||||
application = fin.desktop.Application.wrap("454C7F31-A915-4EA2-83F2-CFA655453C52");
|
||||
// getWindow
|
||||
application.getWindow();
|
||||
// addEventListener
|
||||
application.addEventListener("closed", function (event) {
|
||||
console.log("The application has closed");
|
||||
}, function () {
|
||||
console.log("The registration was successful");
|
||||
}, function (reason) {
|
||||
console.log("failure: " + reason);
|
||||
});
|
||||
// close
|
||||
application.close();
|
||||
// getChildWindows
|
||||
application.getChildWindows(function (children) {
|
||||
children.forEach(function (childWindow) {
|
||||
console.log("Showing child: " + childWindow.name);
|
||||
childWindow.show();
|
||||
});
|
||||
});
|
||||
// getGroups
|
||||
application.getGroups(function (allGroups) {
|
||||
console.log("There are a total of " + allGroups.length + " groups.");
|
||||
|
||||
var groupCounter = 1;
|
||||
allGroups.forEach(function (windowGroup) {
|
||||
console.log("Group " + groupCounter + " contains " +
|
||||
windowGroup.length + " windows.");
|
||||
++groupCounter;
|
||||
});
|
||||
});
|
||||
// getManifest
|
||||
application.getManifest(function (manifest) {
|
||||
console.log("Application manifest:");
|
||||
console.log(manifest);
|
||||
});
|
||||
// getParentUuid
|
||||
application.getParentUuid(function (parentUuid) {
|
||||
console.log("UUID of parent application:");
|
||||
console.log(parentUuid);
|
||||
});
|
||||
// getShortcuts
|
||||
application.getShortcuts(function (config) {
|
||||
console.log("Desktop shortcut is enabled: ", config.desktop);
|
||||
console.log("Start Menu shortcut is enabled: ", config.startMenu);
|
||||
console.log("System Startup shortcut is enabled: ", config.systemStartup);
|
||||
});
|
||||
// isRunning
|
||||
application.isRunning(function (running) {
|
||||
console.log("the application is", running ? "running" : "not running");
|
||||
});
|
||||
// registerCustomData
|
||||
application.registerCustomData({
|
||||
someData: "this is custom"
|
||||
}, function () {
|
||||
console.log("You will not read this.");
|
||||
}, function (err) {
|
||||
console.log("failure:", err);
|
||||
});
|
||||
// removeEventListener
|
||||
let previousCallback = function (event: fin.WindowEvent) { };
|
||||
application.removeEventListener("closed", previousCallback, function () {
|
||||
console.log("The unregistration was successful");
|
||||
}, function (err) {
|
||||
console.log("failure:", err);
|
||||
});
|
||||
// removeTrayIcon
|
||||
application.removeTrayIcon(function () {
|
||||
console.log("Removed the tray icon.");
|
||||
}, function (err) {
|
||||
console.log("failure:", err);
|
||||
});
|
||||
// restart
|
||||
application.restart(function () {
|
||||
console.log("You will not read this.");
|
||||
}, function (err) {
|
||||
console.log("failure:", err);
|
||||
});
|
||||
// schedule restart
|
||||
application.scheduleRestart(function () {
|
||||
console.log("You will not read this.");
|
||||
}, function (err) {
|
||||
console.log("failure:", err);
|
||||
});
|
||||
// setShortcuts
|
||||
application.setShortcuts({
|
||||
desktop: true,
|
||||
startMenu: false,
|
||||
systemStartup: true
|
||||
}, function () {
|
||||
console.log("Successfully set new shortcut states");
|
||||
}, function (error) {
|
||||
console.log("Failed to set new shortcut states. Error: ", error);
|
||||
});
|
||||
// setTrayIcon
|
||||
application.setTrayIcon("https://developer.openf.in/download/openfin.png", function (clickInfo) {
|
||||
console.log("The mouse has clicked at (" + clickInfo.x + "," + clickInfo.y + ")");
|
||||
});
|
||||
// terminate
|
||||
application.terminate();
|
||||
// wait
|
||||
application.addEventListener("not-responding", function () {
|
||||
console.log("waiting for hung application");
|
||||
application.wait();
|
||||
});
|
||||
}
|
||||
|
||||
function test_external_application() {
|
||||
let externalApp: fin.OpenFinExternalApplication;
|
||||
// wrap
|
||||
externalApp = fin.desktop.ExternalApp.wrap('my-uuid');
|
||||
// addEventListener
|
||||
externalApp.addEventListener('connected', () => {
|
||||
console.log('external app connected');
|
||||
}, () => {
|
||||
console.log('The registration was successful');
|
||||
}, (reason, err) => {
|
||||
console.log(`Error Message: ${err.message} Error Stack: ${err.stack}`);
|
||||
});
|
||||
// removeEventListener
|
||||
let previousCallback = function () { };
|
||||
externalApp.removeEventListener('connected', previousCallback, () => {
|
||||
console.log('The unregistration was successful');
|
||||
}, (reason, err) => {
|
||||
console.log(`Error Message: ${err.message} Error Stack: ${err.stack}`);
|
||||
});
|
||||
}
|
||||
|
||||
function test_inter_application_bus() {
|
||||
// addSubscribeListener
|
||||
fin.desktop.InterApplicationBus.addSubscribeListener(function (uuid, topic, name) {
|
||||
console.log("The application " + uuid + " has subscribed to " + topic);
|
||||
});
|
||||
// addUnsubscribeListener
|
||||
fin.desktop.InterApplicationBus.addUnsubscribeListener(function (uuid, topic, name) {
|
||||
console.log("The application " + uuid + " has unsubscribed to " + topic);
|
||||
});
|
||||
// removeSubscribeListener
|
||||
let aRegisteredListener = function (uuid: string, topic: string, name: string) { };
|
||||
fin.desktop.InterApplicationBus.removeSubscribeListener(aRegisteredListener);
|
||||
// removeUnsubscribeListener
|
||||
fin.desktop.InterApplicationBus.removeUnsubscribeListener(aRegisteredListener);
|
||||
// publish
|
||||
fin.desktop.InterApplicationBus.publish("a topic", {
|
||||
field1: "value1",
|
||||
field2: "value2"
|
||||
});
|
||||
// send
|
||||
fin.desktop.InterApplicationBus.send("an application's uuid", "a topic", {
|
||||
field1: "value1",
|
||||
field2: "value2"
|
||||
});
|
||||
// subscribe
|
||||
fin.desktop.InterApplicationBus.subscribe("*", "a topic", function (message, uuid, name) {
|
||||
console.log("The application " + uuid + " sent this message: " + message);
|
||||
});
|
||||
// unsubscribe
|
||||
let aRegisteredMessageListener = function (message: any, senderUuid: string) {
|
||||
console.log(message, senderUuid);
|
||||
};
|
||||
fin.desktop.InterApplicationBus.unsubscribe("*", "a topic", aRegisteredMessageListener);
|
||||
}
|
||||
|
||||
function test_notification() {
|
||||
let notification: fin.OpenFinNotification;
|
||||
// getCurrent
|
||||
notification = fin.desktop.Notification.getCurrent();
|
||||
// close
|
||||
notification.close();
|
||||
// sendMessage
|
||||
notification = new fin.desktop.Notification({
|
||||
duration: 10,
|
||||
url: "http://localhost:5000/Account/Register",
|
||||
message: "Hello",
|
||||
onShow: () => { },
|
||||
//onClose: () => { },
|
||||
onDismiss: () => { },
|
||||
//onClick: () => { },
|
||||
onMessage: () => { },
|
||||
onError: () => { }
|
||||
});
|
||||
// sendMessageToApplication
|
||||
notification.sendMessageToApplication("some message");
|
||||
}
|
||||
|
||||
function test_system() {
|
||||
// addEventListener
|
||||
fin.desktop.System.addEventListener('monitor-info-changed', function (event) {
|
||||
console.log("The monitor information has changed to: ", event);
|
||||
}, function () {
|
||||
console.log("The registration was successful");
|
||||
}, function (err) {
|
||||
console.log("failure: " + err);
|
||||
});
|
||||
// clearCache
|
||||
fin.desktop.System.clearCache({
|
||||
cache: true,
|
||||
cookies: true,
|
||||
localStorage: true,
|
||||
appcache: true,
|
||||
userData: true
|
||||
});
|
||||
// deleteCacheOnExit
|
||||
fin.desktop.System.deleteCacheOnExit(function () {
|
||||
console.log("successful");
|
||||
}, function (err) {
|
||||
console.log("failure: " + err);
|
||||
});
|
||||
// downloadAsset
|
||||
let dirAppAsset = {
|
||||
'src': 'http://local:8000/dir.zip',
|
||||
'alias': 'dirApp',
|
||||
'version': '1.23.24',
|
||||
'target': 'dir.bat',
|
||||
'args': ''
|
||||
};
|
||||
fin.desktop.System.downloadAsset(dirAppAsset, progress => {
|
||||
let downloadedPercent = Math.floor((progress.downloadedBytes / progress.totalBytes) * 100);
|
||||
console.log(`Downloaded ${downloadedPercent}%`);
|
||||
}, p => {
|
||||
console.log(`Downlod complete, can be found on ${p.path}`);
|
||||
//lets launch our application asset.
|
||||
//launchDirApp();
|
||||
}, (reason, err) => {
|
||||
console.log(reason, err);
|
||||
});
|
||||
// exit
|
||||
fin.desktop.System.exit(function () {
|
||||
console.log("successful");
|
||||
}, function (err) {
|
||||
console.log("failure: " + err);
|
||||
});
|
||||
// getAllApplications
|
||||
fin.desktop.System.getAllApplications(function (applicationInfoList) {
|
||||
applicationInfoList.forEach(function (applicationInfo) {
|
||||
console.log("Showing information for application with uuid: "
|
||||
+ applicationInfo.uuid);
|
||||
console.log("isRunning: ", applicationInfo.isRunning);
|
||||
});
|
||||
});
|
||||
// getAllExternalApplications
|
||||
fin.desktop.System.getAllExternalApplications(externalAppsInfoList => {
|
||||
externalAppsInfoList.forEach(appInfo => {
|
||||
console.log(`External app connected to the runtime with UUID ${appInfo.uuid}`);
|
||||
});
|
||||
});
|
||||
// getAllWindows
|
||||
fin.desktop.System.getAllWindows(function (windowInfoList) {
|
||||
windowInfoList.forEach(function (windowInfo) {
|
||||
console.log("Showing information for application with uuid: ", windowInfo.uuid);
|
||||
console.log("Main window: ", windowInfo.mainWindow);
|
||||
console.log("Child windows: ", windowInfo.childWindows);
|
||||
});
|
||||
});
|
||||
// getCommandLineArguments
|
||||
fin.desktop.System.getCommandLineArguments(function (args) {
|
||||
console.log("The command line arguments are " + args);
|
||||
});
|
||||
// getDeviceId
|
||||
fin.desktop.System.getDeviceId(function (id) {
|
||||
console.log("The id of the device is: " + id);
|
||||
});
|
||||
// getEnvironmentVariable
|
||||
fin.desktop.System.getEnvironmentVariable("APPDATA", function (variable) {
|
||||
console.log("this is the APPDATA value", variable);
|
||||
});
|
||||
// getLog
|
||||
fin.desktop.System.getLog('debug-2015-01-08-22-27-53.log', function (log) {
|
||||
console.log(log);
|
||||
});
|
||||
// getLogList
|
||||
fin.desktop.System.getLogList(function (logList) {
|
||||
logList.forEach(function (logInfo) {
|
||||
console.log("The filename of the log is " +
|
||||
logInfo.name + ", the size is " +
|
||||
logInfo.size + ", and the date of creation is " +
|
||||
logInfo.date);
|
||||
});
|
||||
});
|
||||
// getMonitorInfo
|
||||
fin.desktop.System.getMonitorInfo(function (monitorInfo) {
|
||||
console.log("This object contains information about all monitors: ", monitorInfo);
|
||||
});
|
||||
// getMousePosition
|
||||
fin.desktop.System.getMousePosition(function (mousePosition) {
|
||||
console.log("The mouse is located at left: " + mousePosition.left + ", top: " + mousePosition.top);
|
||||
});
|
||||
// getProcessList
|
||||
fin.desktop.System.getProcessList(function (list) {
|
||||
list.forEach(function (process) {
|
||||
console.log("UUID: " + process.uuid + ", Application Name: " + process.name);
|
||||
});
|
||||
});
|
||||
// getProxySettings
|
||||
fin.desktop.System.getProxySettings(function (proxy) {
|
||||
console.log(proxy);
|
||||
});
|
||||
// getRvmInfo
|
||||
fin.desktop.System.getRvmInfo(function (rvmInfoObject) {
|
||||
console.log("RVM version:", rvmInfoObject.version);
|
||||
console.log("RVM has been running since:", rvmInfoObject["start-time"]);
|
||||
}, function (err) {
|
||||
console.log("Failed to get rvm info, error message:", err);
|
||||
});
|
||||
// getVersion
|
||||
fin.desktop.System.getVersion(function (version) {
|
||||
console.log("The version is " + version);
|
||||
});
|
||||
// launchExternalProcess
|
||||
fin.desktop.System.launchExternalProcess({
|
||||
path: "notepad",
|
||||
arguments: "",
|
||||
listener: function (result) {
|
||||
console.log('the exit code', result.exitCode);
|
||||
}
|
||||
}, function (payload) {
|
||||
console.log('Success:', payload.uuid);
|
||||
}, function (error) {
|
||||
console.log('Error:', error);
|
||||
});
|
||||
//
|
||||
fin.desktop.System.launchExternalProcess({
|
||||
//Additionally note that the executable found in the zip file specified in appAssets
|
||||
//will default to the one mentioned by appAssets.target
|
||||
//If the the path below refers to a specific path it will override this default
|
||||
alias: "myApp",
|
||||
listener: function (result) {
|
||||
console.log('the exit code', result.exitCode);
|
||||
}
|
||||
}, function (payload) {
|
||||
console.log('Success:', payload.uuid);
|
||||
}, function (error) {
|
||||
console.log('Error:', error);
|
||||
});
|
||||
//
|
||||
fin.desktop.System.launchExternalProcess({
|
||||
alias: "myApp",
|
||||
arguments: "e f g",
|
||||
listener: function (result) {
|
||||
console.log('the exit code', result.exitCode);
|
||||
}
|
||||
}, function (payload) {
|
||||
console.log('Success:', payload.uuid);
|
||||
}, function (error) {
|
||||
console.log('Error:', error);
|
||||
});
|
||||
//
|
||||
fin.desktop.System.launchExternalProcess({
|
||||
path: "C:\Users\ExampleUser\AppData\Local\OpenFin\OpenFinRVM.exe",
|
||||
arguments: "--version",
|
||||
certificate: {
|
||||
trusted: true,
|
||||
subject: 'O=OpenFin INC., L=New York, S=NY, C=US',
|
||||
thumbprint: '3c a5 28 19 83 05 fe 69 88 e6 8f 4b 3a af c5 c5 1b 07 80 5b'
|
||||
},
|
||||
listener: function (result) {
|
||||
console.log('the exit code', result.exitCode);
|
||||
}
|
||||
}, function (payload) {
|
||||
console.log('Success:', payload.uuid);
|
||||
}, function (error) {
|
||||
console.log('Error:', error);
|
||||
});
|
||||
// log
|
||||
fin.desktop.System.log("info", "An example log message", function () {
|
||||
console.log("message successfully logged");
|
||||
}, function (err) {
|
||||
console.log(err);
|
||||
});
|
||||
// monitorExternalProcess
|
||||
fin.desktop.System.monitorExternalProcess({
|
||||
pid: 2508,
|
||||
listener: function (result) {
|
||||
console.log('the exit code', result.exitCode);
|
||||
}
|
||||
}, function (payload) {
|
||||
console.log("The process is now being monitored: ", payload.uuid);
|
||||
}, function (error) {
|
||||
console.log("Error:", error);
|
||||
});
|
||||
// openUrlWithBrowser
|
||||
fin.desktop.System.openUrlWithBrowser("https://developer.openf.in/", function () {
|
||||
console.log("successful");
|
||||
}, function (err) {
|
||||
console.log("failure: " + err);
|
||||
});
|
||||
// registerExternalConnection
|
||||
fin.desktop.System.registerExternalConnection("remote-connection-uuid", function () {
|
||||
console.log(arguments);
|
||||
});
|
||||
// releaseExternalProcess
|
||||
fin.desktop.System.launchExternalProcess({
|
||||
path: "notepad",
|
||||
arguments: "",
|
||||
listener: function (result) {
|
||||
console.log("The exit code", result.exitCode);
|
||||
}
|
||||
}, function (result) {
|
||||
console.log("Result UUID is " + result.uuid);
|
||||
|
||||
//release it.
|
||||
fin.desktop.System.releaseExternalProcess(result.uuid, function () {
|
||||
console.log("Process has been unmapped!");
|
||||
}, function (reason) {
|
||||
console.log("failure: " + reason);
|
||||
});
|
||||
});
|
||||
// removeEventListener
|
||||
let aRegisteredListener = (event: fin.SystemBaseEvent) => { };
|
||||
fin.desktop.System.removeEventListener("monitor-info-changed", aRegisteredListener, function () {
|
||||
console.log("successful");
|
||||
}, function (err) {
|
||||
console.log("failure: " + err);
|
||||
});
|
||||
// showDeveloperTools
|
||||
fin.desktop.System.showDeveloperTools("uuid", "name", function () {
|
||||
console.log("successful");
|
||||
}, function (err) {
|
||||
console.log("failure: " + err);
|
||||
});
|
||||
// terminateExternalProcess
|
||||
fin.desktop.System.launchExternalProcess({
|
||||
// notepad is in the system’s PATH
|
||||
path: "notepad",
|
||||
arguments: "",
|
||||
listener: function (result) {
|
||||
console.log("The exit code", result.exitCode);
|
||||
}
|
||||
}, function (result) {
|
||||
console.log("Result UUID is " + result.uuid);
|
||||
|
||||
// Attempt to close the process. Terminate after 4 seconds if it
|
||||
// has not done so.
|
||||
fin.desktop.System.terminateExternalProcess(result.uuid, 4000, function (info) {
|
||||
console.log("Termination result " + info.result);
|
||||
}, function (reason) {
|
||||
console.log("failure: " + reason);
|
||||
});
|
||||
});
|
||||
// updateProxySettings
|
||||
fin.desktop.System.updateProxySettings("type", "proxyAddress", 8080, function () {
|
||||
console.log('success');
|
||||
}, function (err) {
|
||||
console.log(err);
|
||||
});
|
||||
}
|
||||
|
||||
function test_system_clipboard() {
|
||||
// availableFormats
|
||||
fin.desktop.System.Clipboard.availableFormats(null, formats => {
|
||||
formats.forEach(format => console.log(`The format ${format} is available to read`));
|
||||
}, (reason, err) => {
|
||||
console.log(`Error while reading the clipboard Message: ${err.message}, Stack: ${err.stack}`);
|
||||
});
|
||||
// readHtml
|
||||
fin.desktop.System.Clipboard.readHtml(null, html => {
|
||||
console.log(`This is the html from the clipboard: ${html}`);
|
||||
}, (reason, err) => {
|
||||
console.log(`Error while reading the clipboard Message: ${err.message}, Stack: ${err.stack}`);
|
||||
});
|
||||
// readRtf
|
||||
fin.desktop.System.Clipboard.readRtf(null, rtf => {
|
||||
console.log(`This is the rtf from the clipboard: ${rtf}`);
|
||||
}, (reason, err) => {
|
||||
console.log(`Error while reading the clipboard Message: ${err.message}, Stack: ${err.stack}`);
|
||||
});
|
||||
// readText
|
||||
fin.desktop.System.Clipboard.readText(null, text => {
|
||||
console.log(`This is the text from the clipboard: ${text}`);
|
||||
}, (reason, err) => {
|
||||
console.log(`Error while reading the clipboard Message: ${err.message}, Stack: ${err.stack}`);
|
||||
});
|
||||
// write
|
||||
fin.desktop.System.Clipboard.write({
|
||||
text: 'Hello Text!',
|
||||
html: '<h1>Hello Html</h1>',
|
||||
rtf: 'Hello Rtf'
|
||||
}, null, () => {
|
||||
console.log('Success!!');
|
||||
}, (reason, err) => {
|
||||
console.log(`Error while reading the clipboard Message: ${err.message}, Stack: ${err.stack}`);
|
||||
});
|
||||
// writeHtml
|
||||
fin.desktop.System.Clipboard.writeHtml('<h1>Hello World</h1>', null, () => {
|
||||
console.log('Success!!');
|
||||
}, (reason, err) => {
|
||||
console.log(`Error while reading the clipboard Message: ${err.message}, Stack: ${err.stack}`);
|
||||
});
|
||||
// writeRtf
|
||||
fin.desktop.System.Clipboard.writeRtf('Hello World!', null, () => {
|
||||
console.log('Success!!');
|
||||
}, (reason, err) => {
|
||||
console.log(`Error while reading the clipboard Message: ${err.message}, Stack: ${err.stack}`);
|
||||
});
|
||||
// writeText
|
||||
fin.desktop.System.Clipboard.writeText('Hello World', null, () => {
|
||||
console.log('Success!!');
|
||||
}, (reason, err) => {
|
||||
console.log(`Error while reading the clipboard Message: ${err.message}, Stack: ${err.stack}`);
|
||||
});
|
||||
}
|
||||
|
||||
function test_window() {
|
||||
let finWindow: fin.OpenFinWindow;
|
||||
// constructor
|
||||
finWindow = new fin.desktop.Window({
|
||||
name: "childWindow",
|
||||
url: "child.html",
|
||||
defaultWidth: 320,
|
||||
defaultHeight: 320,
|
||||
defaultTop: 10,
|
||||
defaultLeft: 300,
|
||||
frame: false,
|
||||
resizable: false,
|
||||
state: "normal"
|
||||
}, function () {
|
||||
var _win = finWindow.getNativeWindow();
|
||||
_win.addEventListener("DOMContentLoaded", function () { finWindow.show(); });
|
||||
}, function (error) {
|
||||
console.log("Error creating window:", error);
|
||||
});
|
||||
// getCurrent
|
||||
finWindow = fin.desktop.Window.getCurrent();
|
||||
// getNativeWindow
|
||||
let nativeWindow: Window;
|
||||
nativeWindow = finWindow.getNativeWindow();
|
||||
// getParentApplication
|
||||
let parentApp: fin.OpenFinApplication;
|
||||
parentApp = finWindow.getParentApplication();
|
||||
// getParentWindow
|
||||
let parentFinWindow: fin.OpenFinWindow;
|
||||
parentFinWindow = finWindow.getParentWindow();
|
||||
// wrap
|
||||
finWindow = fin.desktop.Window.wrap("uuid", "name");
|
||||
// addEventListener
|
||||
finWindow.addEventListener("bounds-changed", function (event) {
|
||||
console.log("The window has been moved or resized");
|
||||
}, function () {
|
||||
console.log("The registration was successful");
|
||||
}, function (reason) {
|
||||
console.log("failure:" + reason);
|
||||
});
|
||||
// animate
|
||||
finWindow.animate({
|
||||
opacity: {
|
||||
opacity: 0.15,
|
||||
duration: 1000
|
||||
},
|
||||
position: {
|
||||
left: 10,
|
||||
top: 10,
|
||||
duration: 3000
|
||||
}
|
||||
}, {
|
||||
interrupt: false
|
||||
}, function (evt) {
|
||||
// Callback will only fire after both "opacity" and "position" have finished animating.
|
||||
});
|
||||
// authenticate
|
||||
finWindow.addEventListener('auth-requested', evt => {
|
||||
finWindow.authenticate('userName', 'P@assw0rd', () => { }, (reason, err) => {
|
||||
console.log("failure:", err);
|
||||
});
|
||||
});
|
||||
// blur
|
||||
finWindow.blur();
|
||||
// bringToFront
|
||||
finWindow.bringToFront();
|
||||
// close
|
||||
finWindow.close();
|
||||
// disableFrame
|
||||
finWindow.disableFrame();
|
||||
// enableFrame
|
||||
finWindow.enableFrame();
|
||||
// flash
|
||||
finWindow.flash();
|
||||
// focus
|
||||
finWindow.focus();
|
||||
// getBounds
|
||||
finWindow.getBounds(function (bounds) {
|
||||
console.log("top: " + bounds.top +
|
||||
"left: " + bounds.left +
|
||||
"height: " + bounds.height +
|
||||
"width: " + bounds.width);
|
||||
});
|
||||
// getOptions
|
||||
finWindow.getOptions(function (options) {
|
||||
console.log(options);
|
||||
});
|
||||
// getSnapshot
|
||||
finWindow.getSnapshot(function (base64Snapshot) {
|
||||
console.log("data:image/png;base64," + base64Snapshot);
|
||||
});
|
||||
// getState
|
||||
finWindow.getState(function (state) {
|
||||
console.log("state: " + state);
|
||||
});
|
||||
// getZoomLevel
|
||||
finWindow.getZoomLevel(function (level) {
|
||||
console.log("zoom level: " + level);
|
||||
}, function (error) {
|
||||
console.log('error:', error);
|
||||
});
|
||||
// hide
|
||||
finWindow.hide();
|
||||
// isShowing
|
||||
finWindow.isShowing(function (showing) {
|
||||
console.log("the window is " + (showing ? "showing" : "hidden"));
|
||||
});
|
||||
// joinGroup
|
||||
let secondWindow = new fin.desktop.Window({
|
||||
url: "http://www.openfin.co",
|
||||
name: "secondWindow",
|
||||
autoShow: true
|
||||
}, function () {
|
||||
// When mainWindow moves or is moved, secondWindow moves by the same amount
|
||||
secondWindow.joinGroup(finWindow);
|
||||
});
|
||||
// leaveGroup
|
||||
secondWindow = new fin.desktop.Window({
|
||||
url: "http://www.openfin.co",
|
||||
name: "secondWindow",
|
||||
autoShow: true
|
||||
}, function () {
|
||||
// When finWindow moves or is moved, secondWindow moves by the same amount
|
||||
secondWindow.joinGroup(finWindow, function () {
|
||||
//once we are in the group, lets leave it.
|
||||
secondWindow.leaveGroup();
|
||||
});
|
||||
});
|
||||
// maximize
|
||||
finWindow.maximize();
|
||||
// mergeGroups
|
||||
{
|
||||
let finWindowOne = new fin.desktop.Window({
|
||||
url: "http://www.openfin.co",
|
||||
name: "finWindowOne",
|
||||
autoShow: true
|
||||
});
|
||||
let finWindowTwo = new fin.desktop.Window({
|
||||
url: "http://www.openfin.co",
|
||||
name: "finWindowTwo",
|
||||
autoShow: true
|
||||
});
|
||||
let finWindowThree = new fin.desktop.Window({
|
||||
url: "http://www.openfin.co",
|
||||
name: "finWindowThree",
|
||||
autoShow: true
|
||||
});
|
||||
let finWindowFour = new fin.desktop.Window({
|
||||
url: "http://www.openfin.co",
|
||||
name: "finWindowFour",
|
||||
autoShow: true
|
||||
});
|
||||
// When finWindowOne moves or is moved, finWindowTwo moves by the same amount
|
||||
finWindowOne.joinGroup(finWindowTwo);
|
||||
// When finWindowThree moves or is moved, finWindowFour moves by the same amount
|
||||
finWindowThree.joinGroup(finWindowFour);
|
||||
// finWindowOne, finWindowTwo, finWindowThree, and finWindowFour now move together in the same group
|
||||
finWindowOne.mergeGroups(finWindowThree);
|
||||
}
|
||||
// minimize
|
||||
finWindow.minimize();
|
||||
// moveBy
|
||||
finWindow.moveBy(10, 10);
|
||||
// moveTo
|
||||
finWindow.moveTo(100, 200);
|
||||
// removeEventListener
|
||||
let aRegisteredListener = (event: fin.WindowBaseEvent) => { };
|
||||
finWindow.removeEventListener("bounds-changed", aRegisteredListener);
|
||||
// resizeBy
|
||||
finWindow.resizeBy(10, 10, "top-right");
|
||||
// resizeTo
|
||||
finWindow.resizeTo(10, 10, "top-right");
|
||||
// restore
|
||||
finWindow.restore();
|
||||
// setAsForeground
|
||||
finWindow.setAsForeground();
|
||||
// setBounds
|
||||
finWindow.setBounds(100, 200, 400, 400);
|
||||
// setZoomLevel
|
||||
finWindow.setZoomLevel(10);
|
||||
// show
|
||||
finWindow.show();
|
||||
// showAt
|
||||
finWindow.showAt(10, 10, false);
|
||||
// stopFlashing
|
||||
finWindow.stopFlashing();
|
||||
// updateOptions
|
||||
finWindow.updateOptions({
|
||||
frame: false,
|
||||
maxWidth: 500
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"target": "es6",
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"baseUrl": "../../",
|
||||
"typeRoots": [
|
||||
"../../"
|
||||
],
|
||||
"types": [],
|
||||
"paths": {
|
||||
"openfin": [
|
||||
"openfin/v15"
|
||||
]
|
||||
},
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"openfin-tests.ts"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
{ "extends": "../../tslint.json" }
|
||||
Reference in New Issue
Block a user