@types/openfin
Advanced tools
Comparing version
@@ -11,12 +11,12 @@ // Type definitions for OpenFin API 17.0 | ||
* JavaScript API | ||
* The JavaScript API allows you to create an HTML/JavaScript application that has access to the native windowing environment, | ||
* 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. | ||
* | ||
* API Ready | ||
* When using the OpenFin API, it is important to ensure that it has been fully loaded before making any API calls. To verify | ||
* that the API is in fact ready, be sure to make any API calls either from within the fin.desktop.main() method or explicitly | ||
* When using the OpenFin API, it is important to ensure that it has been fully loaded before making any API calls. To verify | ||
* that the API is in fact ready, be sure to make any API calls either from within the fin.desktop.main() method or explicitly | ||
* after it has returned. This avoids the situation of trying to access methods that are not yet fully injected. | ||
* | ||
* Overview | ||
* When running within the OpenFin Runtime your web applications have access to the "fin" namespace and all the modules within the API | ||
* When running within the OpenFin Runtime your web applications have access to the "fin" namespace and all the modules within the API | ||
* without the need to include additional source files. You can treat the "fin" namespace as you would the "window", "navigator" or "document" objects. | ||
@@ -140,4 +140,4 @@ **/ | ||
/** | ||
* Sets new shortcut configuration for current application. | ||
* Application has to be launched with a manifest and has to have shortcut configuration (icon url, name, etc.) in its manifest to | ||
* Sets new shortcut configuration for current application. | ||
* Application has to be launched with a manifest and has to have shortcut configuration (icon url, name, etc.) in its manifest to | ||
* be able to change shortcut states. | ||
@@ -155,3 +155,3 @@ */ | ||
/** | ||
* Waits for a hanging application. This method can be called in response to an application "not-responding" to allow the application | ||
* 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. | ||
@@ -250,4 +250,4 @@ */ | ||
/** | ||
* Specifies that the window will be positioned in the center of the primary monitor when loaded for the first time on a machine. | ||
* When the window corresponding to that id is loaded again, the position from before the window was closed is used. | ||
* Specifies that the window will be positioned in the center of the primary monitor when loaded for the first time on a machine. | ||
* When the window corresponding to that id is loaded again, the position from before the window was closed is used. | ||
* This option overrides defaultLeft and defaultTop. Default: false. | ||
@@ -267,3 +267,3 @@ */ | ||
/** | ||
* The default top position of the window. Specifies the position of the top of the window when loaded for the first time on a machine. | ||
* The default top position of the window. Specifies the position of the top of the window when loaded for the first time on a machine. | ||
* When the window corresponding to that id is loaded again, the value of top is taken to be the last value before the window was closed. Default: 100. | ||
@@ -273,3 +273,3 @@ */ | ||
/** | ||
* The default width of the window. Specifies the width of the window when loaded for the first time on a machine. | ||
* The default width of the window. Specifies the width of the window when loaded for the first time on a machine. | ||
* When the window corresponding to that id is loaded again, the width is taken to be the last width of the window before it was closed. Default: 800. | ||
@@ -373,3 +373,3 @@ */ | ||
/** | ||
* When set to false, the window will render before the "load" event is fired on the content's window. | ||
* When set to false, the window will render before the "load" event is fired on the content's window. | ||
* Caution, when false you will see an initial empty white window. Default: true. | ||
@@ -473,3 +473,3 @@ */ | ||
/** | ||
* Subscribes to messages from the specified application on the specified topic. If the subscription is for a uuid, [name], | ||
* Subscribes to messages from the specified application on the specified topic. If the subscription is for a uuid, [name], | ||
* topic combination that has already been published to upon subscription you will receive the last 20 missed messages in the order they were published. | ||
@@ -503,4 +503,4 @@ */ | ||
* 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. | ||
* 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. | ||
@@ -545,4 +545,4 @@ */ | ||
/** | ||
* Invoked when the notification is closed via .close() method on the created notification instance | ||
* or the by the notification itself via fin.desktop.Notification.getCurrent().close(). | ||
* Invoked when the notification is closed via .close() method on the created notification instance | ||
* or the by the notification itself via fin.desktop.Notification.getCurrent().close(). | ||
* NOTE: this is not invoked when the notification is dismissed via a swipe. For the swipe dismissal callback see onDismiss | ||
@@ -572,3 +572,3 @@ */ | ||
* System | ||
* An object representing the core of OpenFin Runtime. | ||
* An object representing the core of OpenFin Runtime. | ||
* Allows the developer to perform system-level actions, such as accessing logs, viewing processes, clearing the cache and exiting the runtime. | ||
@@ -588,3 +588,3 @@ */ | ||
/** | ||
* Clears cached data containing window state/positions, | ||
* Clears cached data containing window state/positions, | ||
* application resource files (images, HTML, JavaScript files), cookies, and items stored in the Local Storage. | ||
@@ -651,3 +651,3 @@ */ | ||
/** | ||
* Retrieves an array of all of the runtime processes that are currently running. | ||
* Retrieves an array of all of the runtime processes that are currently running. | ||
* Each element in the array is an object containing the uuid and the name of the application to which the process belongs. | ||
@@ -722,3 +722,2 @@ */ | ||
updateProxySettings(type: string, address: string, port: number, callback?: () => void, errorCallback?: (reason: string) => void): void; | ||
} | ||
@@ -1016,4 +1015,4 @@ | ||
* | ||
* 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. | ||
* 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. | ||
@@ -1039,4 +1038,4 @@ * @param {any} options - The options of the window | ||
* 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. | ||
* 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. | ||
@@ -1050,5 +1049,5 @@ */ | ||
/** | ||
* 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. | ||
* 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(). | ||
@@ -1129,3 +1128,3 @@ * @returns {Window} Native window | ||
/** | ||
* Retrieves an array containing wrapped fin.desktop.Windows that are grouped with this window. If a window is not in a group an empty array is returned. | ||
* Retrieves an array containing wrapped fin.desktop.Windows that are grouped with this window. If a window is not in a group an empty array is returned. | ||
* Please note that calling window is included in the result array. | ||
@@ -1707,2 +1706,2 @@ */ | ||
| "bottom-right"; | ||
} | ||
} |
{ | ||
"name": "@types/openfin", | ||
"version": "17.0.0", | ||
"version": "17.0.1", | ||
"description": "TypeScript definitions for OpenFin API", | ||
@@ -20,4 +20,4 @@ "license": "MIT", | ||
"peerDependencies": {}, | ||
"typesPublisherContentHash": "3a7e9a2544823beb51c5d74ad300049d6debcf18dbecd38fc80801f5bbe2e062", | ||
"typesPublisherContentHash": "c4e31ea33625b34a0d991cb11956cba0f85ec3a9d9512855c2e34c06b6199731", | ||
"typeScriptVersion": "2.0" | ||
} |
@@ -11,3 +11,3 @@ # Installation | ||
Additional Details | ||
* Last updated: Wed, 22 Mar 2017 00:26:27 GMT | ||
* Last updated: Mon, 27 Mar 2017 18:28:37 GMT | ||
* Dependencies: none | ||
@@ -14,0 +14,0 @@ * Global values: fin |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
1619
0.06%0
-100%58536
-0.05%