@openfin/core 34.78.17 → 34.78.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/mock-alpha.d.ts +30 -16
- package/out/mock-beta.d.ts +30 -16
- package/out/mock-public.d.ts +30 -16
- package/out/mock.d.ts +30 -16
- package/out/mock.js +13 -8
- package/package.json +1 -1
package/out/mock-alpha.d.ts
CHANGED
|
@@ -517,6 +517,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
517
517
|
/**
|
|
518
518
|
* Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
|
|
519
519
|
* If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
|
|
520
|
+
*
|
|
520
521
|
* Note: If the "name" property is omitted it defaults to "tasks".
|
|
521
522
|
* @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
|
|
522
523
|
*
|
|
@@ -787,6 +788,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
787
788
|
getProcessInfo(): Promise<OpenFin_2.AppProcessInfo>;
|
|
788
789
|
/**
|
|
789
790
|
* Sets file auto download location. It's only allowed in the same application.
|
|
791
|
+
*
|
|
790
792
|
* Note: This method is restricted by default and must be enabled via
|
|
791
793
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
792
794
|
* @param downloadLocation file auto download location
|
|
@@ -808,6 +810,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
808
810
|
setFileDownloadLocation(downloadLocation: string): Promise<void>;
|
|
809
811
|
/**
|
|
810
812
|
* Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
|
|
813
|
+
*
|
|
811
814
|
* Note: This method is restricted by default and must be enabled via
|
|
812
815
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
813
816
|
*
|
|
@@ -1206,6 +1209,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1206
1209
|
* @defaultValue false
|
|
1207
1210
|
*
|
|
1208
1211
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1212
|
+
*
|
|
1209
1213
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1210
1214
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1211
1215
|
*/
|
|
@@ -3214,8 +3218,9 @@ declare type ConstWindowOptions = {
|
|
|
3214
3218
|
closeOnLastViewRemoved: boolean;
|
|
3215
3219
|
/**
|
|
3216
3220
|
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
|
3217
|
-
* this value will be ignored for subsequent launches in favor of the cached value.
|
|
3218
|
-
*
|
|
3221
|
+
* this value will be ignored for subsequent launches in favor of the cached value.
|
|
3222
|
+
*
|
|
3223
|
+
* **NOTE:** On macOS _defaultCenter_ is somewhat above center vertically.
|
|
3219
3224
|
*/
|
|
3220
3225
|
defaultCentered: boolean;
|
|
3221
3226
|
/**
|
|
@@ -3277,6 +3282,7 @@ declare type ConstWindowOptions = {
|
|
|
3277
3282
|
* @defaultValue true
|
|
3278
3283
|
*
|
|
3279
3284
|
* Caches the location of the window.
|
|
3285
|
+
*
|
|
3280
3286
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3281
3287
|
*/
|
|
3282
3288
|
saveWindowState: boolean;
|
|
@@ -3289,7 +3295,8 @@ declare type ConstWindowOptions = {
|
|
|
3289
3295
|
* @defaultValue false
|
|
3290
3296
|
*
|
|
3291
3297
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3292
|
-
*
|
|
3298
|
+
*
|
|
3299
|
+
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3293
3300
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3294
3301
|
*/
|
|
3295
3302
|
smallWindow: boolean;
|
|
@@ -3405,7 +3412,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3405
3412
|
frameName: string;
|
|
3406
3413
|
/**
|
|
3407
3414
|
* The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation.
|
|
3408
|
-
*
|
|
3415
|
+
*
|
|
3416
|
+
* Note: It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
|
|
3409
3417
|
*/
|
|
3410
3418
|
rule: OpenFin_2.ContentCreationRule;
|
|
3411
3419
|
/**
|
|
@@ -7110,6 +7118,7 @@ declare type LayoutItemConfig = {
|
|
|
7110
7118
|
};
|
|
7111
7119
|
|
|
7112
7120
|
declare class LayoutManager {
|
|
7121
|
+
#private;
|
|
7113
7122
|
private readonly splitterController;
|
|
7114
7123
|
private readonly tabDragController;
|
|
7115
7124
|
private readonly layoutContentCache;
|
|
@@ -8002,8 +8011,9 @@ declare type MutableWindowOptions = {
|
|
|
8002
8011
|
hotkeys: Hotkey[];
|
|
8003
8012
|
/**
|
|
8004
8013
|
* A URL for the icon to be shown in the window title bar and the taskbar.
|
|
8005
|
-
* When omitted, inherits from the parent application.
|
|
8006
|
-
*
|
|
8014
|
+
* When omitted, inherits from the parent application.
|
|
8015
|
+
*
|
|
8016
|
+
* Note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
|
8007
8017
|
*/
|
|
8008
8018
|
icon: string;
|
|
8009
8019
|
/**
|
|
@@ -9984,7 +9994,8 @@ declare type PopupOptions = {
|
|
|
9984
9994
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
9985
9995
|
/**
|
|
9986
9996
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
9987
|
-
*
|
|
9997
|
+
*
|
|
9998
|
+
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
9988
9999
|
* @defaultValue false
|
|
9989
10000
|
*/
|
|
9990
10001
|
hideOnClose?: boolean;
|
|
@@ -9999,7 +10010,8 @@ declare type PopupOptions = {
|
|
|
9999
10010
|
onPopupReady?: (popupWindow: _Window) => any;
|
|
10000
10011
|
/**
|
|
10001
10012
|
* Executed when this window's popup calls `dispatchPopupResult`.
|
|
10002
|
-
*
|
|
10013
|
+
*
|
|
10014
|
+
* Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
|
|
10003
10015
|
*/
|
|
10004
10016
|
onPopupResult?: (payload: PopupResult) => any;
|
|
10005
10017
|
};
|
|
@@ -12321,7 +12333,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12321
12333
|
showDeveloperTools(identity: Identity_2): Promise<void>;
|
|
12322
12334
|
/**
|
|
12323
12335
|
* Attempt to close an external process. The process will be terminated if it
|
|
12324
|
-
* has not closed after the elapsed timeout in milliseconds
|
|
12336
|
+
* has not closed after the elapsed timeout in milliseconds.
|
|
12337
|
+
*
|
|
12325
12338
|
* Note: This method is restricted by default and must be enabled via
|
|
12326
12339
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
12327
12340
|
* @param options A object defined in the TerminateExternalRequestType interface
|
|
@@ -12353,7 +12366,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12353
12366
|
*/
|
|
12354
12367
|
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
12355
12368
|
/**
|
|
12356
|
-
* Downloads the given application asset
|
|
12369
|
+
* Downloads the given application asset.
|
|
12370
|
+
*
|
|
12357
12371
|
* Note: This method is restricted by default and must be enabled via
|
|
12358
12372
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
12359
12373
|
* @param appAsset App asset object
|
|
@@ -14490,7 +14504,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14490
14504
|
/**
|
|
14491
14505
|
* Navigates the WebContents to a specified URL.
|
|
14492
14506
|
*
|
|
14493
|
-
*
|
|
14507
|
+
* Note: The url must contain the protocol prefix such as http:// or https://.
|
|
14494
14508
|
* @param url - The URL to navigate the WebContents to.
|
|
14495
14509
|
*
|
|
14496
14510
|
* @example
|
|
@@ -14658,7 +14672,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14658
14672
|
* Prints the WebContents.
|
|
14659
14673
|
* @param options Printer Options
|
|
14660
14674
|
*
|
|
14661
|
-
*
|
|
14675
|
+
* Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
|
|
14662
14676
|
* is empty and the default settings for printing.
|
|
14663
14677
|
*
|
|
14664
14678
|
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
@@ -14682,7 +14696,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14682
14696
|
* @param searchTerm Term to find in page
|
|
14683
14697
|
* @param options Search options
|
|
14684
14698
|
*
|
|
14685
|
-
*
|
|
14699
|
+
* Note: By default, each subsequent call will highlight the next text that matches the search term.
|
|
14686
14700
|
*
|
|
14687
14701
|
* Returns a promise with the results for the request. By subscribing to the
|
|
14688
14702
|
* found-in-page event, you can get the results of this call as well.
|
|
@@ -14872,7 +14886,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14872
14886
|
/**
|
|
14873
14887
|
* Retrieves the process information associated with a WebContents.
|
|
14874
14888
|
*
|
|
14875
|
-
*
|
|
14889
|
+
* Note: This includes any iframes associated with the WebContents
|
|
14876
14890
|
*
|
|
14877
14891
|
* @example
|
|
14878
14892
|
* View:
|
|
@@ -15042,7 +15056,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15042
15056
|
/**
|
|
15043
15057
|
* Shows a popup window.
|
|
15044
15058
|
*
|
|
15045
|
-
*
|
|
15059
|
+
* Note: If this WebContents is a view and its attached window has a popup open, this will close it.
|
|
15046
15060
|
*
|
|
15047
15061
|
* Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
|
|
15048
15062
|
* that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
|
|
@@ -15050,7 +15064,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15050
15064
|
* open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
|
|
15051
15065
|
* will be dismissed.
|
|
15052
15066
|
*
|
|
15053
|
-
*
|
|
15067
|
+
* Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
|
|
15054
15068
|
*
|
|
15055
15069
|
* @example
|
|
15056
15070
|
*
|
package/out/mock-beta.d.ts
CHANGED
|
@@ -517,6 +517,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
517
517
|
/**
|
|
518
518
|
* Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
|
|
519
519
|
* If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
|
|
520
|
+
*
|
|
520
521
|
* Note: If the "name" property is omitted it defaults to "tasks".
|
|
521
522
|
* @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
|
|
522
523
|
*
|
|
@@ -787,6 +788,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
787
788
|
getProcessInfo(): Promise<OpenFin_2.AppProcessInfo>;
|
|
788
789
|
/**
|
|
789
790
|
* Sets file auto download location. It's only allowed in the same application.
|
|
791
|
+
*
|
|
790
792
|
* Note: This method is restricted by default and must be enabled via
|
|
791
793
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
792
794
|
* @param downloadLocation file auto download location
|
|
@@ -808,6 +810,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
808
810
|
setFileDownloadLocation(downloadLocation: string): Promise<void>;
|
|
809
811
|
/**
|
|
810
812
|
* Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
|
|
813
|
+
*
|
|
811
814
|
* Note: This method is restricted by default and must be enabled via
|
|
812
815
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
813
816
|
*
|
|
@@ -1206,6 +1209,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1206
1209
|
* @defaultValue false
|
|
1207
1210
|
*
|
|
1208
1211
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1212
|
+
*
|
|
1209
1213
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1210
1214
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1211
1215
|
*/
|
|
@@ -3214,8 +3218,9 @@ declare type ConstWindowOptions = {
|
|
|
3214
3218
|
closeOnLastViewRemoved: boolean;
|
|
3215
3219
|
/**
|
|
3216
3220
|
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
|
3217
|
-
* this value will be ignored for subsequent launches in favor of the cached value.
|
|
3218
|
-
*
|
|
3221
|
+
* this value will be ignored for subsequent launches in favor of the cached value.
|
|
3222
|
+
*
|
|
3223
|
+
* **NOTE:** On macOS _defaultCenter_ is somewhat above center vertically.
|
|
3219
3224
|
*/
|
|
3220
3225
|
defaultCentered: boolean;
|
|
3221
3226
|
/**
|
|
@@ -3277,6 +3282,7 @@ declare type ConstWindowOptions = {
|
|
|
3277
3282
|
* @defaultValue true
|
|
3278
3283
|
*
|
|
3279
3284
|
* Caches the location of the window.
|
|
3285
|
+
*
|
|
3280
3286
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3281
3287
|
*/
|
|
3282
3288
|
saveWindowState: boolean;
|
|
@@ -3289,7 +3295,8 @@ declare type ConstWindowOptions = {
|
|
|
3289
3295
|
* @defaultValue false
|
|
3290
3296
|
*
|
|
3291
3297
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3292
|
-
*
|
|
3298
|
+
*
|
|
3299
|
+
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3293
3300
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3294
3301
|
*/
|
|
3295
3302
|
smallWindow: boolean;
|
|
@@ -3405,7 +3412,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3405
3412
|
frameName: string;
|
|
3406
3413
|
/**
|
|
3407
3414
|
* The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation.
|
|
3408
|
-
*
|
|
3415
|
+
*
|
|
3416
|
+
* Note: It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
|
|
3409
3417
|
*/
|
|
3410
3418
|
rule: OpenFin_2.ContentCreationRule;
|
|
3411
3419
|
/**
|
|
@@ -7110,6 +7118,7 @@ declare type LayoutItemConfig = {
|
|
|
7110
7118
|
};
|
|
7111
7119
|
|
|
7112
7120
|
declare class LayoutManager {
|
|
7121
|
+
#private;
|
|
7113
7122
|
private readonly splitterController;
|
|
7114
7123
|
private readonly tabDragController;
|
|
7115
7124
|
private readonly layoutContentCache;
|
|
@@ -8002,8 +8011,9 @@ declare type MutableWindowOptions = {
|
|
|
8002
8011
|
hotkeys: Hotkey[];
|
|
8003
8012
|
/**
|
|
8004
8013
|
* A URL for the icon to be shown in the window title bar and the taskbar.
|
|
8005
|
-
* When omitted, inherits from the parent application.
|
|
8006
|
-
*
|
|
8014
|
+
* When omitted, inherits from the parent application.
|
|
8015
|
+
*
|
|
8016
|
+
* Note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
|
8007
8017
|
*/
|
|
8008
8018
|
icon: string;
|
|
8009
8019
|
/**
|
|
@@ -9984,7 +9994,8 @@ declare type PopupOptions = {
|
|
|
9984
9994
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
9985
9995
|
/**
|
|
9986
9996
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
9987
|
-
*
|
|
9997
|
+
*
|
|
9998
|
+
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
9988
9999
|
* @defaultValue false
|
|
9989
10000
|
*/
|
|
9990
10001
|
hideOnClose?: boolean;
|
|
@@ -9999,7 +10010,8 @@ declare type PopupOptions = {
|
|
|
9999
10010
|
onPopupReady?: (popupWindow: _Window) => any;
|
|
10000
10011
|
/**
|
|
10001
10012
|
* Executed when this window's popup calls `dispatchPopupResult`.
|
|
10002
|
-
*
|
|
10013
|
+
*
|
|
10014
|
+
* Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
|
|
10003
10015
|
*/
|
|
10004
10016
|
onPopupResult?: (payload: PopupResult) => any;
|
|
10005
10017
|
};
|
|
@@ -12321,7 +12333,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12321
12333
|
showDeveloperTools(identity: Identity_2): Promise<void>;
|
|
12322
12334
|
/**
|
|
12323
12335
|
* Attempt to close an external process. The process will be terminated if it
|
|
12324
|
-
* has not closed after the elapsed timeout in milliseconds
|
|
12336
|
+
* has not closed after the elapsed timeout in milliseconds.
|
|
12337
|
+
*
|
|
12325
12338
|
* Note: This method is restricted by default and must be enabled via
|
|
12326
12339
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
12327
12340
|
* @param options A object defined in the TerminateExternalRequestType interface
|
|
@@ -12353,7 +12366,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12353
12366
|
*/
|
|
12354
12367
|
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
12355
12368
|
/**
|
|
12356
|
-
* Downloads the given application asset
|
|
12369
|
+
* Downloads the given application asset.
|
|
12370
|
+
*
|
|
12357
12371
|
* Note: This method is restricted by default and must be enabled via
|
|
12358
12372
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
12359
12373
|
* @param appAsset App asset object
|
|
@@ -14490,7 +14504,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14490
14504
|
/**
|
|
14491
14505
|
* Navigates the WebContents to a specified URL.
|
|
14492
14506
|
*
|
|
14493
|
-
*
|
|
14507
|
+
* Note: The url must contain the protocol prefix such as http:// or https://.
|
|
14494
14508
|
* @param url - The URL to navigate the WebContents to.
|
|
14495
14509
|
*
|
|
14496
14510
|
* @example
|
|
@@ -14658,7 +14672,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14658
14672
|
* Prints the WebContents.
|
|
14659
14673
|
* @param options Printer Options
|
|
14660
14674
|
*
|
|
14661
|
-
*
|
|
14675
|
+
* Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
|
|
14662
14676
|
* is empty and the default settings for printing.
|
|
14663
14677
|
*
|
|
14664
14678
|
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
@@ -14682,7 +14696,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14682
14696
|
* @param searchTerm Term to find in page
|
|
14683
14697
|
* @param options Search options
|
|
14684
14698
|
*
|
|
14685
|
-
*
|
|
14699
|
+
* Note: By default, each subsequent call will highlight the next text that matches the search term.
|
|
14686
14700
|
*
|
|
14687
14701
|
* Returns a promise with the results for the request. By subscribing to the
|
|
14688
14702
|
* found-in-page event, you can get the results of this call as well.
|
|
@@ -14872,7 +14886,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14872
14886
|
/**
|
|
14873
14887
|
* Retrieves the process information associated with a WebContents.
|
|
14874
14888
|
*
|
|
14875
|
-
*
|
|
14889
|
+
* Note: This includes any iframes associated with the WebContents
|
|
14876
14890
|
*
|
|
14877
14891
|
* @example
|
|
14878
14892
|
* View:
|
|
@@ -15042,7 +15056,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15042
15056
|
/**
|
|
15043
15057
|
* Shows a popup window.
|
|
15044
15058
|
*
|
|
15045
|
-
*
|
|
15059
|
+
* Note: If this WebContents is a view and its attached window has a popup open, this will close it.
|
|
15046
15060
|
*
|
|
15047
15061
|
* Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
|
|
15048
15062
|
* that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
|
|
@@ -15050,7 +15064,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15050
15064
|
* open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
|
|
15051
15065
|
* will be dismissed.
|
|
15052
15066
|
*
|
|
15053
|
-
*
|
|
15067
|
+
* Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
|
|
15054
15068
|
*
|
|
15055
15069
|
* @example
|
|
15056
15070
|
*
|
package/out/mock-public.d.ts
CHANGED
|
@@ -517,6 +517,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
517
517
|
/**
|
|
518
518
|
* Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
|
|
519
519
|
* If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
|
|
520
|
+
*
|
|
520
521
|
* Note: If the "name" property is omitted it defaults to "tasks".
|
|
521
522
|
* @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
|
|
522
523
|
*
|
|
@@ -787,6 +788,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
787
788
|
getProcessInfo(): Promise<OpenFin_2.AppProcessInfo>;
|
|
788
789
|
/**
|
|
789
790
|
* Sets file auto download location. It's only allowed in the same application.
|
|
791
|
+
*
|
|
790
792
|
* Note: This method is restricted by default and must be enabled via
|
|
791
793
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
792
794
|
* @param downloadLocation file auto download location
|
|
@@ -808,6 +810,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
808
810
|
setFileDownloadLocation(downloadLocation: string): Promise<void>;
|
|
809
811
|
/**
|
|
810
812
|
* Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
|
|
813
|
+
*
|
|
811
814
|
* Note: This method is restricted by default and must be enabled via
|
|
812
815
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
813
816
|
*
|
|
@@ -1206,6 +1209,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1206
1209
|
* @defaultValue false
|
|
1207
1210
|
*
|
|
1208
1211
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1212
|
+
*
|
|
1209
1213
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1210
1214
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1211
1215
|
*/
|
|
@@ -3214,8 +3218,9 @@ declare type ConstWindowOptions = {
|
|
|
3214
3218
|
closeOnLastViewRemoved: boolean;
|
|
3215
3219
|
/**
|
|
3216
3220
|
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
|
3217
|
-
* this value will be ignored for subsequent launches in favor of the cached value.
|
|
3218
|
-
*
|
|
3221
|
+
* this value will be ignored for subsequent launches in favor of the cached value.
|
|
3222
|
+
*
|
|
3223
|
+
* **NOTE:** On macOS _defaultCenter_ is somewhat above center vertically.
|
|
3219
3224
|
*/
|
|
3220
3225
|
defaultCentered: boolean;
|
|
3221
3226
|
/**
|
|
@@ -3277,6 +3282,7 @@ declare type ConstWindowOptions = {
|
|
|
3277
3282
|
* @defaultValue true
|
|
3278
3283
|
*
|
|
3279
3284
|
* Caches the location of the window.
|
|
3285
|
+
*
|
|
3280
3286
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3281
3287
|
*/
|
|
3282
3288
|
saveWindowState: boolean;
|
|
@@ -3289,7 +3295,8 @@ declare type ConstWindowOptions = {
|
|
|
3289
3295
|
* @defaultValue false
|
|
3290
3296
|
*
|
|
3291
3297
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3292
|
-
*
|
|
3298
|
+
*
|
|
3299
|
+
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3293
3300
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3294
3301
|
*/
|
|
3295
3302
|
smallWindow: boolean;
|
|
@@ -3405,7 +3412,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3405
3412
|
frameName: string;
|
|
3406
3413
|
/**
|
|
3407
3414
|
* The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation.
|
|
3408
|
-
*
|
|
3415
|
+
*
|
|
3416
|
+
* Note: It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
|
|
3409
3417
|
*/
|
|
3410
3418
|
rule: OpenFin_2.ContentCreationRule;
|
|
3411
3419
|
/**
|
|
@@ -7110,6 +7118,7 @@ declare type LayoutItemConfig = {
|
|
|
7110
7118
|
};
|
|
7111
7119
|
|
|
7112
7120
|
declare class LayoutManager {
|
|
7121
|
+
#private;
|
|
7113
7122
|
private readonly splitterController;
|
|
7114
7123
|
private readonly tabDragController;
|
|
7115
7124
|
private readonly layoutContentCache;
|
|
@@ -8002,8 +8011,9 @@ declare type MutableWindowOptions = {
|
|
|
8002
8011
|
hotkeys: Hotkey[];
|
|
8003
8012
|
/**
|
|
8004
8013
|
* A URL for the icon to be shown in the window title bar and the taskbar.
|
|
8005
|
-
* When omitted, inherits from the parent application.
|
|
8006
|
-
*
|
|
8014
|
+
* When omitted, inherits from the parent application.
|
|
8015
|
+
*
|
|
8016
|
+
* Note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
|
8007
8017
|
*/
|
|
8008
8018
|
icon: string;
|
|
8009
8019
|
/**
|
|
@@ -9984,7 +9994,8 @@ declare type PopupOptions = {
|
|
|
9984
9994
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
9985
9995
|
/**
|
|
9986
9996
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
9987
|
-
*
|
|
9997
|
+
*
|
|
9998
|
+
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
9988
9999
|
* @defaultValue false
|
|
9989
10000
|
*/
|
|
9990
10001
|
hideOnClose?: boolean;
|
|
@@ -9999,7 +10010,8 @@ declare type PopupOptions = {
|
|
|
9999
10010
|
onPopupReady?: (popupWindow: _Window) => any;
|
|
10000
10011
|
/**
|
|
10001
10012
|
* Executed when this window's popup calls `dispatchPopupResult`.
|
|
10002
|
-
*
|
|
10013
|
+
*
|
|
10014
|
+
* Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
|
|
10003
10015
|
*/
|
|
10004
10016
|
onPopupResult?: (payload: PopupResult) => any;
|
|
10005
10017
|
};
|
|
@@ -12321,7 +12333,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12321
12333
|
showDeveloperTools(identity: Identity_2): Promise<void>;
|
|
12322
12334
|
/**
|
|
12323
12335
|
* Attempt to close an external process. The process will be terminated if it
|
|
12324
|
-
* has not closed after the elapsed timeout in milliseconds
|
|
12336
|
+
* has not closed after the elapsed timeout in milliseconds.
|
|
12337
|
+
*
|
|
12325
12338
|
* Note: This method is restricted by default and must be enabled via
|
|
12326
12339
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
12327
12340
|
* @param options A object defined in the TerminateExternalRequestType interface
|
|
@@ -12353,7 +12366,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12353
12366
|
*/
|
|
12354
12367
|
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
12355
12368
|
/**
|
|
12356
|
-
* Downloads the given application asset
|
|
12369
|
+
* Downloads the given application asset.
|
|
12370
|
+
*
|
|
12357
12371
|
* Note: This method is restricted by default and must be enabled via
|
|
12358
12372
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
12359
12373
|
* @param appAsset App asset object
|
|
@@ -14490,7 +14504,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14490
14504
|
/**
|
|
14491
14505
|
* Navigates the WebContents to a specified URL.
|
|
14492
14506
|
*
|
|
14493
|
-
*
|
|
14507
|
+
* Note: The url must contain the protocol prefix such as http:// or https://.
|
|
14494
14508
|
* @param url - The URL to navigate the WebContents to.
|
|
14495
14509
|
*
|
|
14496
14510
|
* @example
|
|
@@ -14658,7 +14672,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14658
14672
|
* Prints the WebContents.
|
|
14659
14673
|
* @param options Printer Options
|
|
14660
14674
|
*
|
|
14661
|
-
*
|
|
14675
|
+
* Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
|
|
14662
14676
|
* is empty and the default settings for printing.
|
|
14663
14677
|
*
|
|
14664
14678
|
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
@@ -14682,7 +14696,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14682
14696
|
* @param searchTerm Term to find in page
|
|
14683
14697
|
* @param options Search options
|
|
14684
14698
|
*
|
|
14685
|
-
*
|
|
14699
|
+
* Note: By default, each subsequent call will highlight the next text that matches the search term.
|
|
14686
14700
|
*
|
|
14687
14701
|
* Returns a promise with the results for the request. By subscribing to the
|
|
14688
14702
|
* found-in-page event, you can get the results of this call as well.
|
|
@@ -14872,7 +14886,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
14872
14886
|
/**
|
|
14873
14887
|
* Retrieves the process information associated with a WebContents.
|
|
14874
14888
|
*
|
|
14875
|
-
*
|
|
14889
|
+
* Note: This includes any iframes associated with the WebContents
|
|
14876
14890
|
*
|
|
14877
14891
|
* @example
|
|
14878
14892
|
* View:
|
|
@@ -15042,7 +15056,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15042
15056
|
/**
|
|
15043
15057
|
* Shows a popup window.
|
|
15044
15058
|
*
|
|
15045
|
-
*
|
|
15059
|
+
* Note: If this WebContents is a view and its attached window has a popup open, this will close it.
|
|
15046
15060
|
*
|
|
15047
15061
|
* Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
|
|
15048
15062
|
* that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
|
|
@@ -15050,7 +15064,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15050
15064
|
* open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
|
|
15051
15065
|
* will be dismissed.
|
|
15052
15066
|
*
|
|
15053
|
-
*
|
|
15067
|
+
* Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
|
|
15054
15068
|
*
|
|
15055
15069
|
* @example
|
|
15056
15070
|
*
|
package/out/mock.d.ts
CHANGED
|
@@ -523,6 +523,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
523
523
|
/**
|
|
524
524
|
* Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
|
|
525
525
|
* If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
|
|
526
|
+
*
|
|
526
527
|
* Note: If the "name" property is omitted it defaults to "tasks".
|
|
527
528
|
* @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
|
|
528
529
|
*
|
|
@@ -793,6 +794,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
793
794
|
getProcessInfo(): Promise<OpenFin_2.AppProcessInfo>;
|
|
794
795
|
/**
|
|
795
796
|
* Sets file auto download location. It's only allowed in the same application.
|
|
797
|
+
*
|
|
796
798
|
* Note: This method is restricted by default and must be enabled via
|
|
797
799
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
798
800
|
* @param downloadLocation file auto download location
|
|
@@ -814,6 +816,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
814
816
|
setFileDownloadLocation(downloadLocation: string): Promise<void>;
|
|
815
817
|
/**
|
|
816
818
|
* Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
|
|
819
|
+
*
|
|
817
820
|
* Note: This method is restricted by default and must be enabled via
|
|
818
821
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
819
822
|
*
|
|
@@ -1212,6 +1215,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1212
1215
|
* @defaultValue false
|
|
1213
1216
|
*
|
|
1214
1217
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1218
|
+
*
|
|
1215
1219
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1216
1220
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1217
1221
|
*/
|
|
@@ -3308,8 +3312,9 @@ declare type ConstWindowOptions = {
|
|
|
3308
3312
|
closeOnLastViewRemoved: boolean;
|
|
3309
3313
|
/**
|
|
3310
3314
|
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
|
3311
|
-
* this value will be ignored for subsequent launches in favor of the cached value.
|
|
3312
|
-
*
|
|
3315
|
+
* this value will be ignored for subsequent launches in favor of the cached value.
|
|
3316
|
+
*
|
|
3317
|
+
* **NOTE:** On macOS _defaultCenter_ is somewhat above center vertically.
|
|
3313
3318
|
*/
|
|
3314
3319
|
defaultCentered: boolean;
|
|
3315
3320
|
/**
|
|
@@ -3371,6 +3376,7 @@ declare type ConstWindowOptions = {
|
|
|
3371
3376
|
* @defaultValue true
|
|
3372
3377
|
*
|
|
3373
3378
|
* Caches the location of the window.
|
|
3379
|
+
*
|
|
3374
3380
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3375
3381
|
*/
|
|
3376
3382
|
saveWindowState: boolean;
|
|
@@ -3383,7 +3389,8 @@ declare type ConstWindowOptions = {
|
|
|
3383
3389
|
* @defaultValue false
|
|
3384
3390
|
*
|
|
3385
3391
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3386
|
-
*
|
|
3392
|
+
*
|
|
3393
|
+
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3387
3394
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3388
3395
|
*/
|
|
3389
3396
|
smallWindow: boolean;
|
|
@@ -3499,7 +3506,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3499
3506
|
frameName: string;
|
|
3500
3507
|
/**
|
|
3501
3508
|
* The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation.
|
|
3502
|
-
*
|
|
3509
|
+
*
|
|
3510
|
+
* Note: It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
|
|
3503
3511
|
*/
|
|
3504
3512
|
rule: OpenFin_2.ContentCreationRule;
|
|
3505
3513
|
/**
|
|
@@ -7375,6 +7383,7 @@ declare type LayoutItemConfig = {
|
|
|
7375
7383
|
};
|
|
7376
7384
|
|
|
7377
7385
|
declare class LayoutManager {
|
|
7386
|
+
#private;
|
|
7378
7387
|
private readonly splitterController;
|
|
7379
7388
|
private readonly tabDragController;
|
|
7380
7389
|
private readonly layoutContentCache;
|
|
@@ -8432,8 +8441,9 @@ declare type MutableWindowOptions = {
|
|
|
8432
8441
|
hotkeys: Hotkey[];
|
|
8433
8442
|
/**
|
|
8434
8443
|
* A URL for the icon to be shown in the window title bar and the taskbar.
|
|
8435
|
-
* When omitted, inherits from the parent application.
|
|
8436
|
-
*
|
|
8444
|
+
* When omitted, inherits from the parent application.
|
|
8445
|
+
*
|
|
8446
|
+
* Note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
|
8437
8447
|
*/
|
|
8438
8448
|
icon: string;
|
|
8439
8449
|
/**
|
|
@@ -10490,7 +10500,8 @@ declare type PopupOptions = {
|
|
|
10490
10500
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
10491
10501
|
/**
|
|
10492
10502
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
10493
|
-
*
|
|
10503
|
+
*
|
|
10504
|
+
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
10494
10505
|
* @defaultValue false
|
|
10495
10506
|
*/
|
|
10496
10507
|
hideOnClose?: boolean;
|
|
@@ -10505,7 +10516,8 @@ declare type PopupOptions = {
|
|
|
10505
10516
|
onPopupReady?: (popupWindow: _Window) => any;
|
|
10506
10517
|
/**
|
|
10507
10518
|
* Executed when this window's popup calls `dispatchPopupResult`.
|
|
10508
|
-
*
|
|
10519
|
+
*
|
|
10520
|
+
* Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
|
|
10509
10521
|
*/
|
|
10510
10522
|
onPopupResult?: (payload: PopupResult) => any;
|
|
10511
10523
|
};
|
|
@@ -12833,7 +12845,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12833
12845
|
showDeveloperTools(identity: Identity_2): Promise<void>;
|
|
12834
12846
|
/**
|
|
12835
12847
|
* Attempt to close an external process. The process will be terminated if it
|
|
12836
|
-
* has not closed after the elapsed timeout in milliseconds
|
|
12848
|
+
* has not closed after the elapsed timeout in milliseconds.
|
|
12849
|
+
*
|
|
12837
12850
|
* Note: This method is restricted by default and must be enabled via
|
|
12838
12851
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
12839
12852
|
* @param options A object defined in the TerminateExternalRequestType interface
|
|
@@ -12865,7 +12878,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12865
12878
|
*/
|
|
12866
12879
|
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
12867
12880
|
/**
|
|
12868
|
-
* Downloads the given application asset
|
|
12881
|
+
* Downloads the given application asset.
|
|
12882
|
+
*
|
|
12869
12883
|
* Note: This method is restricted by default and must be enabled via
|
|
12870
12884
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
12871
12885
|
* @param appAsset App asset object
|
|
@@ -15096,7 +15110,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15096
15110
|
/**
|
|
15097
15111
|
* Navigates the WebContents to a specified URL.
|
|
15098
15112
|
*
|
|
15099
|
-
*
|
|
15113
|
+
* Note: The url must contain the protocol prefix such as http:// or https://.
|
|
15100
15114
|
* @param url - The URL to navigate the WebContents to.
|
|
15101
15115
|
*
|
|
15102
15116
|
* @example
|
|
@@ -15264,7 +15278,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15264
15278
|
* Prints the WebContents.
|
|
15265
15279
|
* @param options Printer Options
|
|
15266
15280
|
*
|
|
15267
|
-
*
|
|
15281
|
+
* Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
|
|
15268
15282
|
* is empty and the default settings for printing.
|
|
15269
15283
|
*
|
|
15270
15284
|
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
@@ -15288,7 +15302,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15288
15302
|
* @param searchTerm Term to find in page
|
|
15289
15303
|
* @param options Search options
|
|
15290
15304
|
*
|
|
15291
|
-
*
|
|
15305
|
+
* Note: By default, each subsequent call will highlight the next text that matches the search term.
|
|
15292
15306
|
*
|
|
15293
15307
|
* Returns a promise with the results for the request. By subscribing to the
|
|
15294
15308
|
* found-in-page event, you can get the results of this call as well.
|
|
@@ -15478,7 +15492,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15478
15492
|
/**
|
|
15479
15493
|
* Retrieves the process information associated with a WebContents.
|
|
15480
15494
|
*
|
|
15481
|
-
*
|
|
15495
|
+
* Note: This includes any iframes associated with the WebContents
|
|
15482
15496
|
*
|
|
15483
15497
|
* @example
|
|
15484
15498
|
* View:
|
|
@@ -15648,7 +15662,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15648
15662
|
/**
|
|
15649
15663
|
* Shows a popup window.
|
|
15650
15664
|
*
|
|
15651
|
-
*
|
|
15665
|
+
* Note: If this WebContents is a view and its attached window has a popup open, this will close it.
|
|
15652
15666
|
*
|
|
15653
15667
|
* Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
|
|
15654
15668
|
* that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
|
|
@@ -15656,7 +15670,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
15656
15670
|
* open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
|
|
15657
15671
|
* will be dismissed.
|
|
15658
15672
|
*
|
|
15659
|
-
*
|
|
15673
|
+
* Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
|
|
15660
15674
|
*
|
|
15661
15675
|
* @example
|
|
15662
15676
|
*
|
package/out/mock.js
CHANGED
|
@@ -1804,7 +1804,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
1804
1804
|
/**
|
|
1805
1805
|
* Navigates the WebContents to a specified URL.
|
|
1806
1806
|
*
|
|
1807
|
-
*
|
|
1807
|
+
* Note: The url must contain the protocol prefix such as http:// or https://.
|
|
1808
1808
|
* @param url - The URL to navigate the WebContents to.
|
|
1809
1809
|
*
|
|
1810
1810
|
* @example
|
|
@@ -1987,7 +1987,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
1987
1987
|
* Prints the WebContents.
|
|
1988
1988
|
* @param options Printer Options
|
|
1989
1989
|
*
|
|
1990
|
-
*
|
|
1990
|
+
* Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
|
|
1991
1991
|
* is empty and the default settings for printing.
|
|
1992
1992
|
*
|
|
1993
1993
|
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
@@ -2013,7 +2013,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2013
2013
|
* @param searchTerm Term to find in page
|
|
2014
2014
|
* @param options Search options
|
|
2015
2015
|
*
|
|
2016
|
-
*
|
|
2016
|
+
* Note: By default, each subsequent call will highlight the next text that matches the search term.
|
|
2017
2017
|
*
|
|
2018
2018
|
* Returns a promise with the results for the request. By subscribing to the
|
|
2019
2019
|
* found-in-page event, you can get the results of this call as well.
|
|
@@ -2214,7 +2214,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2214
2214
|
/**
|
|
2215
2215
|
* Retrieves the process information associated with a WebContents.
|
|
2216
2216
|
*
|
|
2217
|
-
*
|
|
2217
|
+
* Note: This includes any iframes associated with the WebContents
|
|
2218
2218
|
*
|
|
2219
2219
|
* @example
|
|
2220
2220
|
* View:
|
|
@@ -2395,7 +2395,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2395
2395
|
/**
|
|
2396
2396
|
* Shows a popup window.
|
|
2397
2397
|
*
|
|
2398
|
-
*
|
|
2398
|
+
* Note: If this WebContents is a view and its attached window has a popup open, this will close it.
|
|
2399
2399
|
*
|
|
2400
2400
|
* Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
|
|
2401
2401
|
* that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
|
|
@@ -2403,7 +2403,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2403
2403
|
* open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
|
|
2404
2404
|
* will be dismissed.
|
|
2405
2405
|
*
|
|
2406
|
-
*
|
|
2406
|
+
* Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
|
|
2407
2407
|
*
|
|
2408
2408
|
* @example
|
|
2409
2409
|
*
|
|
@@ -3871,6 +3871,7 @@ function requireInstance$1 () {
|
|
|
3871
3871
|
/**
|
|
3872
3872
|
* Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
|
|
3873
3873
|
* If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
|
|
3874
|
+
*
|
|
3874
3875
|
* Note: If the "name" property is omitted it defaults to "tasks".
|
|
3875
3876
|
* @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
|
|
3876
3877
|
*
|
|
@@ -4171,6 +4172,7 @@ function requireInstance$1 () {
|
|
|
4171
4172
|
}
|
|
4172
4173
|
/**
|
|
4173
4174
|
* Sets file auto download location. It's only allowed in the same application.
|
|
4175
|
+
*
|
|
4174
4176
|
* Note: This method is restricted by default and must be enabled via
|
|
4175
4177
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
4176
4178
|
* @param downloadLocation file auto download location
|
|
@@ -4196,6 +4198,7 @@ function requireInstance$1 () {
|
|
|
4196
4198
|
}
|
|
4197
4199
|
/**
|
|
4198
4200
|
* Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
|
|
4201
|
+
*
|
|
4199
4202
|
* Note: This method is restricted by default and must be enabled via
|
|
4200
4203
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
4201
4204
|
*
|
|
@@ -7597,7 +7600,8 @@ class System extends base_1$j.EmitterBase {
|
|
|
7597
7600
|
}
|
|
7598
7601
|
/**
|
|
7599
7602
|
* Attempt to close an external process. The process will be terminated if it
|
|
7600
|
-
* has not closed after the elapsed timeout in milliseconds
|
|
7603
|
+
* has not closed after the elapsed timeout in milliseconds.
|
|
7604
|
+
*
|
|
7601
7605
|
* Note: This method is restricted by default and must be enabled via
|
|
7602
7606
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
7603
7607
|
* @param options A object defined in the TerminateExternalRequestType interface
|
|
@@ -7633,7 +7637,8 @@ class System extends base_1$j.EmitterBase {
|
|
|
7633
7637
|
return this.wire.sendAction('update-proxy', options).then(() => undefined);
|
|
7634
7638
|
}
|
|
7635
7639
|
/**
|
|
7636
|
-
* Downloads the given application asset
|
|
7640
|
+
* Downloads the given application asset.
|
|
7641
|
+
*
|
|
7637
7642
|
* Note: This method is restricted by default and must be enabled via
|
|
7638
7643
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
7639
7644
|
* @param appAsset App asset object
|