@openfin/core 45.100.70 → 45.100.72
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 +66 -5
- package/out/mock-beta.d.ts +66 -5
- package/out/mock-public.d.ts +66 -5
- package/out/stub.d.ts +66 -5
- package/out/stub.js +8 -2
- package/package.json +1 -1
package/out/mock-alpha.d.ts
CHANGED
|
@@ -3144,6 +3144,11 @@ declare type ClearCacheOption = {
|
|
|
3144
3144
|
* browser data that can be used across sessions
|
|
3145
3145
|
*/
|
|
3146
3146
|
localStorage?: boolean;
|
|
3147
|
+
/**
|
|
3148
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3149
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3150
|
+
*/
|
|
3151
|
+
windowState?: boolean;
|
|
3147
3152
|
};
|
|
3148
3153
|
|
|
3149
3154
|
/**
|
|
@@ -3186,6 +3191,11 @@ declare type ClearDataOptions = {
|
|
|
3186
3191
|
* - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
|
|
3187
3192
|
*/
|
|
3188
3193
|
originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
|
|
3194
|
+
/**
|
|
3195
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3196
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3197
|
+
*/
|
|
3198
|
+
windowState?: boolean;
|
|
3189
3199
|
};
|
|
3190
3200
|
|
|
3191
3201
|
/**
|
|
@@ -8448,6 +8458,19 @@ declare class Layout extends Base {
|
|
|
8448
8458
|
*/
|
|
8449
8459
|
declare type LayoutAccessibilityOptions = {
|
|
8450
8460
|
viewTabOptions?: ViewTabAccessibilityOptions;
|
|
8461
|
+
/**
|
|
8462
|
+
* Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
|
|
8463
|
+
*
|
|
8464
|
+
* - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
|
|
8465
|
+
* - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
|
|
8466
|
+
* - Set to `false` to disable this shortcut.
|
|
8467
|
+
* - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
|
|
8468
|
+
* due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
|
|
8469
|
+
* tab header -> web content.
|
|
8470
|
+
*
|
|
8471
|
+
* @defaultValue 'Mod+Enter'
|
|
8472
|
+
*/
|
|
8473
|
+
focusContentHotkey?: string | false;
|
|
8451
8474
|
};
|
|
8452
8475
|
|
|
8453
8476
|
/**
|
|
@@ -12312,6 +12335,38 @@ declare interface PlatformProvider {
|
|
|
12312
12335
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12313
12336
|
*/
|
|
12314
12337
|
shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
|
|
12338
|
+
/**
|
|
12339
|
+
* Returns the platform's keyboard commands. Default implementation returns the manifest's
|
|
12340
|
+
* `platform.commands`. Override to inject additional default commands.
|
|
12341
|
+
* Called once during Platform.init; the result is cached for the lifetime
|
|
12342
|
+
* of the platform.
|
|
12343
|
+
*
|
|
12344
|
+
* @remarks
|
|
12345
|
+
* The returned commands are merged with core's built-in default commands
|
|
12346
|
+
* (unless `disableDefaultCommands` is set).
|
|
12347
|
+
* Overriders receive the raw manifest commands from `super` and can prepend
|
|
12348
|
+
* their own defaults — returned commands override default commands by command name.
|
|
12349
|
+
*
|
|
12350
|
+
* @example
|
|
12351
|
+
* ```js
|
|
12352
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
12353
|
+
* class Override extends PlatformProvider {
|
|
12354
|
+
* getKeyboardCommands() {
|
|
12355
|
+
* const manifestCommands = super.getKeyboardCommands();
|
|
12356
|
+
* const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
|
|
12357
|
+
* return [
|
|
12358
|
+
* ...myCommands,
|
|
12359
|
+
* ...manifestCommands
|
|
12360
|
+
* ];
|
|
12361
|
+
* }
|
|
12362
|
+
* }
|
|
12363
|
+
* return new Override();
|
|
12364
|
+
* }
|
|
12365
|
+
*
|
|
12366
|
+
* fin.Platform.init({ overrideCallback });
|
|
12367
|
+
* ```
|
|
12368
|
+
*/
|
|
12369
|
+
getKeyboardCommands(): OpenFin_2.ShortcutOverride[];
|
|
12315
12370
|
/**
|
|
12316
12371
|
* Method that is called every time an error occurs when processing an action in the Platform Provider. It is meant to be overriden, as a means to debug Platform applications
|
|
12317
12372
|
*/
|
|
@@ -13122,7 +13177,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13122
13177
|
}>;
|
|
13123
13178
|
'destroy-view': IdentityCall;
|
|
13124
13179
|
'attach-view': IdentityCall<{
|
|
13125
|
-
target: OpenFin_2.Identity;
|
|
13180
|
+
target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
13126
13181
|
}>;
|
|
13127
13182
|
'set-view-bounds': IdentityCall<{
|
|
13128
13183
|
bounds: OpenFin_2.Bounds;
|
|
@@ -14919,13 +14974,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14919
14974
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14920
14975
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14921
14976
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
14977
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
14922
14978
|
* @example
|
|
14923
14979
|
* ```js
|
|
14924
14980
|
* const clearCacheOptions = {
|
|
14925
14981
|
* appcache: true,
|
|
14926
14982
|
* cache: true,
|
|
14927
14983
|
* cookies: true,
|
|
14928
|
-
* localStorage: true
|
|
14984
|
+
* localStorage: true,
|
|
14985
|
+
* windowState: true
|
|
14929
14986
|
* };
|
|
14930
14987
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14931
14988
|
* ```
|
|
@@ -14950,12 +15007,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14950
15007
|
*
|
|
14951
15008
|
* @param options - Optional configuration for what data to clear
|
|
14952
15009
|
*
|
|
15010
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
15011
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
15012
|
+
*
|
|
14953
15013
|
* @example
|
|
14954
15014
|
* ```js
|
|
14955
15015
|
* // Clear only cookies and localStorage for a specific origin
|
|
14956
15016
|
* await fin.System.clearCacheData({
|
|
14957
15017
|
* dataTypes: ['cookies', 'localStorage'],
|
|
14958
|
-
* origins: ['http://localhost:8081']
|
|
15018
|
+
* origins: ['http://localhost:8081'],
|
|
15019
|
+
* windowState: true
|
|
14959
15020
|
* });
|
|
14960
15021
|
*
|
|
14961
15022
|
* // Clear everything except for a specific origin
|
|
@@ -17413,7 +17474,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
17413
17474
|
* ```
|
|
17414
17475
|
* @experimental
|
|
17415
17476
|
*/
|
|
17416
|
-
attach: (target: OpenFin_2.Identity) => Promise<void>;
|
|
17477
|
+
attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
|
|
17417
17478
|
/**
|
|
17418
17479
|
* Destroys the current view
|
|
17419
17480
|
*
|
|
@@ -17837,7 +17898,7 @@ declare type ViewCreationFailure = {
|
|
|
17837
17898
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
17838
17899
|
name: string;
|
|
17839
17900
|
url: string;
|
|
17840
|
-
target: Identity_4;
|
|
17901
|
+
target: Identity_4 | LayoutIdentity;
|
|
17841
17902
|
};
|
|
17842
17903
|
|
|
17843
17904
|
declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;
|
package/out/mock-beta.d.ts
CHANGED
|
@@ -3144,6 +3144,11 @@ declare type ClearCacheOption = {
|
|
|
3144
3144
|
* browser data that can be used across sessions
|
|
3145
3145
|
*/
|
|
3146
3146
|
localStorage?: boolean;
|
|
3147
|
+
/**
|
|
3148
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3149
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3150
|
+
*/
|
|
3151
|
+
windowState?: boolean;
|
|
3147
3152
|
};
|
|
3148
3153
|
|
|
3149
3154
|
/**
|
|
@@ -3186,6 +3191,11 @@ declare type ClearDataOptions = {
|
|
|
3186
3191
|
* - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
|
|
3187
3192
|
*/
|
|
3188
3193
|
originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
|
|
3194
|
+
/**
|
|
3195
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3196
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3197
|
+
*/
|
|
3198
|
+
windowState?: boolean;
|
|
3189
3199
|
};
|
|
3190
3200
|
|
|
3191
3201
|
/**
|
|
@@ -8448,6 +8458,19 @@ declare class Layout extends Base {
|
|
|
8448
8458
|
*/
|
|
8449
8459
|
declare type LayoutAccessibilityOptions = {
|
|
8450
8460
|
viewTabOptions?: ViewTabAccessibilityOptions;
|
|
8461
|
+
/**
|
|
8462
|
+
* Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
|
|
8463
|
+
*
|
|
8464
|
+
* - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
|
|
8465
|
+
* - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
|
|
8466
|
+
* - Set to `false` to disable this shortcut.
|
|
8467
|
+
* - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
|
|
8468
|
+
* due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
|
|
8469
|
+
* tab header -> web content.
|
|
8470
|
+
*
|
|
8471
|
+
* @defaultValue 'Mod+Enter'
|
|
8472
|
+
*/
|
|
8473
|
+
focusContentHotkey?: string | false;
|
|
8451
8474
|
};
|
|
8452
8475
|
|
|
8453
8476
|
/**
|
|
@@ -12312,6 +12335,38 @@ declare interface PlatformProvider {
|
|
|
12312
12335
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12313
12336
|
*/
|
|
12314
12337
|
shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
|
|
12338
|
+
/**
|
|
12339
|
+
* Returns the platform's keyboard commands. Default implementation returns the manifest's
|
|
12340
|
+
* `platform.commands`. Override to inject additional default commands.
|
|
12341
|
+
* Called once during Platform.init; the result is cached for the lifetime
|
|
12342
|
+
* of the platform.
|
|
12343
|
+
*
|
|
12344
|
+
* @remarks
|
|
12345
|
+
* The returned commands are merged with core's built-in default commands
|
|
12346
|
+
* (unless `disableDefaultCommands` is set).
|
|
12347
|
+
* Overriders receive the raw manifest commands from `super` and can prepend
|
|
12348
|
+
* their own defaults — returned commands override default commands by command name.
|
|
12349
|
+
*
|
|
12350
|
+
* @example
|
|
12351
|
+
* ```js
|
|
12352
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
12353
|
+
* class Override extends PlatformProvider {
|
|
12354
|
+
* getKeyboardCommands() {
|
|
12355
|
+
* const manifestCommands = super.getKeyboardCommands();
|
|
12356
|
+
* const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
|
|
12357
|
+
* return [
|
|
12358
|
+
* ...myCommands,
|
|
12359
|
+
* ...manifestCommands
|
|
12360
|
+
* ];
|
|
12361
|
+
* }
|
|
12362
|
+
* }
|
|
12363
|
+
* return new Override();
|
|
12364
|
+
* }
|
|
12365
|
+
*
|
|
12366
|
+
* fin.Platform.init({ overrideCallback });
|
|
12367
|
+
* ```
|
|
12368
|
+
*/
|
|
12369
|
+
getKeyboardCommands(): OpenFin_2.ShortcutOverride[];
|
|
12315
12370
|
/**
|
|
12316
12371
|
* Method that is called every time an error occurs when processing an action in the Platform Provider. It is meant to be overriden, as a means to debug Platform applications
|
|
12317
12372
|
*/
|
|
@@ -13122,7 +13177,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13122
13177
|
}>;
|
|
13123
13178
|
'destroy-view': IdentityCall;
|
|
13124
13179
|
'attach-view': IdentityCall<{
|
|
13125
|
-
target: OpenFin_2.Identity;
|
|
13180
|
+
target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
13126
13181
|
}>;
|
|
13127
13182
|
'set-view-bounds': IdentityCall<{
|
|
13128
13183
|
bounds: OpenFin_2.Bounds;
|
|
@@ -14919,13 +14974,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14919
14974
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14920
14975
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14921
14976
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
14977
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
14922
14978
|
* @example
|
|
14923
14979
|
* ```js
|
|
14924
14980
|
* const clearCacheOptions = {
|
|
14925
14981
|
* appcache: true,
|
|
14926
14982
|
* cache: true,
|
|
14927
14983
|
* cookies: true,
|
|
14928
|
-
* localStorage: true
|
|
14984
|
+
* localStorage: true,
|
|
14985
|
+
* windowState: true
|
|
14929
14986
|
* };
|
|
14930
14987
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14931
14988
|
* ```
|
|
@@ -14950,12 +15007,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14950
15007
|
*
|
|
14951
15008
|
* @param options - Optional configuration for what data to clear
|
|
14952
15009
|
*
|
|
15010
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
15011
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
15012
|
+
*
|
|
14953
15013
|
* @example
|
|
14954
15014
|
* ```js
|
|
14955
15015
|
* // Clear only cookies and localStorage for a specific origin
|
|
14956
15016
|
* await fin.System.clearCacheData({
|
|
14957
15017
|
* dataTypes: ['cookies', 'localStorage'],
|
|
14958
|
-
* origins: ['http://localhost:8081']
|
|
15018
|
+
* origins: ['http://localhost:8081'],
|
|
15019
|
+
* windowState: true
|
|
14959
15020
|
* });
|
|
14960
15021
|
*
|
|
14961
15022
|
* // Clear everything except for a specific origin
|
|
@@ -17413,7 +17474,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
17413
17474
|
* ```
|
|
17414
17475
|
* @experimental
|
|
17415
17476
|
*/
|
|
17416
|
-
attach: (target: OpenFin_2.Identity) => Promise<void>;
|
|
17477
|
+
attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
|
|
17417
17478
|
/**
|
|
17418
17479
|
* Destroys the current view
|
|
17419
17480
|
*
|
|
@@ -17837,7 +17898,7 @@ declare type ViewCreationFailure = {
|
|
|
17837
17898
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
17838
17899
|
name: string;
|
|
17839
17900
|
url: string;
|
|
17840
|
-
target: Identity_4;
|
|
17901
|
+
target: Identity_4 | LayoutIdentity;
|
|
17841
17902
|
};
|
|
17842
17903
|
|
|
17843
17904
|
declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;
|
package/out/mock-public.d.ts
CHANGED
|
@@ -3144,6 +3144,11 @@ declare type ClearCacheOption = {
|
|
|
3144
3144
|
* browser data that can be used across sessions
|
|
3145
3145
|
*/
|
|
3146
3146
|
localStorage?: boolean;
|
|
3147
|
+
/**
|
|
3148
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3149
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3150
|
+
*/
|
|
3151
|
+
windowState?: boolean;
|
|
3147
3152
|
};
|
|
3148
3153
|
|
|
3149
3154
|
/**
|
|
@@ -3186,6 +3191,11 @@ declare type ClearDataOptions = {
|
|
|
3186
3191
|
* - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
|
|
3187
3192
|
*/
|
|
3188
3193
|
originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
|
|
3194
|
+
/**
|
|
3195
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3196
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3197
|
+
*/
|
|
3198
|
+
windowState?: boolean;
|
|
3189
3199
|
};
|
|
3190
3200
|
|
|
3191
3201
|
/**
|
|
@@ -8448,6 +8458,19 @@ declare class Layout extends Base {
|
|
|
8448
8458
|
*/
|
|
8449
8459
|
declare type LayoutAccessibilityOptions = {
|
|
8450
8460
|
viewTabOptions?: ViewTabAccessibilityOptions;
|
|
8461
|
+
/**
|
|
8462
|
+
* Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
|
|
8463
|
+
*
|
|
8464
|
+
* - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
|
|
8465
|
+
* - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
|
|
8466
|
+
* - Set to `false` to disable this shortcut.
|
|
8467
|
+
* - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
|
|
8468
|
+
* due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
|
|
8469
|
+
* tab header -> web content.
|
|
8470
|
+
*
|
|
8471
|
+
* @defaultValue 'Mod+Enter'
|
|
8472
|
+
*/
|
|
8473
|
+
focusContentHotkey?: string | false;
|
|
8451
8474
|
};
|
|
8452
8475
|
|
|
8453
8476
|
/**
|
|
@@ -12312,6 +12335,38 @@ declare interface PlatformProvider {
|
|
|
12312
12335
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12313
12336
|
*/
|
|
12314
12337
|
shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
|
|
12338
|
+
/**
|
|
12339
|
+
* Returns the platform's keyboard commands. Default implementation returns the manifest's
|
|
12340
|
+
* `platform.commands`. Override to inject additional default commands.
|
|
12341
|
+
* Called once during Platform.init; the result is cached for the lifetime
|
|
12342
|
+
* of the platform.
|
|
12343
|
+
*
|
|
12344
|
+
* @remarks
|
|
12345
|
+
* The returned commands are merged with core's built-in default commands
|
|
12346
|
+
* (unless `disableDefaultCommands` is set).
|
|
12347
|
+
* Overriders receive the raw manifest commands from `super` and can prepend
|
|
12348
|
+
* their own defaults — returned commands override default commands by command name.
|
|
12349
|
+
*
|
|
12350
|
+
* @example
|
|
12351
|
+
* ```js
|
|
12352
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
12353
|
+
* class Override extends PlatformProvider {
|
|
12354
|
+
* getKeyboardCommands() {
|
|
12355
|
+
* const manifestCommands = super.getKeyboardCommands();
|
|
12356
|
+
* const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
|
|
12357
|
+
* return [
|
|
12358
|
+
* ...myCommands,
|
|
12359
|
+
* ...manifestCommands
|
|
12360
|
+
* ];
|
|
12361
|
+
* }
|
|
12362
|
+
* }
|
|
12363
|
+
* return new Override();
|
|
12364
|
+
* }
|
|
12365
|
+
*
|
|
12366
|
+
* fin.Platform.init({ overrideCallback });
|
|
12367
|
+
* ```
|
|
12368
|
+
*/
|
|
12369
|
+
getKeyboardCommands(): OpenFin_2.ShortcutOverride[];
|
|
12315
12370
|
/**
|
|
12316
12371
|
* Method that is called every time an error occurs when processing an action in the Platform Provider. It is meant to be overriden, as a means to debug Platform applications
|
|
12317
12372
|
*/
|
|
@@ -13122,7 +13177,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13122
13177
|
}>;
|
|
13123
13178
|
'destroy-view': IdentityCall;
|
|
13124
13179
|
'attach-view': IdentityCall<{
|
|
13125
|
-
target: OpenFin_2.Identity;
|
|
13180
|
+
target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
13126
13181
|
}>;
|
|
13127
13182
|
'set-view-bounds': IdentityCall<{
|
|
13128
13183
|
bounds: OpenFin_2.Bounds;
|
|
@@ -14919,13 +14974,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14919
14974
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14920
14975
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14921
14976
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
14977
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
14922
14978
|
* @example
|
|
14923
14979
|
* ```js
|
|
14924
14980
|
* const clearCacheOptions = {
|
|
14925
14981
|
* appcache: true,
|
|
14926
14982
|
* cache: true,
|
|
14927
14983
|
* cookies: true,
|
|
14928
|
-
* localStorage: true
|
|
14984
|
+
* localStorage: true,
|
|
14985
|
+
* windowState: true
|
|
14929
14986
|
* };
|
|
14930
14987
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14931
14988
|
* ```
|
|
@@ -14950,12 +15007,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14950
15007
|
*
|
|
14951
15008
|
* @param options - Optional configuration for what data to clear
|
|
14952
15009
|
*
|
|
15010
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
15011
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
15012
|
+
*
|
|
14953
15013
|
* @example
|
|
14954
15014
|
* ```js
|
|
14955
15015
|
* // Clear only cookies and localStorage for a specific origin
|
|
14956
15016
|
* await fin.System.clearCacheData({
|
|
14957
15017
|
* dataTypes: ['cookies', 'localStorage'],
|
|
14958
|
-
* origins: ['http://localhost:8081']
|
|
15018
|
+
* origins: ['http://localhost:8081'],
|
|
15019
|
+
* windowState: true
|
|
14959
15020
|
* });
|
|
14960
15021
|
*
|
|
14961
15022
|
* // Clear everything except for a specific origin
|
|
@@ -17413,7 +17474,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
17413
17474
|
* ```
|
|
17414
17475
|
* @experimental
|
|
17415
17476
|
*/
|
|
17416
|
-
attach: (target: OpenFin_2.Identity) => Promise<void>;
|
|
17477
|
+
attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
|
|
17417
17478
|
/**
|
|
17418
17479
|
* Destroys the current view
|
|
17419
17480
|
*
|
|
@@ -17837,7 +17898,7 @@ declare type ViewCreationFailure = {
|
|
|
17837
17898
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
17838
17899
|
name: string;
|
|
17839
17900
|
url: string;
|
|
17840
|
-
target: Identity_4;
|
|
17901
|
+
target: Identity_4 | LayoutIdentity;
|
|
17841
17902
|
};
|
|
17842
17903
|
|
|
17843
17904
|
declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;
|
package/out/stub.d.ts
CHANGED
|
@@ -3200,6 +3200,11 @@ declare type ClearCacheOption = {
|
|
|
3200
3200
|
* browser data that can be used across sessions
|
|
3201
3201
|
*/
|
|
3202
3202
|
localStorage?: boolean;
|
|
3203
|
+
/**
|
|
3204
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3205
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3206
|
+
*/
|
|
3207
|
+
windowState?: boolean;
|
|
3203
3208
|
};
|
|
3204
3209
|
|
|
3205
3210
|
/**
|
|
@@ -3242,6 +3247,11 @@ declare type ClearDataOptions = {
|
|
|
3242
3247
|
* - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
|
|
3243
3248
|
*/
|
|
3244
3249
|
originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
|
|
3250
|
+
/**
|
|
3251
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3252
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3253
|
+
*/
|
|
3254
|
+
windowState?: boolean;
|
|
3245
3255
|
};
|
|
3246
3256
|
|
|
3247
3257
|
/**
|
|
@@ -8574,6 +8584,19 @@ declare class Layout extends Base {
|
|
|
8574
8584
|
*/
|
|
8575
8585
|
declare type LayoutAccessibilityOptions = {
|
|
8576
8586
|
viewTabOptions?: ViewTabAccessibilityOptions;
|
|
8587
|
+
/**
|
|
8588
|
+
* Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
|
|
8589
|
+
*
|
|
8590
|
+
* - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
|
|
8591
|
+
* - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
|
|
8592
|
+
* - Set to `false` to disable this shortcut.
|
|
8593
|
+
* - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
|
|
8594
|
+
* due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
|
|
8595
|
+
* tab header -> web content.
|
|
8596
|
+
*
|
|
8597
|
+
* @defaultValue 'Mod+Enter'
|
|
8598
|
+
*/
|
|
8599
|
+
focusContentHotkey?: string | false;
|
|
8577
8600
|
};
|
|
8578
8601
|
|
|
8579
8602
|
/**
|
|
@@ -12729,6 +12752,38 @@ declare interface PlatformProvider {
|
|
|
12729
12752
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12730
12753
|
*/
|
|
12731
12754
|
shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
|
|
12755
|
+
/**
|
|
12756
|
+
* Returns the platform's keyboard commands. Default implementation returns the manifest's
|
|
12757
|
+
* `platform.commands`. Override to inject additional default commands.
|
|
12758
|
+
* Called once during Platform.init; the result is cached for the lifetime
|
|
12759
|
+
* of the platform.
|
|
12760
|
+
*
|
|
12761
|
+
* @remarks
|
|
12762
|
+
* The returned commands are merged with core's built-in default commands
|
|
12763
|
+
* (unless `disableDefaultCommands` is set).
|
|
12764
|
+
* Overriders receive the raw manifest commands from `super` and can prepend
|
|
12765
|
+
* their own defaults — returned commands override default commands by command name.
|
|
12766
|
+
*
|
|
12767
|
+
* @example
|
|
12768
|
+
* ```js
|
|
12769
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
12770
|
+
* class Override extends PlatformProvider {
|
|
12771
|
+
* getKeyboardCommands() {
|
|
12772
|
+
* const manifestCommands = super.getKeyboardCommands();
|
|
12773
|
+
* const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
|
|
12774
|
+
* return [
|
|
12775
|
+
* ...myCommands,
|
|
12776
|
+
* ...manifestCommands
|
|
12777
|
+
* ];
|
|
12778
|
+
* }
|
|
12779
|
+
* }
|
|
12780
|
+
* return new Override();
|
|
12781
|
+
* }
|
|
12782
|
+
*
|
|
12783
|
+
* fin.Platform.init({ overrideCallback });
|
|
12784
|
+
* ```
|
|
12785
|
+
*/
|
|
12786
|
+
getKeyboardCommands(): OpenFin_2.ShortcutOverride[];
|
|
12732
12787
|
/**
|
|
12733
12788
|
* Method that is called every time an error occurs when processing an action in the Platform Provider. It is meant to be overriden, as a means to debug Platform applications
|
|
12734
12789
|
*/
|
|
@@ -13539,7 +13594,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13539
13594
|
}>;
|
|
13540
13595
|
'destroy-view': IdentityCall;
|
|
13541
13596
|
'attach-view': IdentityCall<{
|
|
13542
|
-
target: OpenFin_2.Identity;
|
|
13597
|
+
target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
13543
13598
|
}>;
|
|
13544
13599
|
'set-view-bounds': IdentityCall<{
|
|
13545
13600
|
bounds: OpenFin_2.Bounds;
|
|
@@ -15342,13 +15397,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
15342
15397
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
15343
15398
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
15344
15399
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
15400
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
15345
15401
|
* @example
|
|
15346
15402
|
* ```js
|
|
15347
15403
|
* const clearCacheOptions = {
|
|
15348
15404
|
* appcache: true,
|
|
15349
15405
|
* cache: true,
|
|
15350
15406
|
* cookies: true,
|
|
15351
|
-
* localStorage: true
|
|
15407
|
+
* localStorage: true,
|
|
15408
|
+
* windowState: true
|
|
15352
15409
|
* };
|
|
15353
15410
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
15354
15411
|
* ```
|
|
@@ -15373,12 +15430,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
15373
15430
|
*
|
|
15374
15431
|
* @param options - Optional configuration for what data to clear
|
|
15375
15432
|
*
|
|
15433
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
15434
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
15435
|
+
*
|
|
15376
15436
|
* @example
|
|
15377
15437
|
* ```js
|
|
15378
15438
|
* // Clear only cookies and localStorage for a specific origin
|
|
15379
15439
|
* await fin.System.clearCacheData({
|
|
15380
15440
|
* dataTypes: ['cookies', 'localStorage'],
|
|
15381
|
-
* origins: ['http://localhost:8081']
|
|
15441
|
+
* origins: ['http://localhost:8081'],
|
|
15442
|
+
* windowState: true
|
|
15382
15443
|
* });
|
|
15383
15444
|
*
|
|
15384
15445
|
* // Clear everything except for a specific origin
|
|
@@ -17846,7 +17907,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
17846
17907
|
* ```
|
|
17847
17908
|
* @experimental
|
|
17848
17909
|
*/
|
|
17849
|
-
attach: (target: OpenFin_2.Identity) => Promise<void>;
|
|
17910
|
+
attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
|
|
17850
17911
|
/**
|
|
17851
17912
|
* Destroys the current view
|
|
17852
17913
|
*
|
|
@@ -18304,7 +18365,7 @@ declare type ViewCreationFailure = {
|
|
|
18304
18365
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
18305
18366
|
name: string;
|
|
18306
18367
|
url: string;
|
|
18307
|
-
target: Identity_4;
|
|
18368
|
+
target: Identity_4 | LayoutIdentity;
|
|
18308
18369
|
};
|
|
18309
18370
|
|
|
18310
18371
|
declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;
|
package/out/stub.js
CHANGED
|
@@ -5170,13 +5170,15 @@ class System extends EmitterBase {
|
|
|
5170
5170
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
5171
5171
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
5172
5172
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
5173
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
5173
5174
|
* @example
|
|
5174
5175
|
* ```js
|
|
5175
5176
|
* const clearCacheOptions = {
|
|
5176
5177
|
* appcache: true,
|
|
5177
5178
|
* cache: true,
|
|
5178
5179
|
* cookies: true,
|
|
5179
|
-
* localStorage: true
|
|
5180
|
+
* localStorage: true,
|
|
5181
|
+
* windowState: true
|
|
5180
5182
|
* };
|
|
5181
5183
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
5182
5184
|
* ```
|
|
@@ -5205,12 +5207,16 @@ class System extends EmitterBase {
|
|
|
5205
5207
|
*
|
|
5206
5208
|
* @param options - Optional configuration for what data to clear
|
|
5207
5209
|
*
|
|
5210
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
5211
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
5212
|
+
*
|
|
5208
5213
|
* @example
|
|
5209
5214
|
* ```js
|
|
5210
5215
|
* // Clear only cookies and localStorage for a specific origin
|
|
5211
5216
|
* await fin.System.clearCacheData({
|
|
5212
5217
|
* dataTypes: ['cookies', 'localStorage'],
|
|
5213
|
-
* origins: ['http://localhost:8081']
|
|
5218
|
+
* origins: ['http://localhost:8081'],
|
|
5219
|
+
* windowState: true
|
|
5214
5220
|
* });
|
|
5215
5221
|
*
|
|
5216
5222
|
* // Clear everything except for a specific origin
|