@openfin/fdc3-api 40.100.7 → 40.102.1
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 +65 -6
- package/out/fdc3-api-beta.d.ts +65 -6
- package/out/fdc3-api-public.d.ts +65 -6
- package/out/fdc3-api.d.ts +65 -6
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -189,6 +189,10 @@ declare type AppAssetRequest = {
|
|
|
189
189
|
alias: string;
|
|
190
190
|
};
|
|
191
191
|
|
|
192
|
+
declare type AppAssetServeRequest = ServeRequest & {
|
|
193
|
+
alias: string;
|
|
194
|
+
};
|
|
195
|
+
|
|
192
196
|
/**
|
|
193
197
|
* An object representing an application. Allows the developer to create,
|
|
194
198
|
* execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
|
|
@@ -6016,6 +6020,30 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
6016
6020
|
entityType: string;
|
|
6017
6021
|
};
|
|
6018
6022
|
|
|
6023
|
+
/**
|
|
6024
|
+
* @interface
|
|
6025
|
+
* Options for the {@link Window._Window.getBounds} method.
|
|
6026
|
+
*/
|
|
6027
|
+
declare interface GetBoundsOptions {
|
|
6028
|
+
/**
|
|
6029
|
+
* Specifies the state of the window for which to retrieve the bounds.
|
|
6030
|
+
*
|
|
6031
|
+
* - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
|
|
6032
|
+
* - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
|
|
6033
|
+
*
|
|
6034
|
+
* If a window is in `normal` state, `current` and `normal` will return the same bounds.
|
|
6035
|
+
*
|
|
6036
|
+
* If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
|
|
6037
|
+
*
|
|
6038
|
+
* If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
|
|
6039
|
+
*
|
|
6040
|
+
* **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
|
|
6041
|
+
*
|
|
6042
|
+
* @default 'normal'
|
|
6043
|
+
*/
|
|
6044
|
+
boundsType?: 'normal' | 'current';
|
|
6045
|
+
}
|
|
6046
|
+
|
|
6019
6047
|
/**
|
|
6020
6048
|
* @interface
|
|
6021
6049
|
*/
|
|
@@ -7923,7 +7951,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7923
7951
|
*
|
|
7924
7952
|
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
7925
7953
|
*
|
|
7926
|
-
* ####
|
|
7954
|
+
* #### [addEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener)
|
|
7927
7955
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
7928
7956
|
* @example
|
|
7929
7957
|
* ```js
|
|
@@ -7940,7 +7968,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7940
7968
|
* });
|
|
7941
7969
|
* ```
|
|
7942
7970
|
*
|
|
7943
|
-
* ####
|
|
7971
|
+
* #### [removeEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener)
|
|
7944
7972
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
7945
7973
|
* @example
|
|
7946
7974
|
* ```js
|
|
@@ -8204,7 +8232,7 @@ declare class Layout extends Base {
|
|
|
8204
8232
|
*/
|
|
8205
8233
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8206
8234
|
/**
|
|
8207
|
-
* Adds a view to the platform layout. Behaves like @link
|
|
8235
|
+
* Adds a view to the platform layout. Behaves like {@link Platform#createView Platform.createView} with the current layout as the target.
|
|
8208
8236
|
*
|
|
8209
8237
|
* @param viewOptions - The options for creating the view.
|
|
8210
8238
|
* @param options - Optional parameters for adding the view.
|
|
@@ -8220,7 +8248,7 @@ declare class Layout extends Base {
|
|
|
8220
8248
|
}>;
|
|
8221
8249
|
/**
|
|
8222
8250
|
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8223
|
-
* Behaves like @link
|
|
8251
|
+
* Behaves like {@link Platform#closeView Platform.closeView} but only closes the view if it belongs the current layout.
|
|
8224
8252
|
*
|
|
8225
8253
|
* @param viewIdentity - The identity of the view to close.
|
|
8226
8254
|
* @returns A promise that resolves when the view is closed.
|
|
@@ -9634,6 +9662,7 @@ declare namespace OpenFin {
|
|
|
9634
9662
|
EntityType_4 as EntityType,
|
|
9635
9663
|
Bounds,
|
|
9636
9664
|
WindowBounds,
|
|
9665
|
+
GetBoundsOptions,
|
|
9637
9666
|
Rectangle,
|
|
9638
9667
|
ApplicationCreationOptions,
|
|
9639
9668
|
TimeZones,
|
|
@@ -9959,6 +9988,11 @@ declare namespace OpenFin {
|
|
|
9959
9988
|
DownloadShelfOptions,
|
|
9960
9989
|
ViewShowAtOptions,
|
|
9961
9990
|
ExtensionInfo,
|
|
9991
|
+
ServeRequest,
|
|
9992
|
+
AppAssetServeRequest,
|
|
9993
|
+
PathServeRequest,
|
|
9994
|
+
ServeAssetOptions,
|
|
9995
|
+
ServedAssetInfo,
|
|
9962
9996
|
ApplicationEvents,
|
|
9963
9997
|
BaseEvents,
|
|
9964
9998
|
ExternalApplicationEvents,
|
|
@@ -10025,6 +10059,10 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
|
|
|
10025
10059
|
title: string;
|
|
10026
10060
|
};
|
|
10027
10061
|
|
|
10062
|
+
declare type PathServeRequest = ServeRequest & {
|
|
10063
|
+
path: string;
|
|
10064
|
+
};
|
|
10065
|
+
|
|
10028
10066
|
declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10029
10067
|
success: Success;
|
|
10030
10068
|
data: Success extends true ? Data : never;
|
|
@@ -12308,7 +12346,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12308
12346
|
options: OpenFin.TransitionOptions;
|
|
12309
12347
|
}>;
|
|
12310
12348
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12311
|
-
'get-window-bounds': IdentityCall<{
|
|
12349
|
+
'get-window-bounds': IdentityCall<{
|
|
12350
|
+
options?: OpenFin.GetBoundsOptions;
|
|
12351
|
+
}, OpenFin.WindowBounds>;
|
|
12312
12352
|
'center-window': IdentityCall;
|
|
12313
12353
|
'blur-window': IdentityCall;
|
|
12314
12354
|
'bring-window-to-front': IdentityCall;
|
|
@@ -12644,6 +12684,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12644
12684
|
options: OpenFin.ProcessLoggingOptions;
|
|
12645
12685
|
}, void>;
|
|
12646
12686
|
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12687
|
+
'serve-asset': ApiCall<{
|
|
12688
|
+
options: OpenFin.ServeAssetOptions;
|
|
12689
|
+
}, OpenFin.ServedAssetInfo>;
|
|
12647
12690
|
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12648
12691
|
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12649
12692
|
}, void>;
|
|
@@ -13376,6 +13419,16 @@ declare type SentMessage<Value> = Promise<Value> & {
|
|
|
13376
13419
|
messageId: ReturnType<Environment['getNextMessageId']>;
|
|
13377
13420
|
};
|
|
13378
13421
|
|
|
13422
|
+
declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
|
|
13423
|
+
|
|
13424
|
+
declare type ServedAssetInfo = {
|
|
13425
|
+
baseUrl: string;
|
|
13426
|
+
};
|
|
13427
|
+
|
|
13428
|
+
declare type ServeRequest = {
|
|
13429
|
+
hostName: string;
|
|
13430
|
+
};
|
|
13431
|
+
|
|
13379
13432
|
/**
|
|
13380
13433
|
* @interface
|
|
13381
13434
|
*/
|
|
@@ -13673,6 +13726,7 @@ declare type Snapshot = {
|
|
|
13673
13726
|
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
13674
13727
|
topic: 'application';
|
|
13675
13728
|
type: 'platform-snapshot-applied';
|
|
13729
|
+
snapshot: Snapshot;
|
|
13676
13730
|
};
|
|
13677
13731
|
|
|
13678
13732
|
/**
|
|
@@ -15297,6 +15351,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15297
15351
|
* Gets the currently-installed
|
|
15298
15352
|
*/
|
|
15299
15353
|
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
15354
|
+
/**
|
|
15355
|
+
* Used to serve an asset signed by OpenFin within the given runtime.
|
|
15356
|
+
* Not indended for general use, will be used by the `@openfin/workspace-platform` package.
|
|
15357
|
+
*/
|
|
15358
|
+
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
15300
15359
|
}
|
|
15301
15360
|
|
|
15302
15361
|
/**
|
|
@@ -17880,7 +17939,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
17880
17939
|
* getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
|
|
17881
17940
|
* ```
|
|
17882
17941
|
*/
|
|
17883
|
-
getBounds(): Promise<OpenFin.WindowBounds>;
|
|
17942
|
+
getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
|
|
17884
17943
|
/**
|
|
17885
17944
|
* Centers the window on its current screen.
|
|
17886
17945
|
*
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -189,6 +189,10 @@ declare type AppAssetRequest = {
|
|
|
189
189
|
alias: string;
|
|
190
190
|
};
|
|
191
191
|
|
|
192
|
+
declare type AppAssetServeRequest = ServeRequest & {
|
|
193
|
+
alias: string;
|
|
194
|
+
};
|
|
195
|
+
|
|
192
196
|
/**
|
|
193
197
|
* An object representing an application. Allows the developer to create,
|
|
194
198
|
* execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
|
|
@@ -6016,6 +6020,30 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
6016
6020
|
entityType: string;
|
|
6017
6021
|
};
|
|
6018
6022
|
|
|
6023
|
+
/**
|
|
6024
|
+
* @interface
|
|
6025
|
+
* Options for the {@link Window._Window.getBounds} method.
|
|
6026
|
+
*/
|
|
6027
|
+
declare interface GetBoundsOptions {
|
|
6028
|
+
/**
|
|
6029
|
+
* Specifies the state of the window for which to retrieve the bounds.
|
|
6030
|
+
*
|
|
6031
|
+
* - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
|
|
6032
|
+
* - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
|
|
6033
|
+
*
|
|
6034
|
+
* If a window is in `normal` state, `current` and `normal` will return the same bounds.
|
|
6035
|
+
*
|
|
6036
|
+
* If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
|
|
6037
|
+
*
|
|
6038
|
+
* If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
|
|
6039
|
+
*
|
|
6040
|
+
* **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
|
|
6041
|
+
*
|
|
6042
|
+
* @default 'normal'
|
|
6043
|
+
*/
|
|
6044
|
+
boundsType?: 'normal' | 'current';
|
|
6045
|
+
}
|
|
6046
|
+
|
|
6019
6047
|
/**
|
|
6020
6048
|
* @interface
|
|
6021
6049
|
*/
|
|
@@ -7923,7 +7951,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7923
7951
|
*
|
|
7924
7952
|
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
7925
7953
|
*
|
|
7926
|
-
* ####
|
|
7954
|
+
* #### [addEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener)
|
|
7927
7955
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
7928
7956
|
* @example
|
|
7929
7957
|
* ```js
|
|
@@ -7940,7 +7968,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7940
7968
|
* });
|
|
7941
7969
|
* ```
|
|
7942
7970
|
*
|
|
7943
|
-
* ####
|
|
7971
|
+
* #### [removeEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener)
|
|
7944
7972
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
7945
7973
|
* @example
|
|
7946
7974
|
* ```js
|
|
@@ -8204,7 +8232,7 @@ declare class Layout extends Base {
|
|
|
8204
8232
|
*/
|
|
8205
8233
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8206
8234
|
/**
|
|
8207
|
-
* Adds a view to the platform layout. Behaves like @link
|
|
8235
|
+
* Adds a view to the platform layout. Behaves like {@link Platform#createView Platform.createView} with the current layout as the target.
|
|
8208
8236
|
*
|
|
8209
8237
|
* @param viewOptions - The options for creating the view.
|
|
8210
8238
|
* @param options - Optional parameters for adding the view.
|
|
@@ -8220,7 +8248,7 @@ declare class Layout extends Base {
|
|
|
8220
8248
|
}>;
|
|
8221
8249
|
/**
|
|
8222
8250
|
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8223
|
-
* Behaves like @link
|
|
8251
|
+
* Behaves like {@link Platform#closeView Platform.closeView} but only closes the view if it belongs the current layout.
|
|
8224
8252
|
*
|
|
8225
8253
|
* @param viewIdentity - The identity of the view to close.
|
|
8226
8254
|
* @returns A promise that resolves when the view is closed.
|
|
@@ -9634,6 +9662,7 @@ declare namespace OpenFin {
|
|
|
9634
9662
|
EntityType_4 as EntityType,
|
|
9635
9663
|
Bounds,
|
|
9636
9664
|
WindowBounds,
|
|
9665
|
+
GetBoundsOptions,
|
|
9637
9666
|
Rectangle,
|
|
9638
9667
|
ApplicationCreationOptions,
|
|
9639
9668
|
TimeZones,
|
|
@@ -9959,6 +9988,11 @@ declare namespace OpenFin {
|
|
|
9959
9988
|
DownloadShelfOptions,
|
|
9960
9989
|
ViewShowAtOptions,
|
|
9961
9990
|
ExtensionInfo,
|
|
9991
|
+
ServeRequest,
|
|
9992
|
+
AppAssetServeRequest,
|
|
9993
|
+
PathServeRequest,
|
|
9994
|
+
ServeAssetOptions,
|
|
9995
|
+
ServedAssetInfo,
|
|
9962
9996
|
ApplicationEvents,
|
|
9963
9997
|
BaseEvents,
|
|
9964
9998
|
ExternalApplicationEvents,
|
|
@@ -10025,6 +10059,10 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
|
|
|
10025
10059
|
title: string;
|
|
10026
10060
|
};
|
|
10027
10061
|
|
|
10062
|
+
declare type PathServeRequest = ServeRequest & {
|
|
10063
|
+
path: string;
|
|
10064
|
+
};
|
|
10065
|
+
|
|
10028
10066
|
declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10029
10067
|
success: Success;
|
|
10030
10068
|
data: Success extends true ? Data : never;
|
|
@@ -12308,7 +12346,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12308
12346
|
options: OpenFin.TransitionOptions;
|
|
12309
12347
|
}>;
|
|
12310
12348
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12311
|
-
'get-window-bounds': IdentityCall<{
|
|
12349
|
+
'get-window-bounds': IdentityCall<{
|
|
12350
|
+
options?: OpenFin.GetBoundsOptions;
|
|
12351
|
+
}, OpenFin.WindowBounds>;
|
|
12312
12352
|
'center-window': IdentityCall;
|
|
12313
12353
|
'blur-window': IdentityCall;
|
|
12314
12354
|
'bring-window-to-front': IdentityCall;
|
|
@@ -12644,6 +12684,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12644
12684
|
options: OpenFin.ProcessLoggingOptions;
|
|
12645
12685
|
}, void>;
|
|
12646
12686
|
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12687
|
+
'serve-asset': ApiCall<{
|
|
12688
|
+
options: OpenFin.ServeAssetOptions;
|
|
12689
|
+
}, OpenFin.ServedAssetInfo>;
|
|
12647
12690
|
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12648
12691
|
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12649
12692
|
}, void>;
|
|
@@ -13376,6 +13419,16 @@ declare type SentMessage<Value> = Promise<Value> & {
|
|
|
13376
13419
|
messageId: ReturnType<Environment['getNextMessageId']>;
|
|
13377
13420
|
};
|
|
13378
13421
|
|
|
13422
|
+
declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
|
|
13423
|
+
|
|
13424
|
+
declare type ServedAssetInfo = {
|
|
13425
|
+
baseUrl: string;
|
|
13426
|
+
};
|
|
13427
|
+
|
|
13428
|
+
declare type ServeRequest = {
|
|
13429
|
+
hostName: string;
|
|
13430
|
+
};
|
|
13431
|
+
|
|
13379
13432
|
/**
|
|
13380
13433
|
* @interface
|
|
13381
13434
|
*/
|
|
@@ -13673,6 +13726,7 @@ declare type Snapshot = {
|
|
|
13673
13726
|
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
13674
13727
|
topic: 'application';
|
|
13675
13728
|
type: 'platform-snapshot-applied';
|
|
13729
|
+
snapshot: Snapshot;
|
|
13676
13730
|
};
|
|
13677
13731
|
|
|
13678
13732
|
/**
|
|
@@ -15297,6 +15351,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15297
15351
|
* Gets the currently-installed
|
|
15298
15352
|
*/
|
|
15299
15353
|
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
15354
|
+
/**
|
|
15355
|
+
* Used to serve an asset signed by OpenFin within the given runtime.
|
|
15356
|
+
* Not indended for general use, will be used by the `@openfin/workspace-platform` package.
|
|
15357
|
+
*/
|
|
15358
|
+
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
15300
15359
|
}
|
|
15301
15360
|
|
|
15302
15361
|
/**
|
|
@@ -17880,7 +17939,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
17880
17939
|
* getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
|
|
17881
17940
|
* ```
|
|
17882
17941
|
*/
|
|
17883
|
-
getBounds(): Promise<OpenFin.WindowBounds>;
|
|
17942
|
+
getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
|
|
17884
17943
|
/**
|
|
17885
17944
|
* Centers the window on its current screen.
|
|
17886
17945
|
*
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -189,6 +189,10 @@ declare type AppAssetRequest = {
|
|
|
189
189
|
alias: string;
|
|
190
190
|
};
|
|
191
191
|
|
|
192
|
+
declare type AppAssetServeRequest = ServeRequest & {
|
|
193
|
+
alias: string;
|
|
194
|
+
};
|
|
195
|
+
|
|
192
196
|
/**
|
|
193
197
|
* An object representing an application. Allows the developer to create,
|
|
194
198
|
* execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
|
|
@@ -6016,6 +6020,30 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
6016
6020
|
entityType: string;
|
|
6017
6021
|
};
|
|
6018
6022
|
|
|
6023
|
+
/**
|
|
6024
|
+
* @interface
|
|
6025
|
+
* Options for the {@link Window._Window.getBounds} method.
|
|
6026
|
+
*/
|
|
6027
|
+
declare interface GetBoundsOptions {
|
|
6028
|
+
/**
|
|
6029
|
+
* Specifies the state of the window for which to retrieve the bounds.
|
|
6030
|
+
*
|
|
6031
|
+
* - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
|
|
6032
|
+
* - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
|
|
6033
|
+
*
|
|
6034
|
+
* If a window is in `normal` state, `current` and `normal` will return the same bounds.
|
|
6035
|
+
*
|
|
6036
|
+
* If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
|
|
6037
|
+
*
|
|
6038
|
+
* If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
|
|
6039
|
+
*
|
|
6040
|
+
* **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
|
|
6041
|
+
*
|
|
6042
|
+
* @default 'normal'
|
|
6043
|
+
*/
|
|
6044
|
+
boundsType?: 'normal' | 'current';
|
|
6045
|
+
}
|
|
6046
|
+
|
|
6019
6047
|
/**
|
|
6020
6048
|
* @interface
|
|
6021
6049
|
*/
|
|
@@ -7923,7 +7951,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7923
7951
|
*
|
|
7924
7952
|
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
7925
7953
|
*
|
|
7926
|
-
* ####
|
|
7954
|
+
* #### [addEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener)
|
|
7927
7955
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
7928
7956
|
* @example
|
|
7929
7957
|
* ```js
|
|
@@ -7940,7 +7968,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7940
7968
|
* });
|
|
7941
7969
|
* ```
|
|
7942
7970
|
*
|
|
7943
|
-
* ####
|
|
7971
|
+
* #### [removeEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener)
|
|
7944
7972
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
7945
7973
|
* @example
|
|
7946
7974
|
* ```js
|
|
@@ -8204,7 +8232,7 @@ declare class Layout extends Base {
|
|
|
8204
8232
|
*/
|
|
8205
8233
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8206
8234
|
/**
|
|
8207
|
-
* Adds a view to the platform layout. Behaves like @link
|
|
8235
|
+
* Adds a view to the platform layout. Behaves like {@link Platform#createView Platform.createView} with the current layout as the target.
|
|
8208
8236
|
*
|
|
8209
8237
|
* @param viewOptions - The options for creating the view.
|
|
8210
8238
|
* @param options - Optional parameters for adding the view.
|
|
@@ -8220,7 +8248,7 @@ declare class Layout extends Base {
|
|
|
8220
8248
|
}>;
|
|
8221
8249
|
/**
|
|
8222
8250
|
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8223
|
-
* Behaves like @link
|
|
8251
|
+
* Behaves like {@link Platform#closeView Platform.closeView} but only closes the view if it belongs the current layout.
|
|
8224
8252
|
*
|
|
8225
8253
|
* @param viewIdentity - The identity of the view to close.
|
|
8226
8254
|
* @returns A promise that resolves when the view is closed.
|
|
@@ -9634,6 +9662,7 @@ declare namespace OpenFin {
|
|
|
9634
9662
|
EntityType_4 as EntityType,
|
|
9635
9663
|
Bounds,
|
|
9636
9664
|
WindowBounds,
|
|
9665
|
+
GetBoundsOptions,
|
|
9637
9666
|
Rectangle,
|
|
9638
9667
|
ApplicationCreationOptions,
|
|
9639
9668
|
TimeZones,
|
|
@@ -9959,6 +9988,11 @@ declare namespace OpenFin {
|
|
|
9959
9988
|
DownloadShelfOptions,
|
|
9960
9989
|
ViewShowAtOptions,
|
|
9961
9990
|
ExtensionInfo,
|
|
9991
|
+
ServeRequest,
|
|
9992
|
+
AppAssetServeRequest,
|
|
9993
|
+
PathServeRequest,
|
|
9994
|
+
ServeAssetOptions,
|
|
9995
|
+
ServedAssetInfo,
|
|
9962
9996
|
ApplicationEvents,
|
|
9963
9997
|
BaseEvents,
|
|
9964
9998
|
ExternalApplicationEvents,
|
|
@@ -10025,6 +10059,10 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
|
|
|
10025
10059
|
title: string;
|
|
10026
10060
|
};
|
|
10027
10061
|
|
|
10062
|
+
declare type PathServeRequest = ServeRequest & {
|
|
10063
|
+
path: string;
|
|
10064
|
+
};
|
|
10065
|
+
|
|
10028
10066
|
declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10029
10067
|
success: Success;
|
|
10030
10068
|
data: Success extends true ? Data : never;
|
|
@@ -12308,7 +12346,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12308
12346
|
options: OpenFin.TransitionOptions;
|
|
12309
12347
|
}>;
|
|
12310
12348
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12311
|
-
'get-window-bounds': IdentityCall<{
|
|
12349
|
+
'get-window-bounds': IdentityCall<{
|
|
12350
|
+
options?: OpenFin.GetBoundsOptions;
|
|
12351
|
+
}, OpenFin.WindowBounds>;
|
|
12312
12352
|
'center-window': IdentityCall;
|
|
12313
12353
|
'blur-window': IdentityCall;
|
|
12314
12354
|
'bring-window-to-front': IdentityCall;
|
|
@@ -12644,6 +12684,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12644
12684
|
options: OpenFin.ProcessLoggingOptions;
|
|
12645
12685
|
}, void>;
|
|
12646
12686
|
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12687
|
+
'serve-asset': ApiCall<{
|
|
12688
|
+
options: OpenFin.ServeAssetOptions;
|
|
12689
|
+
}, OpenFin.ServedAssetInfo>;
|
|
12647
12690
|
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12648
12691
|
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12649
12692
|
}, void>;
|
|
@@ -13376,6 +13419,16 @@ declare type SentMessage<Value> = Promise<Value> & {
|
|
|
13376
13419
|
messageId: ReturnType<Environment['getNextMessageId']>;
|
|
13377
13420
|
};
|
|
13378
13421
|
|
|
13422
|
+
declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
|
|
13423
|
+
|
|
13424
|
+
declare type ServedAssetInfo = {
|
|
13425
|
+
baseUrl: string;
|
|
13426
|
+
};
|
|
13427
|
+
|
|
13428
|
+
declare type ServeRequest = {
|
|
13429
|
+
hostName: string;
|
|
13430
|
+
};
|
|
13431
|
+
|
|
13379
13432
|
/**
|
|
13380
13433
|
* @interface
|
|
13381
13434
|
*/
|
|
@@ -13673,6 +13726,7 @@ declare type Snapshot = {
|
|
|
13673
13726
|
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
13674
13727
|
topic: 'application';
|
|
13675
13728
|
type: 'platform-snapshot-applied';
|
|
13729
|
+
snapshot: Snapshot;
|
|
13676
13730
|
};
|
|
13677
13731
|
|
|
13678
13732
|
/**
|
|
@@ -15297,6 +15351,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15297
15351
|
* Gets the currently-installed
|
|
15298
15352
|
*/
|
|
15299
15353
|
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
15354
|
+
/**
|
|
15355
|
+
* Used to serve an asset signed by OpenFin within the given runtime.
|
|
15356
|
+
* Not indended for general use, will be used by the `@openfin/workspace-platform` package.
|
|
15357
|
+
*/
|
|
15358
|
+
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
15300
15359
|
}
|
|
15301
15360
|
|
|
15302
15361
|
/**
|
|
@@ -17880,7 +17939,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
17880
17939
|
* getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
|
|
17881
17940
|
* ```
|
|
17882
17941
|
*/
|
|
17883
|
-
getBounds(): Promise<OpenFin.WindowBounds>;
|
|
17942
|
+
getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
|
|
17884
17943
|
/**
|
|
17885
17944
|
* Centers the window on its current screen.
|
|
17886
17945
|
*
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -189,6 +189,10 @@ declare type AppAssetRequest = {
|
|
|
189
189
|
alias: string;
|
|
190
190
|
};
|
|
191
191
|
|
|
192
|
+
declare type AppAssetServeRequest = ServeRequest & {
|
|
193
|
+
alias: string;
|
|
194
|
+
};
|
|
195
|
+
|
|
192
196
|
/**
|
|
193
197
|
* An object representing an application. Allows the developer to create,
|
|
194
198
|
* execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
|
|
@@ -6104,6 +6108,30 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
6104
6108
|
entityType: string;
|
|
6105
6109
|
};
|
|
6106
6110
|
|
|
6111
|
+
/**
|
|
6112
|
+
* @interface
|
|
6113
|
+
* Options for the {@link Window._Window.getBounds} method.
|
|
6114
|
+
*/
|
|
6115
|
+
declare interface GetBoundsOptions {
|
|
6116
|
+
/**
|
|
6117
|
+
* Specifies the state of the window for which to retrieve the bounds.
|
|
6118
|
+
*
|
|
6119
|
+
* - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
|
|
6120
|
+
* - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
|
|
6121
|
+
*
|
|
6122
|
+
* If a window is in `normal` state, `current` and `normal` will return the same bounds.
|
|
6123
|
+
*
|
|
6124
|
+
* If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
|
|
6125
|
+
*
|
|
6126
|
+
* If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
|
|
6127
|
+
*
|
|
6128
|
+
* **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
|
|
6129
|
+
*
|
|
6130
|
+
* @default 'normal'
|
|
6131
|
+
*/
|
|
6132
|
+
boundsType?: 'normal' | 'current';
|
|
6133
|
+
}
|
|
6134
|
+
|
|
6107
6135
|
/**
|
|
6108
6136
|
* @interface
|
|
6109
6137
|
*/
|
|
@@ -8040,7 +8068,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8040
8068
|
*
|
|
8041
8069
|
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
8042
8070
|
*
|
|
8043
|
-
* ####
|
|
8071
|
+
* #### [addEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener)
|
|
8044
8072
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
8045
8073
|
* @example
|
|
8046
8074
|
* ```js
|
|
@@ -8057,7 +8085,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8057
8085
|
* });
|
|
8058
8086
|
* ```
|
|
8059
8087
|
*
|
|
8060
|
-
* ####
|
|
8088
|
+
* #### [removeEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener)
|
|
8061
8089
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
8062
8090
|
* @example
|
|
8063
8091
|
* ```js
|
|
@@ -8330,7 +8358,7 @@ declare class Layout extends Base {
|
|
|
8330
8358
|
*/
|
|
8331
8359
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8332
8360
|
/**
|
|
8333
|
-
* Adds a view to the platform layout. Behaves like @link
|
|
8361
|
+
* Adds a view to the platform layout. Behaves like {@link Platform#createView Platform.createView} with the current layout as the target.
|
|
8334
8362
|
*
|
|
8335
8363
|
* @param viewOptions - The options for creating the view.
|
|
8336
8364
|
* @param options - Optional parameters for adding the view.
|
|
@@ -8346,7 +8374,7 @@ declare class Layout extends Base {
|
|
|
8346
8374
|
}>;
|
|
8347
8375
|
/**
|
|
8348
8376
|
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8349
|
-
* Behaves like @link
|
|
8377
|
+
* Behaves like {@link Platform#closeView Platform.closeView} but only closes the view if it belongs the current layout.
|
|
8350
8378
|
*
|
|
8351
8379
|
* @param viewIdentity - The identity of the view to close.
|
|
8352
8380
|
* @returns A promise that resolves when the view is closed.
|
|
@@ -9952,6 +9980,7 @@ declare namespace OpenFin {
|
|
|
9952
9980
|
EntityType_4 as EntityType,
|
|
9953
9981
|
Bounds,
|
|
9954
9982
|
WindowBounds,
|
|
9983
|
+
GetBoundsOptions,
|
|
9955
9984
|
Rectangle,
|
|
9956
9985
|
ApplicationCreationOptions,
|
|
9957
9986
|
TimeZones,
|
|
@@ -10277,6 +10306,11 @@ declare namespace OpenFin {
|
|
|
10277
10306
|
DownloadShelfOptions,
|
|
10278
10307
|
ViewShowAtOptions,
|
|
10279
10308
|
ExtensionInfo,
|
|
10309
|
+
ServeRequest,
|
|
10310
|
+
AppAssetServeRequest,
|
|
10311
|
+
PathServeRequest,
|
|
10312
|
+
ServeAssetOptions,
|
|
10313
|
+
ServedAssetInfo,
|
|
10280
10314
|
ApplicationEvents,
|
|
10281
10315
|
BaseEvents,
|
|
10282
10316
|
ExternalApplicationEvents,
|
|
@@ -10343,6 +10377,10 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
|
|
|
10343
10377
|
title: string;
|
|
10344
10378
|
};
|
|
10345
10379
|
|
|
10380
|
+
declare type PathServeRequest = ServeRequest & {
|
|
10381
|
+
path: string;
|
|
10382
|
+
};
|
|
10383
|
+
|
|
10346
10384
|
declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10347
10385
|
success: Success;
|
|
10348
10386
|
data: Success extends true ? Data : never;
|
|
@@ -12709,7 +12747,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12709
12747
|
options: OpenFin.TransitionOptions;
|
|
12710
12748
|
}>;
|
|
12711
12749
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12712
|
-
'get-window-bounds': IdentityCall<{
|
|
12750
|
+
'get-window-bounds': IdentityCall<{
|
|
12751
|
+
options?: OpenFin.GetBoundsOptions;
|
|
12752
|
+
}, OpenFin.WindowBounds>;
|
|
12713
12753
|
'center-window': IdentityCall;
|
|
12714
12754
|
'blur-window': IdentityCall;
|
|
12715
12755
|
'bring-window-to-front': IdentityCall;
|
|
@@ -13045,6 +13085,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13045
13085
|
options: OpenFin.ProcessLoggingOptions;
|
|
13046
13086
|
}, void>;
|
|
13047
13087
|
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
13088
|
+
'serve-asset': ApiCall<{
|
|
13089
|
+
options: OpenFin.ServeAssetOptions;
|
|
13090
|
+
}, OpenFin.ServedAssetInfo>;
|
|
13048
13091
|
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
13049
13092
|
domainSettings: OpenFin.DefaultDomainSettings;
|
|
13050
13093
|
}, void>;
|
|
@@ -13777,6 +13820,16 @@ declare type SentMessage<Value> = Promise<Value> & {
|
|
|
13777
13820
|
messageId: ReturnType<Environment['getNextMessageId']>;
|
|
13778
13821
|
};
|
|
13779
13822
|
|
|
13823
|
+
declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
|
|
13824
|
+
|
|
13825
|
+
declare type ServedAssetInfo = {
|
|
13826
|
+
baseUrl: string;
|
|
13827
|
+
};
|
|
13828
|
+
|
|
13829
|
+
declare type ServeRequest = {
|
|
13830
|
+
hostName: string;
|
|
13831
|
+
};
|
|
13832
|
+
|
|
13780
13833
|
/**
|
|
13781
13834
|
* @interface
|
|
13782
13835
|
*/
|
|
@@ -14074,6 +14127,7 @@ declare type Snapshot = {
|
|
|
14074
14127
|
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
14075
14128
|
topic: 'application';
|
|
14076
14129
|
type: 'platform-snapshot-applied';
|
|
14130
|
+
snapshot: Snapshot;
|
|
14077
14131
|
};
|
|
14078
14132
|
|
|
14079
14133
|
/**
|
|
@@ -15704,6 +15758,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15704
15758
|
* Gets the currently-installed
|
|
15705
15759
|
*/
|
|
15706
15760
|
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
15761
|
+
/**
|
|
15762
|
+
* Used to serve an asset signed by OpenFin within the given runtime.
|
|
15763
|
+
* Not indended for general use, will be used by the `@openfin/workspace-platform` package.
|
|
15764
|
+
*/
|
|
15765
|
+
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
15707
15766
|
}
|
|
15708
15767
|
|
|
15709
15768
|
/**
|
|
@@ -18334,7 +18393,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
18334
18393
|
* getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
|
|
18335
18394
|
* ```
|
|
18336
18395
|
*/
|
|
18337
|
-
getBounds(): Promise<OpenFin.WindowBounds>;
|
|
18396
|
+
getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
|
|
18338
18397
|
/**
|
|
18339
18398
|
* Centers the window on its current screen.
|
|
18340
18399
|
*
|