@openfin/fdc3-api 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/fdc3-api-alpha.d.ts +66 -5
- package/out/fdc3-api-beta.d.ts +66 -5
- package/out/fdc3-api-public.d.ts +66 -5
- package/out/fdc3-api.d.ts +66 -5
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -3141,6 +3141,11 @@ declare type ClearCacheOption = {
|
|
|
3141
3141
|
* browser data that can be used across sessions
|
|
3142
3142
|
*/
|
|
3143
3143
|
localStorage?: boolean;
|
|
3144
|
+
/**
|
|
3145
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3146
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3147
|
+
*/
|
|
3148
|
+
windowState?: boolean;
|
|
3144
3149
|
};
|
|
3145
3150
|
|
|
3146
3151
|
/**
|
|
@@ -3183,6 +3188,11 @@ declare type ClearDataOptions = {
|
|
|
3183
3188
|
* - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
|
|
3184
3189
|
*/
|
|
3185
3190
|
originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
|
|
3191
|
+
/**
|
|
3192
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3193
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3194
|
+
*/
|
|
3195
|
+
windowState?: boolean;
|
|
3186
3196
|
};
|
|
3187
3197
|
|
|
3188
3198
|
/**
|
|
@@ -8790,6 +8800,19 @@ declare class Layout extends Base {
|
|
|
8790
8800
|
*/
|
|
8791
8801
|
declare type LayoutAccessibilityOptions = {
|
|
8792
8802
|
viewTabOptions?: ViewTabAccessibilityOptions;
|
|
8803
|
+
/**
|
|
8804
|
+
* Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
|
|
8805
|
+
*
|
|
8806
|
+
* - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
|
|
8807
|
+
* - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
|
|
8808
|
+
* - Set to `false` to disable this shortcut.
|
|
8809
|
+
* - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
|
|
8810
|
+
* due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
|
|
8811
|
+
* tab header -> web content.
|
|
8812
|
+
*
|
|
8813
|
+
* @defaultValue 'Mod+Enter'
|
|
8814
|
+
*/
|
|
8815
|
+
focusContentHotkey?: string | false;
|
|
8793
8816
|
};
|
|
8794
8817
|
|
|
8795
8818
|
/**
|
|
@@ -12652,6 +12675,38 @@ declare interface PlatformProvider {
|
|
|
12652
12675
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12653
12676
|
*/
|
|
12654
12677
|
shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
|
|
12678
|
+
/**
|
|
12679
|
+
* Returns the platform's keyboard commands. Default implementation returns the manifest's
|
|
12680
|
+
* `platform.commands`. Override to inject additional default commands.
|
|
12681
|
+
* Called once during Platform.init; the result is cached for the lifetime
|
|
12682
|
+
* of the platform.
|
|
12683
|
+
*
|
|
12684
|
+
* @remarks
|
|
12685
|
+
* The returned commands are merged with core's built-in default commands
|
|
12686
|
+
* (unless `disableDefaultCommands` is set).
|
|
12687
|
+
* Overriders receive the raw manifest commands from `super` and can prepend
|
|
12688
|
+
* their own defaults — returned commands override default commands by command name.
|
|
12689
|
+
*
|
|
12690
|
+
* @example
|
|
12691
|
+
* ```js
|
|
12692
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
12693
|
+
* class Override extends PlatformProvider {
|
|
12694
|
+
* getKeyboardCommands() {
|
|
12695
|
+
* const manifestCommands = super.getKeyboardCommands();
|
|
12696
|
+
* const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
|
|
12697
|
+
* return [
|
|
12698
|
+
* ...myCommands,
|
|
12699
|
+
* ...manifestCommands
|
|
12700
|
+
* ];
|
|
12701
|
+
* }
|
|
12702
|
+
* }
|
|
12703
|
+
* return new Override();
|
|
12704
|
+
* }
|
|
12705
|
+
*
|
|
12706
|
+
* fin.Platform.init({ overrideCallback });
|
|
12707
|
+
* ```
|
|
12708
|
+
*/
|
|
12709
|
+
getKeyboardCommands(): OpenFin.ShortcutOverride[];
|
|
12655
12710
|
/**
|
|
12656
12711
|
* 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
|
|
12657
12712
|
*/
|
|
@@ -13462,7 +13517,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13462
13517
|
}>;
|
|
13463
13518
|
'destroy-view': IdentityCall;
|
|
13464
13519
|
'attach-view': IdentityCall<{
|
|
13465
|
-
target: OpenFin.Identity;
|
|
13520
|
+
target: OpenFin.Identity | OpenFin.LayoutIdentity;
|
|
13466
13521
|
}>;
|
|
13467
13522
|
'set-view-bounds': IdentityCall<{
|
|
13468
13523
|
bounds: OpenFin.Bounds;
|
|
@@ -15259,13 +15314,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15259
15314
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
15260
15315
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
15261
15316
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
15317
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
15262
15318
|
* @example
|
|
15263
15319
|
* ```js
|
|
15264
15320
|
* const clearCacheOptions = {
|
|
15265
15321
|
* appcache: true,
|
|
15266
15322
|
* cache: true,
|
|
15267
15323
|
* cookies: true,
|
|
15268
|
-
* localStorage: true
|
|
15324
|
+
* localStorage: true,
|
|
15325
|
+
* windowState: true
|
|
15269
15326
|
* };
|
|
15270
15327
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
15271
15328
|
* ```
|
|
@@ -15290,12 +15347,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15290
15347
|
*
|
|
15291
15348
|
* @param options - Optional configuration for what data to clear
|
|
15292
15349
|
*
|
|
15350
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
15351
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
15352
|
+
*
|
|
15293
15353
|
* @example
|
|
15294
15354
|
* ```js
|
|
15295
15355
|
* // Clear only cookies and localStorage for a specific origin
|
|
15296
15356
|
* await fin.System.clearCacheData({
|
|
15297
15357
|
* dataTypes: ['cookies', 'localStorage'],
|
|
15298
|
-
* origins: ['http://localhost:8081']
|
|
15358
|
+
* origins: ['http://localhost:8081'],
|
|
15359
|
+
* windowState: true
|
|
15299
15360
|
* });
|
|
15300
15361
|
*
|
|
15301
15362
|
* // Clear everything except for a specific origin
|
|
@@ -17859,7 +17920,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
17859
17920
|
* ```
|
|
17860
17921
|
* @experimental
|
|
17861
17922
|
*/
|
|
17862
|
-
attach: (target: OpenFin.Identity) => Promise<void>;
|
|
17923
|
+
attach: (target: OpenFin.Identity | OpenFin.LayoutIdentity) => Promise<void>;
|
|
17863
17924
|
/**
|
|
17864
17925
|
* Destroys the current view
|
|
17865
17926
|
*
|
|
@@ -18283,7 +18344,7 @@ declare type ViewCreationFailure = {
|
|
|
18283
18344
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
18284
18345
|
name: string;
|
|
18285
18346
|
url: string;
|
|
18286
|
-
target: Identity_4;
|
|
18347
|
+
target: Identity_4 | LayoutIdentity;
|
|
18287
18348
|
};
|
|
18288
18349
|
|
|
18289
18350
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -3141,6 +3141,11 @@ declare type ClearCacheOption = {
|
|
|
3141
3141
|
* browser data that can be used across sessions
|
|
3142
3142
|
*/
|
|
3143
3143
|
localStorage?: boolean;
|
|
3144
|
+
/**
|
|
3145
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3146
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3147
|
+
*/
|
|
3148
|
+
windowState?: boolean;
|
|
3144
3149
|
};
|
|
3145
3150
|
|
|
3146
3151
|
/**
|
|
@@ -3183,6 +3188,11 @@ declare type ClearDataOptions = {
|
|
|
3183
3188
|
* - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
|
|
3184
3189
|
*/
|
|
3185
3190
|
originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
|
|
3191
|
+
/**
|
|
3192
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3193
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3194
|
+
*/
|
|
3195
|
+
windowState?: boolean;
|
|
3186
3196
|
};
|
|
3187
3197
|
|
|
3188
3198
|
/**
|
|
@@ -8790,6 +8800,19 @@ declare class Layout extends Base {
|
|
|
8790
8800
|
*/
|
|
8791
8801
|
declare type LayoutAccessibilityOptions = {
|
|
8792
8802
|
viewTabOptions?: ViewTabAccessibilityOptions;
|
|
8803
|
+
/**
|
|
8804
|
+
* Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
|
|
8805
|
+
*
|
|
8806
|
+
* - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
|
|
8807
|
+
* - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
|
|
8808
|
+
* - Set to `false` to disable this shortcut.
|
|
8809
|
+
* - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
|
|
8810
|
+
* due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
|
|
8811
|
+
* tab header -> web content.
|
|
8812
|
+
*
|
|
8813
|
+
* @defaultValue 'Mod+Enter'
|
|
8814
|
+
*/
|
|
8815
|
+
focusContentHotkey?: string | false;
|
|
8793
8816
|
};
|
|
8794
8817
|
|
|
8795
8818
|
/**
|
|
@@ -12652,6 +12675,38 @@ declare interface PlatformProvider {
|
|
|
12652
12675
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12653
12676
|
*/
|
|
12654
12677
|
shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
|
|
12678
|
+
/**
|
|
12679
|
+
* Returns the platform's keyboard commands. Default implementation returns the manifest's
|
|
12680
|
+
* `platform.commands`. Override to inject additional default commands.
|
|
12681
|
+
* Called once during Platform.init; the result is cached for the lifetime
|
|
12682
|
+
* of the platform.
|
|
12683
|
+
*
|
|
12684
|
+
* @remarks
|
|
12685
|
+
* The returned commands are merged with core's built-in default commands
|
|
12686
|
+
* (unless `disableDefaultCommands` is set).
|
|
12687
|
+
* Overriders receive the raw manifest commands from `super` and can prepend
|
|
12688
|
+
* their own defaults — returned commands override default commands by command name.
|
|
12689
|
+
*
|
|
12690
|
+
* @example
|
|
12691
|
+
* ```js
|
|
12692
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
12693
|
+
* class Override extends PlatformProvider {
|
|
12694
|
+
* getKeyboardCommands() {
|
|
12695
|
+
* const manifestCommands = super.getKeyboardCommands();
|
|
12696
|
+
* const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
|
|
12697
|
+
* return [
|
|
12698
|
+
* ...myCommands,
|
|
12699
|
+
* ...manifestCommands
|
|
12700
|
+
* ];
|
|
12701
|
+
* }
|
|
12702
|
+
* }
|
|
12703
|
+
* return new Override();
|
|
12704
|
+
* }
|
|
12705
|
+
*
|
|
12706
|
+
* fin.Platform.init({ overrideCallback });
|
|
12707
|
+
* ```
|
|
12708
|
+
*/
|
|
12709
|
+
getKeyboardCommands(): OpenFin.ShortcutOverride[];
|
|
12655
12710
|
/**
|
|
12656
12711
|
* 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
|
|
12657
12712
|
*/
|
|
@@ -13462,7 +13517,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13462
13517
|
}>;
|
|
13463
13518
|
'destroy-view': IdentityCall;
|
|
13464
13519
|
'attach-view': IdentityCall<{
|
|
13465
|
-
target: OpenFin.Identity;
|
|
13520
|
+
target: OpenFin.Identity | OpenFin.LayoutIdentity;
|
|
13466
13521
|
}>;
|
|
13467
13522
|
'set-view-bounds': IdentityCall<{
|
|
13468
13523
|
bounds: OpenFin.Bounds;
|
|
@@ -15259,13 +15314,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15259
15314
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
15260
15315
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
15261
15316
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
15317
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
15262
15318
|
* @example
|
|
15263
15319
|
* ```js
|
|
15264
15320
|
* const clearCacheOptions = {
|
|
15265
15321
|
* appcache: true,
|
|
15266
15322
|
* cache: true,
|
|
15267
15323
|
* cookies: true,
|
|
15268
|
-
* localStorage: true
|
|
15324
|
+
* localStorage: true,
|
|
15325
|
+
* windowState: true
|
|
15269
15326
|
* };
|
|
15270
15327
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
15271
15328
|
* ```
|
|
@@ -15290,12 +15347,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15290
15347
|
*
|
|
15291
15348
|
* @param options - Optional configuration for what data to clear
|
|
15292
15349
|
*
|
|
15350
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
15351
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
15352
|
+
*
|
|
15293
15353
|
* @example
|
|
15294
15354
|
* ```js
|
|
15295
15355
|
* // Clear only cookies and localStorage for a specific origin
|
|
15296
15356
|
* await fin.System.clearCacheData({
|
|
15297
15357
|
* dataTypes: ['cookies', 'localStorage'],
|
|
15298
|
-
* origins: ['http://localhost:8081']
|
|
15358
|
+
* origins: ['http://localhost:8081'],
|
|
15359
|
+
* windowState: true
|
|
15299
15360
|
* });
|
|
15300
15361
|
*
|
|
15301
15362
|
* // Clear everything except for a specific origin
|
|
@@ -17859,7 +17920,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
17859
17920
|
* ```
|
|
17860
17921
|
* @experimental
|
|
17861
17922
|
*/
|
|
17862
|
-
attach: (target: OpenFin.Identity) => Promise<void>;
|
|
17923
|
+
attach: (target: OpenFin.Identity | OpenFin.LayoutIdentity) => Promise<void>;
|
|
17863
17924
|
/**
|
|
17864
17925
|
* Destroys the current view
|
|
17865
17926
|
*
|
|
@@ -18283,7 +18344,7 @@ declare type ViewCreationFailure = {
|
|
|
18283
18344
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
18284
18345
|
name: string;
|
|
18285
18346
|
url: string;
|
|
18286
|
-
target: Identity_4;
|
|
18347
|
+
target: Identity_4 | LayoutIdentity;
|
|
18287
18348
|
};
|
|
18288
18349
|
|
|
18289
18350
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -3141,6 +3141,11 @@ declare type ClearCacheOption = {
|
|
|
3141
3141
|
* browser data that can be used across sessions
|
|
3142
3142
|
*/
|
|
3143
3143
|
localStorage?: boolean;
|
|
3144
|
+
/**
|
|
3145
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3146
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3147
|
+
*/
|
|
3148
|
+
windowState?: boolean;
|
|
3144
3149
|
};
|
|
3145
3150
|
|
|
3146
3151
|
/**
|
|
@@ -3183,6 +3188,11 @@ declare type ClearDataOptions = {
|
|
|
3183
3188
|
* - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
|
|
3184
3189
|
*/
|
|
3185
3190
|
originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
|
|
3191
|
+
/**
|
|
3192
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3193
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3194
|
+
*/
|
|
3195
|
+
windowState?: boolean;
|
|
3186
3196
|
};
|
|
3187
3197
|
|
|
3188
3198
|
/**
|
|
@@ -8790,6 +8800,19 @@ declare class Layout extends Base {
|
|
|
8790
8800
|
*/
|
|
8791
8801
|
declare type LayoutAccessibilityOptions = {
|
|
8792
8802
|
viewTabOptions?: ViewTabAccessibilityOptions;
|
|
8803
|
+
/**
|
|
8804
|
+
* Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
|
|
8805
|
+
*
|
|
8806
|
+
* - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
|
|
8807
|
+
* - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
|
|
8808
|
+
* - Set to `false` to disable this shortcut.
|
|
8809
|
+
* - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
|
|
8810
|
+
* due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
|
|
8811
|
+
* tab header -> web content.
|
|
8812
|
+
*
|
|
8813
|
+
* @defaultValue 'Mod+Enter'
|
|
8814
|
+
*/
|
|
8815
|
+
focusContentHotkey?: string | false;
|
|
8793
8816
|
};
|
|
8794
8817
|
|
|
8795
8818
|
/**
|
|
@@ -12652,6 +12675,38 @@ declare interface PlatformProvider {
|
|
|
12652
12675
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12653
12676
|
*/
|
|
12654
12677
|
shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
|
|
12678
|
+
/**
|
|
12679
|
+
* Returns the platform's keyboard commands. Default implementation returns the manifest's
|
|
12680
|
+
* `platform.commands`. Override to inject additional default commands.
|
|
12681
|
+
* Called once during Platform.init; the result is cached for the lifetime
|
|
12682
|
+
* of the platform.
|
|
12683
|
+
*
|
|
12684
|
+
* @remarks
|
|
12685
|
+
* The returned commands are merged with core's built-in default commands
|
|
12686
|
+
* (unless `disableDefaultCommands` is set).
|
|
12687
|
+
* Overriders receive the raw manifest commands from `super` and can prepend
|
|
12688
|
+
* their own defaults — returned commands override default commands by command name.
|
|
12689
|
+
*
|
|
12690
|
+
* @example
|
|
12691
|
+
* ```js
|
|
12692
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
12693
|
+
* class Override extends PlatformProvider {
|
|
12694
|
+
* getKeyboardCommands() {
|
|
12695
|
+
* const manifestCommands = super.getKeyboardCommands();
|
|
12696
|
+
* const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
|
|
12697
|
+
* return [
|
|
12698
|
+
* ...myCommands,
|
|
12699
|
+
* ...manifestCommands
|
|
12700
|
+
* ];
|
|
12701
|
+
* }
|
|
12702
|
+
* }
|
|
12703
|
+
* return new Override();
|
|
12704
|
+
* }
|
|
12705
|
+
*
|
|
12706
|
+
* fin.Platform.init({ overrideCallback });
|
|
12707
|
+
* ```
|
|
12708
|
+
*/
|
|
12709
|
+
getKeyboardCommands(): OpenFin.ShortcutOverride[];
|
|
12655
12710
|
/**
|
|
12656
12711
|
* 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
|
|
12657
12712
|
*/
|
|
@@ -13462,7 +13517,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13462
13517
|
}>;
|
|
13463
13518
|
'destroy-view': IdentityCall;
|
|
13464
13519
|
'attach-view': IdentityCall<{
|
|
13465
|
-
target: OpenFin.Identity;
|
|
13520
|
+
target: OpenFin.Identity | OpenFin.LayoutIdentity;
|
|
13466
13521
|
}>;
|
|
13467
13522
|
'set-view-bounds': IdentityCall<{
|
|
13468
13523
|
bounds: OpenFin.Bounds;
|
|
@@ -15259,13 +15314,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15259
15314
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
15260
15315
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
15261
15316
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
15317
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
15262
15318
|
* @example
|
|
15263
15319
|
* ```js
|
|
15264
15320
|
* const clearCacheOptions = {
|
|
15265
15321
|
* appcache: true,
|
|
15266
15322
|
* cache: true,
|
|
15267
15323
|
* cookies: true,
|
|
15268
|
-
* localStorage: true
|
|
15324
|
+
* localStorage: true,
|
|
15325
|
+
* windowState: true
|
|
15269
15326
|
* };
|
|
15270
15327
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
15271
15328
|
* ```
|
|
@@ -15290,12 +15347,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15290
15347
|
*
|
|
15291
15348
|
* @param options - Optional configuration for what data to clear
|
|
15292
15349
|
*
|
|
15350
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
15351
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
15352
|
+
*
|
|
15293
15353
|
* @example
|
|
15294
15354
|
* ```js
|
|
15295
15355
|
* // Clear only cookies and localStorage for a specific origin
|
|
15296
15356
|
* await fin.System.clearCacheData({
|
|
15297
15357
|
* dataTypes: ['cookies', 'localStorage'],
|
|
15298
|
-
* origins: ['http://localhost:8081']
|
|
15358
|
+
* origins: ['http://localhost:8081'],
|
|
15359
|
+
* windowState: true
|
|
15299
15360
|
* });
|
|
15300
15361
|
*
|
|
15301
15362
|
* // Clear everything except for a specific origin
|
|
@@ -17859,7 +17920,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
17859
17920
|
* ```
|
|
17860
17921
|
* @experimental
|
|
17861
17922
|
*/
|
|
17862
|
-
attach: (target: OpenFin.Identity) => Promise<void>;
|
|
17923
|
+
attach: (target: OpenFin.Identity | OpenFin.LayoutIdentity) => Promise<void>;
|
|
17863
17924
|
/**
|
|
17864
17925
|
* Destroys the current view
|
|
17865
17926
|
*
|
|
@@ -18283,7 +18344,7 @@ declare type ViewCreationFailure = {
|
|
|
18283
18344
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
18284
18345
|
name: string;
|
|
18285
18346
|
url: string;
|
|
18286
|
-
target: Identity_4;
|
|
18347
|
+
target: Identity_4 | LayoutIdentity;
|
|
18287
18348
|
};
|
|
18288
18349
|
|
|
18289
18350
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -3197,6 +3197,11 @@ declare type ClearCacheOption = {
|
|
|
3197
3197
|
* browser data that can be used across sessions
|
|
3198
3198
|
*/
|
|
3199
3199
|
localStorage?: boolean;
|
|
3200
|
+
/**
|
|
3201
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3202
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3203
|
+
*/
|
|
3204
|
+
windowState?: boolean;
|
|
3200
3205
|
};
|
|
3201
3206
|
|
|
3202
3207
|
/**
|
|
@@ -3239,6 +3244,11 @@ declare type ClearDataOptions = {
|
|
|
3239
3244
|
* - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
|
|
3240
3245
|
*/
|
|
3241
3246
|
originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
|
|
3247
|
+
/**
|
|
3248
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3249
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3250
|
+
*/
|
|
3251
|
+
windowState?: boolean;
|
|
3242
3252
|
};
|
|
3243
3253
|
|
|
3244
3254
|
/**
|
|
@@ -8916,6 +8926,19 @@ declare class Layout extends Base {
|
|
|
8916
8926
|
*/
|
|
8917
8927
|
declare type LayoutAccessibilityOptions = {
|
|
8918
8928
|
viewTabOptions?: ViewTabAccessibilityOptions;
|
|
8929
|
+
/**
|
|
8930
|
+
* Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
|
|
8931
|
+
*
|
|
8932
|
+
* - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
|
|
8933
|
+
* - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
|
|
8934
|
+
* - Set to `false` to disable this shortcut.
|
|
8935
|
+
* - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
|
|
8936
|
+
* due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
|
|
8937
|
+
* tab header -> web content.
|
|
8938
|
+
*
|
|
8939
|
+
* @defaultValue 'Mod+Enter'
|
|
8940
|
+
*/
|
|
8941
|
+
focusContentHotkey?: string | false;
|
|
8919
8942
|
};
|
|
8920
8943
|
|
|
8921
8944
|
/**
|
|
@@ -13069,6 +13092,38 @@ declare interface PlatformProvider {
|
|
|
13069
13092
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
13070
13093
|
*/
|
|
13071
13094
|
shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
|
|
13095
|
+
/**
|
|
13096
|
+
* Returns the platform's keyboard commands. Default implementation returns the manifest's
|
|
13097
|
+
* `platform.commands`. Override to inject additional default commands.
|
|
13098
|
+
* Called once during Platform.init; the result is cached for the lifetime
|
|
13099
|
+
* of the platform.
|
|
13100
|
+
*
|
|
13101
|
+
* @remarks
|
|
13102
|
+
* The returned commands are merged with core's built-in default commands
|
|
13103
|
+
* (unless `disableDefaultCommands` is set).
|
|
13104
|
+
* Overriders receive the raw manifest commands from `super` and can prepend
|
|
13105
|
+
* their own defaults — returned commands override default commands by command name.
|
|
13106
|
+
*
|
|
13107
|
+
* @example
|
|
13108
|
+
* ```js
|
|
13109
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
13110
|
+
* class Override extends PlatformProvider {
|
|
13111
|
+
* getKeyboardCommands() {
|
|
13112
|
+
* const manifestCommands = super.getKeyboardCommands();
|
|
13113
|
+
* const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
|
|
13114
|
+
* return [
|
|
13115
|
+
* ...myCommands,
|
|
13116
|
+
* ...manifestCommands
|
|
13117
|
+
* ];
|
|
13118
|
+
* }
|
|
13119
|
+
* }
|
|
13120
|
+
* return new Override();
|
|
13121
|
+
* }
|
|
13122
|
+
*
|
|
13123
|
+
* fin.Platform.init({ overrideCallback });
|
|
13124
|
+
* ```
|
|
13125
|
+
*/
|
|
13126
|
+
getKeyboardCommands(): OpenFin.ShortcutOverride[];
|
|
13072
13127
|
/**
|
|
13073
13128
|
* 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
|
|
13074
13129
|
*/
|
|
@@ -13879,7 +13934,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13879
13934
|
}>;
|
|
13880
13935
|
'destroy-view': IdentityCall;
|
|
13881
13936
|
'attach-view': IdentityCall<{
|
|
13882
|
-
target: OpenFin.Identity;
|
|
13937
|
+
target: OpenFin.Identity | OpenFin.LayoutIdentity;
|
|
13883
13938
|
}>;
|
|
13884
13939
|
'set-view-bounds': IdentityCall<{
|
|
13885
13940
|
bounds: OpenFin.Bounds;
|
|
@@ -15682,13 +15737,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15682
15737
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
15683
15738
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
15684
15739
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
15740
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
15685
15741
|
* @example
|
|
15686
15742
|
* ```js
|
|
15687
15743
|
* const clearCacheOptions = {
|
|
15688
15744
|
* appcache: true,
|
|
15689
15745
|
* cache: true,
|
|
15690
15746
|
* cookies: true,
|
|
15691
|
-
* localStorage: true
|
|
15747
|
+
* localStorage: true,
|
|
15748
|
+
* windowState: true
|
|
15692
15749
|
* };
|
|
15693
15750
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
15694
15751
|
* ```
|
|
@@ -15713,12 +15770,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15713
15770
|
*
|
|
15714
15771
|
* @param options - Optional configuration for what data to clear
|
|
15715
15772
|
*
|
|
15773
|
+
* @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
|
|
15774
|
+
* After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
|
|
15775
|
+
*
|
|
15716
15776
|
* @example
|
|
15717
15777
|
* ```js
|
|
15718
15778
|
* // Clear only cookies and localStorage for a specific origin
|
|
15719
15779
|
* await fin.System.clearCacheData({
|
|
15720
15780
|
* dataTypes: ['cookies', 'localStorage'],
|
|
15721
|
-
* origins: ['http://localhost:8081']
|
|
15781
|
+
* origins: ['http://localhost:8081'],
|
|
15782
|
+
* windowState: true
|
|
15722
15783
|
* });
|
|
15723
15784
|
*
|
|
15724
15785
|
* // Clear everything except for a specific origin
|
|
@@ -18292,7 +18353,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
18292
18353
|
* ```
|
|
18293
18354
|
* @experimental
|
|
18294
18355
|
*/
|
|
18295
|
-
attach: (target: OpenFin.Identity) => Promise<void>;
|
|
18356
|
+
attach: (target: OpenFin.Identity | OpenFin.LayoutIdentity) => Promise<void>;
|
|
18296
18357
|
/**
|
|
18297
18358
|
* Destroys the current view
|
|
18298
18359
|
*
|
|
@@ -18750,7 +18811,7 @@ declare type ViewCreationFailure = {
|
|
|
18750
18811
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
18751
18812
|
name: string;
|
|
18752
18813
|
url: string;
|
|
18753
|
-
target: Identity_4;
|
|
18814
|
+
target: Identity_4 | LayoutIdentity;
|
|
18754
18815
|
};
|
|
18755
18816
|
|
|
18756
18817
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|