@openfin/core 45.100.71 → 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 +53 -5
- package/out/mock-beta.d.ts +53 -5
- package/out/mock-public.d.ts +53 -5
- package/out/stub.d.ts +53 -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
|
/**
|
|
@@ -12325,6 +12335,38 @@ declare interface PlatformProvider {
|
|
|
12325
12335
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12326
12336
|
*/
|
|
12327
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[];
|
|
12328
12370
|
/**
|
|
12329
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
|
|
12330
12372
|
*/
|
|
@@ -13135,7 +13177,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13135
13177
|
}>;
|
|
13136
13178
|
'destroy-view': IdentityCall;
|
|
13137
13179
|
'attach-view': IdentityCall<{
|
|
13138
|
-
target: OpenFin_2.Identity;
|
|
13180
|
+
target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
13139
13181
|
}>;
|
|
13140
13182
|
'set-view-bounds': IdentityCall<{
|
|
13141
13183
|
bounds: OpenFin_2.Bounds;
|
|
@@ -14932,13 +14974,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14932
14974
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14933
14975
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14934
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
|
|
14935
14978
|
* @example
|
|
14936
14979
|
* ```js
|
|
14937
14980
|
* const clearCacheOptions = {
|
|
14938
14981
|
* appcache: true,
|
|
14939
14982
|
* cache: true,
|
|
14940
14983
|
* cookies: true,
|
|
14941
|
-
* localStorage: true
|
|
14984
|
+
* localStorage: true,
|
|
14985
|
+
* windowState: true
|
|
14942
14986
|
* };
|
|
14943
14987
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14944
14988
|
* ```
|
|
@@ -14963,12 +15007,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14963
15007
|
*
|
|
14964
15008
|
* @param options - Optional configuration for what data to clear
|
|
14965
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
|
+
*
|
|
14966
15013
|
* @example
|
|
14967
15014
|
* ```js
|
|
14968
15015
|
* // Clear only cookies and localStorage for a specific origin
|
|
14969
15016
|
* await fin.System.clearCacheData({
|
|
14970
15017
|
* dataTypes: ['cookies', 'localStorage'],
|
|
14971
|
-
* origins: ['http://localhost:8081']
|
|
15018
|
+
* origins: ['http://localhost:8081'],
|
|
15019
|
+
* windowState: true
|
|
14972
15020
|
* });
|
|
14973
15021
|
*
|
|
14974
15022
|
* // Clear everything except for a specific origin
|
|
@@ -17426,7 +17474,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
17426
17474
|
* ```
|
|
17427
17475
|
* @experimental
|
|
17428
17476
|
*/
|
|
17429
|
-
attach: (target: OpenFin_2.Identity) => Promise<void>;
|
|
17477
|
+
attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
|
|
17430
17478
|
/**
|
|
17431
17479
|
* Destroys the current view
|
|
17432
17480
|
*
|
|
@@ -17850,7 +17898,7 @@ declare type ViewCreationFailure = {
|
|
|
17850
17898
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
17851
17899
|
name: string;
|
|
17852
17900
|
url: string;
|
|
17853
|
-
target: Identity_4;
|
|
17901
|
+
target: Identity_4 | LayoutIdentity;
|
|
17854
17902
|
};
|
|
17855
17903
|
|
|
17856
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
|
/**
|
|
@@ -12325,6 +12335,38 @@ declare interface PlatformProvider {
|
|
|
12325
12335
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12326
12336
|
*/
|
|
12327
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[];
|
|
12328
12370
|
/**
|
|
12329
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
|
|
12330
12372
|
*/
|
|
@@ -13135,7 +13177,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13135
13177
|
}>;
|
|
13136
13178
|
'destroy-view': IdentityCall;
|
|
13137
13179
|
'attach-view': IdentityCall<{
|
|
13138
|
-
target: OpenFin_2.Identity;
|
|
13180
|
+
target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
13139
13181
|
}>;
|
|
13140
13182
|
'set-view-bounds': IdentityCall<{
|
|
13141
13183
|
bounds: OpenFin_2.Bounds;
|
|
@@ -14932,13 +14974,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14932
14974
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14933
14975
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14934
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
|
|
14935
14978
|
* @example
|
|
14936
14979
|
* ```js
|
|
14937
14980
|
* const clearCacheOptions = {
|
|
14938
14981
|
* appcache: true,
|
|
14939
14982
|
* cache: true,
|
|
14940
14983
|
* cookies: true,
|
|
14941
|
-
* localStorage: true
|
|
14984
|
+
* localStorage: true,
|
|
14985
|
+
* windowState: true
|
|
14942
14986
|
* };
|
|
14943
14987
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14944
14988
|
* ```
|
|
@@ -14963,12 +15007,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14963
15007
|
*
|
|
14964
15008
|
* @param options - Optional configuration for what data to clear
|
|
14965
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
|
+
*
|
|
14966
15013
|
* @example
|
|
14967
15014
|
* ```js
|
|
14968
15015
|
* // Clear only cookies and localStorage for a specific origin
|
|
14969
15016
|
* await fin.System.clearCacheData({
|
|
14970
15017
|
* dataTypes: ['cookies', 'localStorage'],
|
|
14971
|
-
* origins: ['http://localhost:8081']
|
|
15018
|
+
* origins: ['http://localhost:8081'],
|
|
15019
|
+
* windowState: true
|
|
14972
15020
|
* });
|
|
14973
15021
|
*
|
|
14974
15022
|
* // Clear everything except for a specific origin
|
|
@@ -17426,7 +17474,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
17426
17474
|
* ```
|
|
17427
17475
|
* @experimental
|
|
17428
17476
|
*/
|
|
17429
|
-
attach: (target: OpenFin_2.Identity) => Promise<void>;
|
|
17477
|
+
attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
|
|
17430
17478
|
/**
|
|
17431
17479
|
* Destroys the current view
|
|
17432
17480
|
*
|
|
@@ -17850,7 +17898,7 @@ declare type ViewCreationFailure = {
|
|
|
17850
17898
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
17851
17899
|
name: string;
|
|
17852
17900
|
url: string;
|
|
17853
|
-
target: Identity_4;
|
|
17901
|
+
target: Identity_4 | LayoutIdentity;
|
|
17854
17902
|
};
|
|
17855
17903
|
|
|
17856
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
|
/**
|
|
@@ -12325,6 +12335,38 @@ declare interface PlatformProvider {
|
|
|
12325
12335
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12326
12336
|
*/
|
|
12327
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[];
|
|
12328
12370
|
/**
|
|
12329
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
|
|
12330
12372
|
*/
|
|
@@ -13135,7 +13177,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13135
13177
|
}>;
|
|
13136
13178
|
'destroy-view': IdentityCall;
|
|
13137
13179
|
'attach-view': IdentityCall<{
|
|
13138
|
-
target: OpenFin_2.Identity;
|
|
13180
|
+
target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
13139
13181
|
}>;
|
|
13140
13182
|
'set-view-bounds': IdentityCall<{
|
|
13141
13183
|
bounds: OpenFin_2.Bounds;
|
|
@@ -14932,13 +14974,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14932
14974
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14933
14975
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14934
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
|
|
14935
14978
|
* @example
|
|
14936
14979
|
* ```js
|
|
14937
14980
|
* const clearCacheOptions = {
|
|
14938
14981
|
* appcache: true,
|
|
14939
14982
|
* cache: true,
|
|
14940
14983
|
* cookies: true,
|
|
14941
|
-
* localStorage: true
|
|
14984
|
+
* localStorage: true,
|
|
14985
|
+
* windowState: true
|
|
14942
14986
|
* };
|
|
14943
14987
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14944
14988
|
* ```
|
|
@@ -14963,12 +15007,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14963
15007
|
*
|
|
14964
15008
|
* @param options - Optional configuration for what data to clear
|
|
14965
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
|
+
*
|
|
14966
15013
|
* @example
|
|
14967
15014
|
* ```js
|
|
14968
15015
|
* // Clear only cookies and localStorage for a specific origin
|
|
14969
15016
|
* await fin.System.clearCacheData({
|
|
14970
15017
|
* dataTypes: ['cookies', 'localStorage'],
|
|
14971
|
-
* origins: ['http://localhost:8081']
|
|
15018
|
+
* origins: ['http://localhost:8081'],
|
|
15019
|
+
* windowState: true
|
|
14972
15020
|
* });
|
|
14973
15021
|
*
|
|
14974
15022
|
* // Clear everything except for a specific origin
|
|
@@ -17426,7 +17474,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
17426
17474
|
* ```
|
|
17427
17475
|
* @experimental
|
|
17428
17476
|
*/
|
|
17429
|
-
attach: (target: OpenFin_2.Identity) => Promise<void>;
|
|
17477
|
+
attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
|
|
17430
17478
|
/**
|
|
17431
17479
|
* Destroys the current view
|
|
17432
17480
|
*
|
|
@@ -17850,7 +17898,7 @@ declare type ViewCreationFailure = {
|
|
|
17850
17898
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
17851
17899
|
name: string;
|
|
17852
17900
|
url: string;
|
|
17853
|
-
target: Identity_4;
|
|
17901
|
+
target: Identity_4 | LayoutIdentity;
|
|
17854
17902
|
};
|
|
17855
17903
|
|
|
17856
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
|
/**
|
|
@@ -12742,6 +12752,38 @@ declare interface PlatformProvider {
|
|
|
12742
12752
|
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12743
12753
|
*/
|
|
12744
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[];
|
|
12745
12787
|
/**
|
|
12746
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
|
|
12747
12789
|
*/
|
|
@@ -13552,7 +13594,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13552
13594
|
}>;
|
|
13553
13595
|
'destroy-view': IdentityCall;
|
|
13554
13596
|
'attach-view': IdentityCall<{
|
|
13555
|
-
target: OpenFin_2.Identity;
|
|
13597
|
+
target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
13556
13598
|
}>;
|
|
13557
13599
|
'set-view-bounds': IdentityCall<{
|
|
13558
13600
|
bounds: OpenFin_2.Bounds;
|
|
@@ -15355,13 +15397,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
15355
15397
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
15356
15398
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
15357
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
|
|
15358
15401
|
* @example
|
|
15359
15402
|
* ```js
|
|
15360
15403
|
* const clearCacheOptions = {
|
|
15361
15404
|
* appcache: true,
|
|
15362
15405
|
* cache: true,
|
|
15363
15406
|
* cookies: true,
|
|
15364
|
-
* localStorage: true
|
|
15407
|
+
* localStorage: true,
|
|
15408
|
+
* windowState: true
|
|
15365
15409
|
* };
|
|
15366
15410
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
15367
15411
|
* ```
|
|
@@ -15386,12 +15430,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
15386
15430
|
*
|
|
15387
15431
|
* @param options - Optional configuration for what data to clear
|
|
15388
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
|
+
*
|
|
15389
15436
|
* @example
|
|
15390
15437
|
* ```js
|
|
15391
15438
|
* // Clear only cookies and localStorage for a specific origin
|
|
15392
15439
|
* await fin.System.clearCacheData({
|
|
15393
15440
|
* dataTypes: ['cookies', 'localStorage'],
|
|
15394
|
-
* origins: ['http://localhost:8081']
|
|
15441
|
+
* origins: ['http://localhost:8081'],
|
|
15442
|
+
* windowState: true
|
|
15395
15443
|
* });
|
|
15396
15444
|
*
|
|
15397
15445
|
* // Clear everything except for a specific origin
|
|
@@ -17859,7 +17907,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
17859
17907
|
* ```
|
|
17860
17908
|
* @experimental
|
|
17861
17909
|
*/
|
|
17862
|
-
attach: (target: OpenFin_2.Identity) => Promise<void>;
|
|
17910
|
+
attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
|
|
17863
17911
|
/**
|
|
17864
17912
|
* Destroys the current view
|
|
17865
17913
|
*
|
|
@@ -18317,7 +18365,7 @@ declare type ViewCreationFailure = {
|
|
|
18317
18365
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
18318
18366
|
name: string;
|
|
18319
18367
|
url: string;
|
|
18320
|
-
target: Identity_4;
|
|
18368
|
+
target: Identity_4 | LayoutIdentity;
|
|
18321
18369
|
};
|
|
18322
18370
|
|
|
18323
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
|