@openfin/fdc3-api 39.83.3 → 39.83.5
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 +791 -224
- package/out/fdc3-api-beta.d.ts +791 -224
- package/out/fdc3-api-public.d.ts +791 -224
- package/out/fdc3-api.d.ts +794 -224
- package/out/fdc3-api.js +39 -7
- package/package.json +1 -1
package/out/fdc3-api.d.ts
CHANGED
|
@@ -58,7 +58,7 @@ declare type AddedToLayoutEvent = BaseEvent_4 & {
|
|
|
58
58
|
*/
|
|
59
59
|
declare type AddViewOptions = CreateViewTarget & {
|
|
60
60
|
options: ViewState;
|
|
61
|
-
targetView?:
|
|
61
|
+
targetView?: Identity_4;
|
|
62
62
|
};
|
|
63
63
|
|
|
64
64
|
/**
|
|
@@ -936,15 +936,15 @@ declare namespace ApplicationEvents {
|
|
|
936
936
|
*/
|
|
937
937
|
declare type ApplicationEventType = EventType_3;
|
|
938
938
|
|
|
939
|
-
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
|
940
|
-
|
|
941
939
|
/**
|
|
942
940
|
* @interface
|
|
943
941
|
*/
|
|
944
|
-
declare type
|
|
942
|
+
declare type ApplicationIdentity = {
|
|
945
943
|
uuid: string;
|
|
946
944
|
};
|
|
947
945
|
|
|
946
|
+
declare type ApplicationIdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.ApplicationIdentity, Response>;
|
|
947
|
+
|
|
948
948
|
/**
|
|
949
949
|
* @interface
|
|
950
950
|
*/
|
|
@@ -1317,12 +1317,10 @@ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedE
|
|
|
1317
1317
|
*/
|
|
1318
1318
|
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1319
1319
|
|
|
1320
|
-
declare type ApplicationState = OpenFin.ApplicationState;
|
|
1321
|
-
|
|
1322
1320
|
/**
|
|
1323
1321
|
* @interface
|
|
1324
1322
|
*/
|
|
1325
|
-
declare type
|
|
1323
|
+
declare type ApplicationState = {
|
|
1326
1324
|
/**
|
|
1327
1325
|
* True when the application is a Platform controller
|
|
1328
1326
|
*/
|
|
@@ -1354,12 +1352,10 @@ declare type ApplicationType = {
|
|
|
1354
1352
|
*/
|
|
1355
1353
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
|
1356
1354
|
|
|
1357
|
-
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
|
1358
|
-
|
|
1359
1355
|
/**
|
|
1360
1356
|
* @interface
|
|
1361
1357
|
*/
|
|
1362
|
-
declare type
|
|
1358
|
+
declare type ApplicationWindowInfo = {
|
|
1363
1359
|
childWindows: Array<WindowDetail>;
|
|
1364
1360
|
mainWindow: WindowDetail;
|
|
1365
1361
|
/**
|
|
@@ -1635,7 +1631,7 @@ declare class Base {
|
|
|
1635
1631
|
* @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
|
|
1636
1632
|
* guaranteed to behave sensibly in all calling contexts.
|
|
1637
1633
|
*/
|
|
1638
|
-
get me(): Identity;
|
|
1634
|
+
get me(): OpenFin.Identity;
|
|
1639
1635
|
/**
|
|
1640
1636
|
* @internal
|
|
1641
1637
|
* @deprecated
|
|
@@ -1867,11 +1863,12 @@ declare type BeforeUnloadUserDecision = {
|
|
|
1867
1863
|
/**
|
|
1868
1864
|
* Array of views that will close.
|
|
1869
1865
|
*/
|
|
1870
|
-
viewsToClose:
|
|
1866
|
+
viewsToClose: Identity_4[];
|
|
1871
1867
|
};
|
|
1872
1868
|
|
|
1873
1869
|
/**
|
|
1874
1870
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
|
1871
|
+
*
|
|
1875
1872
|
* @interface
|
|
1876
1873
|
*/
|
|
1877
1874
|
declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
@@ -1912,31 +1909,33 @@ declare type Bounds = {
|
|
|
1912
1909
|
* Generated after changes in a window's size and/or position.
|
|
1913
1910
|
* @interface
|
|
1914
1911
|
*/
|
|
1915
|
-
declare type BoundsChangedEvent =
|
|
1912
|
+
declare type BoundsChangedEvent = BoundsDidChangeEvent & {
|
|
1916
1913
|
type: 'bounds-changed';
|
|
1917
1914
|
};
|
|
1918
1915
|
|
|
1919
|
-
|
|
1920
|
-
* A general bounds change event without event type.
|
|
1921
|
-
* @interface
|
|
1922
|
-
*/
|
|
1923
|
-
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1916
|
+
declare type BoundsChangeEvent = BoundsEvent & {
|
|
1924
1917
|
changeType: 0 | 1 | 2;
|
|
1925
|
-
deferred: boolean;
|
|
1926
|
-
height: number;
|
|
1927
|
-
left: number;
|
|
1928
|
-
top: number;
|
|
1929
|
-
width: number;
|
|
1930
1918
|
};
|
|
1931
1919
|
|
|
1932
1920
|
/**
|
|
1933
1921
|
* Generated during changes to a window's size and/or position.
|
|
1934
1922
|
* @interface
|
|
1935
1923
|
*/
|
|
1936
|
-
declare type BoundsChangingEvent =
|
|
1924
|
+
declare type BoundsChangingEvent = BoundsDidChangeEvent & {
|
|
1937
1925
|
type: 'bounds-changing';
|
|
1938
1926
|
};
|
|
1939
1927
|
|
|
1928
|
+
/**
|
|
1929
|
+
* An event that fires when a window's bounds are successfully changed.
|
|
1930
|
+
*
|
|
1931
|
+
* @interface
|
|
1932
|
+
*/
|
|
1933
|
+
declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
1934
|
+
reason: 'self' | 'animation';
|
|
1935
|
+
};
|
|
1936
|
+
|
|
1937
|
+
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1938
|
+
|
|
1940
1939
|
/**
|
|
1941
1940
|
* A rule prescribing content creation in the browser.
|
|
1942
1941
|
*
|
|
@@ -3042,7 +3041,7 @@ declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
|
3042
3041
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
3043
3042
|
* @interface
|
|
3044
3043
|
*/
|
|
3045
|
-
declare type ClientIdentity =
|
|
3044
|
+
declare type ClientIdentity = Identity_4 & {
|
|
3046
3045
|
/**
|
|
3047
3046
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
|
3048
3047
|
*/
|
|
@@ -3275,7 +3274,7 @@ declare type CloseViewOptions = {
|
|
|
3275
3274
|
/**
|
|
3276
3275
|
*View to be closed.
|
|
3277
3276
|
*/
|
|
3278
|
-
viewIdentity:
|
|
3277
|
+
viewIdentity: Identity_4;
|
|
3279
3278
|
};
|
|
3280
3279
|
|
|
3281
3280
|
/**
|
|
@@ -3285,7 +3284,7 @@ declare type CloseViewPayload = {
|
|
|
3285
3284
|
/**
|
|
3286
3285
|
*View to be closed.
|
|
3287
3286
|
*/
|
|
3288
|
-
view:
|
|
3287
|
+
view: Identity_4;
|
|
3289
3288
|
/**
|
|
3290
3289
|
* The target layout identity where this view should be closed. If not provided, will resolve to the
|
|
3291
3290
|
* visible layout.
|
|
@@ -3303,7 +3302,7 @@ declare interface CloseWindowPayload {
|
|
|
3303
3302
|
*
|
|
3304
3303
|
* Identity of the Window
|
|
3305
3304
|
*/
|
|
3306
|
-
windowId:
|
|
3305
|
+
windowId: Identity_4;
|
|
3307
3306
|
options: {
|
|
3308
3307
|
/**
|
|
3309
3308
|
* @defaultValue false
|
|
@@ -3424,7 +3423,7 @@ declare type ConstViewOptions = {
|
|
|
3424
3423
|
/**
|
|
3425
3424
|
* The identity of the window this view should be attached to.
|
|
3426
3425
|
*/
|
|
3427
|
-
target:
|
|
3426
|
+
target: Identity_4;
|
|
3428
3427
|
/**
|
|
3429
3428
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3430
3429
|
*/
|
|
@@ -3649,7 +3648,7 @@ declare type ConstWindowOptions = {
|
|
|
3649
3648
|
/**
|
|
3650
3649
|
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
3651
3650
|
*/
|
|
3652
|
-
modalParentIdentity:
|
|
3651
|
+
modalParentIdentity: Identity_4;
|
|
3653
3652
|
/**
|
|
3654
3653
|
* The name of the window.
|
|
3655
3654
|
*/
|
|
@@ -3667,7 +3666,9 @@ declare type ConstWindowOptions = {
|
|
|
3667
3666
|
*/
|
|
3668
3667
|
preloadScripts: PreloadScript[];
|
|
3669
3668
|
/**
|
|
3670
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
3669
|
+
* String tag that attempts to group like-tagged renderers together.
|
|
3670
|
+
* However, there is no guarantee that a different affinity value will create a different process, under the hood Chromium can enforce its own process management under certain circumstances.
|
|
3671
|
+
* @remarks Will only be used if pages are on the same origin.
|
|
3671
3672
|
*/
|
|
3672
3673
|
processAffinity: string;
|
|
3673
3674
|
/**
|
|
@@ -3714,11 +3715,6 @@ declare type ConstWindowOptions = {
|
|
|
3714
3715
|
* @deprecated - use `icon` instead.
|
|
3715
3716
|
*/
|
|
3716
3717
|
taskbarIcon: string;
|
|
3717
|
-
/**
|
|
3718
|
-
* Specify a taskbar group for the window.
|
|
3719
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
3720
|
-
*/
|
|
3721
|
-
taskbarIconGroup: string;
|
|
3722
3718
|
/**
|
|
3723
3719
|
* @defaultValue "about:blank"
|
|
3724
3720
|
*
|
|
@@ -4133,13 +4129,13 @@ declare type CreateViewPayload = {
|
|
|
4133
4129
|
* Window the view will be added to. If no target is provided, a new window will be created.
|
|
4134
4130
|
*/
|
|
4135
4131
|
target?: CreateViewTarget;
|
|
4136
|
-
targetView?:
|
|
4132
|
+
targetView?: Identity_4;
|
|
4137
4133
|
};
|
|
4138
4134
|
|
|
4139
4135
|
/**
|
|
4140
4136
|
* @interface
|
|
4141
4137
|
*/
|
|
4142
|
-
declare type CreateViewTarget = (
|
|
4138
|
+
declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
|
|
4143
4139
|
/**
|
|
4144
4140
|
* If specified, view creation will not attach to a window and caller must
|
|
4145
4141
|
* insert the view into the layout explicitly
|
|
@@ -4585,7 +4581,7 @@ declare type EmitterAccessor = string[];
|
|
|
4585
4581
|
declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType extends EmitterEvent['type'] = EmitterEvent['type']> extends Base {
|
|
4586
4582
|
#private;
|
|
4587
4583
|
private topic;
|
|
4588
|
-
protected identity: ApplicationIdentity;
|
|
4584
|
+
protected identity: OpenFin.ApplicationIdentity;
|
|
4589
4585
|
constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
|
|
4590
4586
|
eventNames: () => (string | symbol)[];
|
|
4591
4587
|
/**
|
|
@@ -4665,20 +4661,17 @@ declare type EndLoadEvent = BaseEvent_5 & {
|
|
|
4665
4661
|
|
|
4666
4662
|
/**
|
|
4667
4663
|
* Generated at the end of a user-driven change to a window's size or position.
|
|
4664
|
+
*
|
|
4668
4665
|
* @interface
|
|
4669
4666
|
*/
|
|
4670
4667
|
declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
4671
4668
|
type: 'end-user-bounds-changing';
|
|
4672
4669
|
};
|
|
4673
4670
|
|
|
4674
|
-
declare type Entity = OpenFin.ApplicationType;
|
|
4675
|
-
|
|
4676
|
-
declare type EntityInfo = OpenFin.EntityInfo;
|
|
4677
|
-
|
|
4678
4671
|
/**
|
|
4679
4672
|
* @interface
|
|
4680
4673
|
*/
|
|
4681
|
-
declare type
|
|
4674
|
+
declare type EntityInfo = {
|
|
4682
4675
|
uuid: string;
|
|
4683
4676
|
name: string;
|
|
4684
4677
|
entityType: EntityType_4;
|
|
@@ -4764,6 +4757,7 @@ declare interface Environment {
|
|
|
4764
4757
|
getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
|
|
4765
4758
|
fdc3Version?: Version;
|
|
4766
4759
|
}>;
|
|
4760
|
+
getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
|
|
4767
4761
|
readonly type: EnvironmentType;
|
|
4768
4762
|
}
|
|
4769
4763
|
|
|
@@ -5048,7 +5042,7 @@ declare type ExternalApplicationEventType = EventType_4;
|
|
|
5048
5042
|
* @interface
|
|
5049
5043
|
*/
|
|
5050
5044
|
declare type ExternalApplicationInfo = {
|
|
5051
|
-
parent:
|
|
5045
|
+
parent: Identity_4;
|
|
5052
5046
|
};
|
|
5053
5047
|
|
|
5054
5048
|
/**
|
|
@@ -5856,7 +5850,7 @@ declare type FrameInfo = {
|
|
|
5856
5850
|
uuid: string;
|
|
5857
5851
|
url: string;
|
|
5858
5852
|
entityType: EntityType_4;
|
|
5859
|
-
parent:
|
|
5853
|
+
parent: Identity_4;
|
|
5860
5854
|
};
|
|
5861
5855
|
|
|
5862
5856
|
/**
|
|
@@ -5931,12 +5925,10 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
5931
5925
|
entityType: string;
|
|
5932
5926
|
};
|
|
5933
5927
|
|
|
5934
|
-
declare type GetLogRequestType = OpenFin.GetLogRequestType;
|
|
5935
|
-
|
|
5936
5928
|
/**
|
|
5937
5929
|
* @interface
|
|
5938
5930
|
*/
|
|
5939
|
-
declare type
|
|
5931
|
+
declare type GetLogRequestType = {
|
|
5940
5932
|
/**
|
|
5941
5933
|
* The name of the running application
|
|
5942
5934
|
*/
|
|
@@ -5956,7 +5948,7 @@ declare type GetWindowContextPayload = {
|
|
|
5956
5948
|
/**
|
|
5957
5949
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
5958
5950
|
*/
|
|
5959
|
-
target:
|
|
5951
|
+
target: Identity_4;
|
|
5960
5952
|
};
|
|
5961
5953
|
|
|
5962
5954
|
/**
|
|
@@ -6225,8 +6217,6 @@ declare type Identity_2 = OpenFin.Identity;
|
|
|
6225
6217
|
|
|
6226
6218
|
declare type Identity_3 = OpenFin.Identity;
|
|
6227
6219
|
|
|
6228
|
-
declare type Identity_4 = OpenFin.Identity;
|
|
6229
|
-
|
|
6230
6220
|
/**
|
|
6231
6221
|
* Unique identifier for a window, view or iframe.
|
|
6232
6222
|
*
|
|
@@ -6235,7 +6225,7 @@ declare type Identity_4 = OpenFin.Identity;
|
|
|
6235
6225
|
*
|
|
6236
6226
|
* @interface
|
|
6237
6227
|
*/
|
|
6238
|
-
declare type
|
|
6228
|
+
declare type Identity_4 = {
|
|
6239
6229
|
/**
|
|
6240
6230
|
* Universally unique identifier of the application that owns the component.
|
|
6241
6231
|
*/
|
|
@@ -6397,12 +6387,10 @@ declare type InstallationInfo = {
|
|
|
6397
6387
|
cachedManifest: any;
|
|
6398
6388
|
};
|
|
6399
6389
|
|
|
6400
|
-
declare type InstalledApps = OpenFin.InstalledApps;
|
|
6401
|
-
|
|
6402
6390
|
/**
|
|
6403
6391
|
* @interface
|
|
6404
6392
|
*/
|
|
6405
|
-
declare type
|
|
6393
|
+
declare type InstalledApps = {
|
|
6406
6394
|
[key: string]: InstallationInfo;
|
|
6407
6395
|
};
|
|
6408
6396
|
|
|
@@ -7188,7 +7176,7 @@ declare class InteropBroker extends Base {
|
|
|
7188
7176
|
* @param _id the identity tryinc to connect
|
|
7189
7177
|
* @param _connectionPayload optional payload to use in custom implementations, will be undefined by default
|
|
7190
7178
|
*/
|
|
7191
|
-
isConnectionAuthorized(_id:
|
|
7179
|
+
isConnectionAuthorized(_id: Identity_2, _connectionPayload?: any): Promise<boolean> | boolean;
|
|
7192
7180
|
/**
|
|
7193
7181
|
* Called before every action to check if this entity should be allowed to take the action.
|
|
7194
7182
|
* Return false to prevent the action
|
|
@@ -7989,6 +7977,10 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7989
7977
|
*/
|
|
7990
7978
|
declare class Layout extends Base {
|
|
7991
7979
|
#private;
|
|
7980
|
+
/**
|
|
7981
|
+
* @internal
|
|
7982
|
+
*/
|
|
7983
|
+
static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
|
|
7992
7984
|
/**
|
|
7993
7985
|
* @internal
|
|
7994
7986
|
*/
|
|
@@ -8094,6 +8086,17 @@ declare class Layout extends Base {
|
|
|
8094
8086
|
* ```
|
|
8095
8087
|
*/
|
|
8096
8088
|
getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
|
|
8089
|
+
/**
|
|
8090
|
+
* Retrieves the OpenFin.TabStack instance which the View belongs to.
|
|
8091
|
+
*
|
|
8092
|
+
* @example
|
|
8093
|
+
* ```js
|
|
8094
|
+
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
|
8095
|
+
* const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
|
|
8096
|
+
* console.log(await stack.getViews());
|
|
8097
|
+
* ```
|
|
8098
|
+
*/
|
|
8099
|
+
getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
|
|
8097
8100
|
/**
|
|
8098
8101
|
* Replaces the specified view with a view with the provided configuration.
|
|
8099
8102
|
*
|
|
@@ -8120,7 +8123,7 @@ declare class Layout extends Base {
|
|
|
8120
8123
|
* await layout.replaceView(viewToReplace.identity, newViewConfig);
|
|
8121
8124
|
* ```
|
|
8122
8125
|
*/
|
|
8123
|
-
replaceView: (viewToReplace:
|
|
8126
|
+
replaceView: (viewToReplace: Identity_3, newView: OpenFin.PlatformViewCreationOptions) => Promise<void>;
|
|
8124
8127
|
/**
|
|
8125
8128
|
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
8126
8129
|
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
@@ -8147,6 +8150,29 @@ declare class Layout extends Base {
|
|
|
8147
8150
|
* ```
|
|
8148
8151
|
*/
|
|
8149
8152
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8153
|
+
/**
|
|
8154
|
+
* Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
|
|
8155
|
+
*
|
|
8156
|
+
* @param viewOptions - The options for creating the view.
|
|
8157
|
+
* @param options - Optional parameters for adding the view.
|
|
8158
|
+
* @param options.location - The location where the view should be added.
|
|
8159
|
+
* @param options.targetView - The target view to which the new view should be added.
|
|
8160
|
+
* @returns A promise that resolves to an object containing the identity of the added view.
|
|
8161
|
+
*/
|
|
8162
|
+
addView(viewOptions: OpenFin.PlatformViewCreationOptions, { location, targetView }?: {
|
|
8163
|
+
location?: OpenFin.CreateViewTarget['location'];
|
|
8164
|
+
targetView?: OpenFin.Identity;
|
|
8165
|
+
}): Promise<{
|
|
8166
|
+
identity: OpenFin.Identity;
|
|
8167
|
+
}>;
|
|
8168
|
+
/**
|
|
8169
|
+
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8170
|
+
* Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
|
|
8171
|
+
*
|
|
8172
|
+
* @param viewIdentity - The identity of the view to close.
|
|
8173
|
+
* @returns A promise that resolves when the view is closed.
|
|
8174
|
+
*/
|
|
8175
|
+
closeView(viewIdentity: OpenFin.Identity): Promise<void>;
|
|
8150
8176
|
}
|
|
8151
8177
|
|
|
8152
8178
|
/**
|
|
@@ -8159,7 +8185,7 @@ declare type LayoutColumn = LayoutItemConfig & {
|
|
|
8159
8185
|
/**
|
|
8160
8186
|
* @interface
|
|
8161
8187
|
*/
|
|
8162
|
-
declare type LayoutComponent = LayoutItemConfig & {
|
|
8188
|
+
declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
8163
8189
|
/**
|
|
8164
8190
|
* Only a component type will have this property and it should be set to view.
|
|
8165
8191
|
*/
|
|
@@ -8168,6 +8194,7 @@ declare type LayoutComponent = LayoutItemConfig & {
|
|
|
8168
8194
|
* Only a component type will have this property and it represents the view options of a given component.
|
|
8169
8195
|
*/
|
|
8170
8196
|
componentState?: Partial<ViewCreationOptions>;
|
|
8197
|
+
type: 'component';
|
|
8171
8198
|
};
|
|
8172
8199
|
|
|
8173
8200
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
|
@@ -8175,7 +8202,7 @@ declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn |
|
|
|
8175
8202
|
/**
|
|
8176
8203
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
|
8177
8204
|
*/
|
|
8178
|
-
declare type LayoutDOMEvent =
|
|
8205
|
+
declare type LayoutDOMEvent = Identity_4 & {
|
|
8179
8206
|
type: string;
|
|
8180
8207
|
topic: 'openfin-DOM-event';
|
|
8181
8208
|
tabSelector: string;
|
|
@@ -8236,7 +8263,7 @@ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
|
|
|
8236
8263
|
/**
|
|
8237
8264
|
* @interface
|
|
8238
8265
|
*/
|
|
8239
|
-
declare type LayoutIdentity =
|
|
8266
|
+
declare type LayoutIdentity = Identity_4 & {
|
|
8240
8267
|
/**
|
|
8241
8268
|
* The name of the layout in a given window.
|
|
8242
8269
|
*/
|
|
@@ -8251,10 +8278,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
|
8251
8278
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8252
8279
|
type: 'layout-initialized';
|
|
8253
8280
|
layoutIdentity: OpenFin.LayoutIdentity;
|
|
8254
|
-
ofViews:
|
|
8255
|
-
identity: OpenFin.Identity;
|
|
8256
|
-
entityType: 'view';
|
|
8257
|
-
}[];
|
|
8281
|
+
ofViews: OpenFin.ViewCreationResult[];
|
|
8258
8282
|
};
|
|
8259
8283
|
|
|
8260
8284
|
/**
|
|
@@ -8345,7 +8369,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8345
8369
|
* @param identity
|
|
8346
8370
|
* @returns LayoutIdentity | undefined
|
|
8347
8371
|
*/
|
|
8348
|
-
resolveLayoutIdentity(identity?:
|
|
8372
|
+
resolveLayoutIdentity(identity?: Identity_4 | LayoutIdentity): LayoutIdentity | undefined;
|
|
8349
8373
|
/**
|
|
8350
8374
|
* @experimental
|
|
8351
8375
|
*
|
|
@@ -8362,7 +8386,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8362
8386
|
/**
|
|
8363
8387
|
* @experimental
|
|
8364
8388
|
*/
|
|
8365
|
-
getLayoutIdentityForView(viewIdentity:
|
|
8389
|
+
getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
|
|
8366
8390
|
/**
|
|
8367
8391
|
* @experimental
|
|
8368
8392
|
*/
|
|
@@ -8463,6 +8487,17 @@ declare class LayoutModule extends Base {
|
|
|
8463
8487
|
* ```
|
|
8464
8488
|
*/
|
|
8465
8489
|
getCurrentSync(): OpenFin.Layout;
|
|
8490
|
+
/**
|
|
8491
|
+
* Retrieves the OpenFin.Layout instance for the Window the View is attached to.
|
|
8492
|
+
*
|
|
8493
|
+
* @example
|
|
8494
|
+
* ```js
|
|
8495
|
+
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
|
8496
|
+
* const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
|
|
8497
|
+
* console.log(await layout.getCurrentViews());
|
|
8498
|
+
* ```
|
|
8499
|
+
*/
|
|
8500
|
+
getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
|
|
8466
8501
|
/**
|
|
8467
8502
|
* Initialize the window's Layout.
|
|
8468
8503
|
*
|
|
@@ -8836,12 +8871,10 @@ declare type Listener<T extends {
|
|
|
8836
8871
|
type: string;
|
|
8837
8872
|
}> = (payload: T) => void;
|
|
8838
8873
|
|
|
8839
|
-
declare type LogInfo = OpenFin.LogInfo;
|
|
8840
|
-
|
|
8841
8874
|
/**
|
|
8842
8875
|
* @interface
|
|
8843
8876
|
*/
|
|
8844
|
-
declare type
|
|
8877
|
+
declare type LogInfo = {
|
|
8845
8878
|
/**
|
|
8846
8879
|
* The filename of the log
|
|
8847
8880
|
*/
|
|
@@ -8856,8 +8889,6 @@ declare type LogInfo_2 = {
|
|
|
8856
8889
|
date: string;
|
|
8857
8890
|
};
|
|
8858
8891
|
|
|
8859
|
-
declare type LogLevel = OpenFin.LogLevel;
|
|
8860
|
-
|
|
8861
8892
|
/**
|
|
8862
8893
|
* Describes the minimum level (inclusive) above which logs will be written.
|
|
8863
8894
|
*
|
|
@@ -8867,7 +8898,7 @@ declare type LogLevel = OpenFin.LogLevel;
|
|
|
8867
8898
|
* `error` and above<br>
|
|
8868
8899
|
* `fatal`: fatal only, indicates a crash is imminent
|
|
8869
8900
|
*/
|
|
8870
|
-
declare type
|
|
8901
|
+
declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
8871
8902
|
|
|
8872
8903
|
declare type LogUploaderUIOptions = {
|
|
8873
8904
|
title?: string;
|
|
@@ -9520,6 +9551,12 @@ declare type MutableWindowOptions = {
|
|
|
9520
9551
|
* Shows the window's icon in the taskbar.
|
|
9521
9552
|
*/
|
|
9522
9553
|
showTaskbarIcon: boolean;
|
|
9554
|
+
/**
|
|
9555
|
+
* Specify a taskbar group for the window.
|
|
9556
|
+
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
9557
|
+
* @remarks It's only updatable when `enableJumpList` is set to false.
|
|
9558
|
+
*/
|
|
9559
|
+
taskbarIconGroup: string;
|
|
9523
9560
|
interop: InteropConfig;
|
|
9524
9561
|
/**
|
|
9525
9562
|
* @internal
|
|
@@ -9717,13 +9754,13 @@ declare namespace OpenFin {
|
|
|
9717
9754
|
LayoutPosition,
|
|
9718
9755
|
WebContent,
|
|
9719
9756
|
PlatformProvider,
|
|
9720
|
-
|
|
9721
|
-
|
|
9757
|
+
ApplicationIdentity,
|
|
9758
|
+
Identity_4 as Identity,
|
|
9722
9759
|
ClientIdentity,
|
|
9723
9760
|
ClientInfo,
|
|
9724
9761
|
ClientIdentityMultiRuntime,
|
|
9725
9762
|
ClientConnectionPayload,
|
|
9726
|
-
|
|
9763
|
+
EntityInfo,
|
|
9727
9764
|
EntityType_4 as EntityType,
|
|
9728
9765
|
Bounds,
|
|
9729
9766
|
WindowBounds,
|
|
@@ -9794,6 +9831,9 @@ declare namespace OpenFin {
|
|
|
9794
9831
|
ViewOptions,
|
|
9795
9832
|
ConstViewOptions,
|
|
9796
9833
|
ViewState,
|
|
9834
|
+
ViewCreationSuccess,
|
|
9835
|
+
ViewCreationFailure,
|
|
9836
|
+
ViewCreationResult,
|
|
9797
9837
|
Certificate,
|
|
9798
9838
|
HostContextChangedPayload,
|
|
9799
9839
|
ApplySnapshotOptions,
|
|
@@ -9859,7 +9899,7 @@ declare namespace OpenFin {
|
|
|
9859
9899
|
GpuInfo,
|
|
9860
9900
|
OSInfo,
|
|
9861
9901
|
HostSpecs,
|
|
9862
|
-
|
|
9902
|
+
PrinterInfo,
|
|
9863
9903
|
Dpi,
|
|
9864
9904
|
Margins,
|
|
9865
9905
|
PrintOptions,
|
|
@@ -9967,24 +10007,24 @@ declare namespace OpenFin {
|
|
|
9967
10007
|
BeforeUnloadUserDecision,
|
|
9968
10008
|
ViewStatuses,
|
|
9969
10009
|
CloseWindowPayload,
|
|
9970
|
-
|
|
9971
|
-
|
|
10010
|
+
ProxyInfo,
|
|
10011
|
+
ProxyConfig,
|
|
9972
10012
|
ProxySystemInfo,
|
|
9973
10013
|
ChannelAction_2 as ChannelAction,
|
|
9974
10014
|
ChannelMiddleware_2 as ChannelMiddleware,
|
|
9975
10015
|
ErrorMiddleware_2 as ErrorMiddleware,
|
|
9976
|
-
|
|
9977
|
-
|
|
10016
|
+
ApplicationState,
|
|
10017
|
+
InstalledApps,
|
|
9978
10018
|
InstallationInfo,
|
|
9979
|
-
|
|
9980
|
-
|
|
10019
|
+
GetLogRequestType,
|
|
10020
|
+
LogInfo,
|
|
9981
10021
|
SendApplicationLogResponse,
|
|
9982
|
-
|
|
10022
|
+
LogLevel,
|
|
9983
10023
|
PermissionState_2 as PermissionState,
|
|
9984
|
-
|
|
10024
|
+
RegistryInfo,
|
|
9985
10025
|
ApplicationType,
|
|
9986
10026
|
WindowInfo,
|
|
9987
|
-
|
|
10027
|
+
ApplicationWindowInfo,
|
|
9988
10028
|
WindowDetail,
|
|
9989
10029
|
LayoutPresetType,
|
|
9990
10030
|
LayoutIdentity,
|
|
@@ -11672,6 +11712,45 @@ declare interface PlatformProvider {
|
|
|
11672
11712
|
* @returns {Promise<void>}
|
|
11673
11713
|
*/
|
|
11674
11714
|
handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
|
|
11715
|
+
/**
|
|
11716
|
+
* @experimental
|
|
11717
|
+
*
|
|
11718
|
+
* This method is called to handle errors with view creation and initial navigation during layout creation.
|
|
11719
|
+
* Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
|
|
11720
|
+
* * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
|
|
11721
|
+
* * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
|
|
11722
|
+
* * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
|
|
11723
|
+
*
|
|
11724
|
+
* @param viewIdentity Identity of the view
|
|
11725
|
+
* @param error error thrown during a view creation
|
|
11726
|
+
* @returns {Promise<OpenFin.ViewCreationSuccess | void>}
|
|
11727
|
+
*
|
|
11728
|
+
* @example
|
|
11729
|
+
*
|
|
11730
|
+
* ```js
|
|
11731
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
11732
|
+
* class Override extends PlatformProvider {
|
|
11733
|
+
* async handleFailedViewCreation(viewIdentity, error) {
|
|
11734
|
+
* const view = fin.View.wrapSync(viewId);
|
|
11735
|
+
* try {
|
|
11736
|
+
* // navigate to an error page
|
|
11737
|
+
* await view.navigate('http://localhost:3000/errorPage.html');
|
|
11738
|
+
* // resolve a success result after redirecting to a error page
|
|
11739
|
+
* return {identity: viewIdentity, success: true};
|
|
11740
|
+
* } catch(e) {
|
|
11741
|
+
* // layout-initialized event will include this view with the error
|
|
11742
|
+
* throw error;
|
|
11743
|
+
* }
|
|
11744
|
+
* }
|
|
11745
|
+
* }
|
|
11746
|
+
* return new Override();
|
|
11747
|
+
* }
|
|
11748
|
+
*
|
|
11749
|
+
* fin.Platform.init({ overrideCallback });
|
|
11750
|
+
*
|
|
11751
|
+
* ```
|
|
11752
|
+
*/
|
|
11753
|
+
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
11675
11754
|
}
|
|
11676
11755
|
|
|
11677
11756
|
/**
|
|
@@ -11971,12 +12050,10 @@ declare type PresetLayoutOptions_2 = {
|
|
|
11971
12050
|
presetType: LayoutPresetType;
|
|
11972
12051
|
};
|
|
11973
12052
|
|
|
11974
|
-
declare type PrinterInfo = OpenFin.PrinterInfo;
|
|
11975
|
-
|
|
11976
12053
|
/**
|
|
11977
12054
|
* @interface
|
|
11978
12055
|
*/
|
|
11979
|
-
declare type
|
|
12056
|
+
declare type PrinterInfo = {
|
|
11980
12057
|
/**
|
|
11981
12058
|
* Printer Name
|
|
11982
12059
|
*/
|
|
@@ -12238,20 +12315,100 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
12238
12315
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12239
12316
|
|
|
12240
12317
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
12318
|
+
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12319
|
+
'destroy-application': ApplicationIdentityCall<{
|
|
12320
|
+
force: boolean;
|
|
12321
|
+
}, void>;
|
|
12322
|
+
'close-application': ApplicationIdentityCall<{
|
|
12323
|
+
force: boolean;
|
|
12324
|
+
}, void>;
|
|
12325
|
+
'application-close': ApplicationIdentityCall<{}, void>;
|
|
12326
|
+
'get-child-windows': ApplicationIdentityCall<{}, Array<unknown>>;
|
|
12327
|
+
'get-application-manifest': {
|
|
12328
|
+
request: {
|
|
12329
|
+
manifestUrl?: string;
|
|
12330
|
+
uuid?: string;
|
|
12331
|
+
};
|
|
12332
|
+
response: OpenFin.Manifest;
|
|
12333
|
+
};
|
|
12334
|
+
'get-parent-application': ApplicationIdentityCall<{}, string>;
|
|
12335
|
+
'get-shortcuts': ApplicationIdentityCall<{}, OpenFin.ShortCutConfig>;
|
|
12336
|
+
'application-get-views': ApplicationIdentityCall<{}, OpenFin.Identity[]>;
|
|
12337
|
+
'get-application-zoom-level': ApplicationIdentityCall<{}, number>;
|
|
12338
|
+
'application-get-window': ApplicationIdentityCall<{}, void>;
|
|
12339
|
+
'register-user': ApplicationIdentityCall<{
|
|
12340
|
+
userName: string;
|
|
12341
|
+
appName: string;
|
|
12342
|
+
}, void>;
|
|
12343
|
+
'remove-tray-icon': ApplicationIdentityCall<{}, void>;
|
|
12344
|
+
'restart-application': ApplicationIdentityCall<{}, void>;
|
|
12345
|
+
'application-run': ApplicationIdentityCall<{}, void>;
|
|
12346
|
+
'run-application': ApplicationIdentityCall<{
|
|
12347
|
+
manifestUrl?: string | undefined;
|
|
12348
|
+
opts?: OpenFin.RvmLaunchOptions;
|
|
12349
|
+
}, void>;
|
|
12350
|
+
'relaunch-on-close': ApplicationIdentityCall<{}, void>;
|
|
12351
|
+
'send-application-log': ApplicationIdentityCall<{}, OpenFin.SendApplicationLogResponse>;
|
|
12352
|
+
'set-jump-list': ApplicationIdentityCall<{
|
|
12353
|
+
config: OpenFin.JumpListCategory[] | null;
|
|
12354
|
+
}, void>;
|
|
12355
|
+
'set-tray-icon': ApplicationIdentityCall<{
|
|
12356
|
+
enabledIcon: string;
|
|
12357
|
+
}, void>;
|
|
12358
|
+
'set-shortcuts': ApplicationIdentityCall<{
|
|
12359
|
+
data: OpenFin.ShortCutConfig;
|
|
12360
|
+
}, void>;
|
|
12361
|
+
'set-shortcut-query-args': ApplicationIdentityCall<{
|
|
12362
|
+
data: string;
|
|
12363
|
+
}, void>;
|
|
12364
|
+
'set-application-zoom-level': ApplicationIdentityCall<{
|
|
12365
|
+
level: number;
|
|
12366
|
+
}, void>;
|
|
12367
|
+
'set-app-log-username': ApplicationIdentityCall<{
|
|
12368
|
+
data: string;
|
|
12369
|
+
}, void>;
|
|
12370
|
+
'get-tray-icon-info': ApplicationIdentityCall<{}, OpenFin.TrayInfo>;
|
|
12371
|
+
'has-tray-icon': ApplicationIdentityCall<{}, boolean>;
|
|
12372
|
+
'terminate-application': ApplicationIdentityCall<{}, void>;
|
|
12373
|
+
'wait-for-hung-application': ApplicationIdentityCall<{}, void>;
|
|
12374
|
+
'get-info': ApplicationIdentityCall<{}, OpenFin.ApplicationInfo>;
|
|
12375
|
+
'application-get-process-info': ApplicationIdentityCall<{}, OpenFin.AppProcessInfo>;
|
|
12376
|
+
'set-file-download-location': {
|
|
12377
|
+
request: OpenFin.Identity & {
|
|
12378
|
+
downloadLocation: string;
|
|
12379
|
+
};
|
|
12380
|
+
response: void;
|
|
12381
|
+
};
|
|
12382
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12383
|
+
'show-tray-icon-popup-menu': {
|
|
12384
|
+
request: OpenFin.Identity & {
|
|
12385
|
+
options: OpenFin.ShowTrayIconPopupMenuOptions;
|
|
12386
|
+
};
|
|
12387
|
+
response: OpenFin.MenuResult;
|
|
12388
|
+
};
|
|
12389
|
+
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12390
|
+
'wrap-application': VoidCall;
|
|
12391
|
+
'wrap-application-sync': VoidCall;
|
|
12392
|
+
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
12393
|
+
'application-create': VoidCall;
|
|
12394
|
+
'start-application': VoidCall;
|
|
12395
|
+
'run-applications': ApiCall<{
|
|
12396
|
+
applications: Array<OpenFin.ManifestInfo>;
|
|
12397
|
+
opts?: OpenFin.RvmLaunchOptions;
|
|
12398
|
+
}, void>;
|
|
12399
|
+
'get-current-application': VoidCall;
|
|
12400
|
+
'get-current-application-sync': VoidCall;
|
|
12401
|
+
'application-start-from-manifest': VoidCall;
|
|
12402
|
+
'application-create-from-manifest': VoidCall;
|
|
12241
12403
|
'request-external-authorization': {
|
|
12242
12404
|
request: any;
|
|
12243
12405
|
response: void;
|
|
12244
12406
|
specialResponse: AuthorizationPayload;
|
|
12245
12407
|
};
|
|
12246
|
-
'
|
|
12247
|
-
request:
|
|
12248
|
-
response: OpenFin.Identity[];
|
|
12249
|
-
};
|
|
12250
|
-
'set-jump-list': {
|
|
12251
|
-
request: {
|
|
12252
|
-
config: OpenFin.JumpListCategory[] | null;
|
|
12253
|
-
} & OpenFin.ApplicationIdentity;
|
|
12408
|
+
'request-authorization': {
|
|
12409
|
+
request: ExistingConnectConfig | RemoteConfig | ReceiverConfig;
|
|
12254
12410
|
response: void;
|
|
12411
|
+
specialResponse: Payload;
|
|
12255
12412
|
};
|
|
12256
12413
|
'clipboard-read-formats': {
|
|
12257
12414
|
request: {
|
|
@@ -12263,6 +12420,24 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12263
12420
|
request: OpenFin.ReadImageClipboardRequest;
|
|
12264
12421
|
response: string;
|
|
12265
12422
|
};
|
|
12423
|
+
'clipboard-read-text': {
|
|
12424
|
+
request: {
|
|
12425
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12426
|
+
};
|
|
12427
|
+
response: string;
|
|
12428
|
+
};
|
|
12429
|
+
'clipboard-read-html': {
|
|
12430
|
+
request: {
|
|
12431
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12432
|
+
};
|
|
12433
|
+
response: string;
|
|
12434
|
+
};
|
|
12435
|
+
'clipboard-read-rtf': {
|
|
12436
|
+
request: {
|
|
12437
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12438
|
+
};
|
|
12439
|
+
response: string;
|
|
12440
|
+
};
|
|
12266
12441
|
'clipboard-write-image': {
|
|
12267
12442
|
request: OpenFin.WriteImageClipboardRequest;
|
|
12268
12443
|
response: void;
|
|
@@ -12271,6 +12446,18 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12271
12446
|
request: OpenFin.WriteAnyRequestType;
|
|
12272
12447
|
response: void;
|
|
12273
12448
|
};
|
|
12449
|
+
'clipboard-write-text': {
|
|
12450
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12451
|
+
response: void;
|
|
12452
|
+
};
|
|
12453
|
+
'clipboard-write-html': {
|
|
12454
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12455
|
+
response: void;
|
|
12456
|
+
};
|
|
12457
|
+
'clipboard-write-rtf': {
|
|
12458
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12459
|
+
response: void;
|
|
12460
|
+
};
|
|
12274
12461
|
'get-view-window': IdentityCall<{}, OpenFin.Identity>;
|
|
12275
12462
|
'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
|
|
12276
12463
|
uuid: string;
|
|
@@ -12296,13 +12483,85 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12296
12483
|
options: OpenFin.UpdatableViewOptions;
|
|
12297
12484
|
}>;
|
|
12298
12485
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12486
|
+
'view-wrap-sync': VoidCall;
|
|
12487
|
+
'view-wrap': VoidCall;
|
|
12488
|
+
'view-get-current': VoidCall;
|
|
12489
|
+
'view-get-current-sync': VoidCall;
|
|
12490
|
+
'animate-window': IdentityCall<{
|
|
12491
|
+
transitions: OpenFin.Transition;
|
|
12492
|
+
options: OpenFin.TransitionOptions;
|
|
12493
|
+
}>;
|
|
12494
|
+
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12495
|
+
'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
|
|
12496
|
+
'center-window': IdentityCall;
|
|
12497
|
+
'blur-window': IdentityCall;
|
|
12498
|
+
'bring-window-to-front': IdentityCall;
|
|
12499
|
+
'hide-window': IdentityCall;
|
|
12500
|
+
'close-window': IdentityCall<{
|
|
12501
|
+
force: boolean;
|
|
12502
|
+
}>;
|
|
12503
|
+
'focused-webview-changed': IdentityCall;
|
|
12504
|
+
'get-window-native-id': IdentityCall<{}, string>;
|
|
12299
12505
|
'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
|
|
12300
|
-
'
|
|
12506
|
+
'disable-window-frame': IdentityCall;
|
|
12507
|
+
'enable-window-frame': IdentityCall;
|
|
12508
|
+
'flash-window': IdentityCall;
|
|
12509
|
+
'stop-flash-window': IdentityCall;
|
|
12510
|
+
'get-window-info': IdentityCall<{}, OpenFin.WindowInfo>;
|
|
12511
|
+
'get-window-options': IdentityCall<{}, OpenFin.WindowOptions>;
|
|
12512
|
+
'get-window-snapshot': IdentityCall<{
|
|
12513
|
+
area?: OpenFin.Rectangle;
|
|
12514
|
+
}, string>;
|
|
12515
|
+
'get-window-state': IdentityCall<{}, 'minimized' | 'maximized' | 'normal'>;
|
|
12516
|
+
'is-window-showing': IdentityCall<{}, boolean>;
|
|
12517
|
+
'maximize-window': IdentityCall;
|
|
12518
|
+
'minimize-window': IdentityCall;
|
|
12519
|
+
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12520
|
+
deltaLeft: number;
|
|
12521
|
+
deltaTop: number;
|
|
12522
|
+
}>>;
|
|
12523
|
+
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12524
|
+
left: number;
|
|
12525
|
+
top: number;
|
|
12526
|
+
}>>;
|
|
12527
|
+
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12528
|
+
deltaWidth: number;
|
|
12529
|
+
deltaHeight: number;
|
|
12530
|
+
anchor: OpenFin.AnchorType;
|
|
12531
|
+
}>>;
|
|
12532
|
+
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12533
|
+
width: number;
|
|
12534
|
+
height: number;
|
|
12535
|
+
anchor: OpenFin.AnchorType;
|
|
12536
|
+
}>>;
|
|
12537
|
+
'restore-window': IdentityCall;
|
|
12538
|
+
'set-foreground-window': IdentityCall;
|
|
12539
|
+
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12540
|
+
'show-window': IdentityCall<{
|
|
12541
|
+
force: boolean;
|
|
12542
|
+
}>;
|
|
12543
|
+
'show-at-window': IdentityCall<{
|
|
12544
|
+
left: number;
|
|
12545
|
+
top: number;
|
|
12546
|
+
force: boolean;
|
|
12547
|
+
}>;
|
|
12548
|
+
'update-window-options': IdentityCall<{
|
|
12549
|
+
options: OpenFin.UpdatableWindowOptions;
|
|
12550
|
+
}>;
|
|
12551
|
+
'window-authenticate': IdentityCall<{
|
|
12552
|
+
userName: string;
|
|
12553
|
+
password: string;
|
|
12554
|
+
}>;
|
|
12555
|
+
'show-popup-menu': {
|
|
12301
12556
|
request: OpenFin.Identity & {
|
|
12302
|
-
options: OpenFin.
|
|
12557
|
+
options: OpenFin.ShowPopupMenuOptions;
|
|
12303
12558
|
};
|
|
12304
|
-
response:
|
|
12559
|
+
response: OpenFin.MenuResult;
|
|
12305
12560
|
};
|
|
12561
|
+
'close-popup-menu': IdentityCall;
|
|
12562
|
+
'dispatch-popup-result': IdentityCall<{
|
|
12563
|
+
data: any;
|
|
12564
|
+
}>;
|
|
12306
12565
|
'print-screenshot': {
|
|
12307
12566
|
request: OpenFin.Identity;
|
|
12308
12567
|
response: void;
|
|
@@ -12313,6 +12572,229 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12313
12572
|
};
|
|
12314
12573
|
response: void;
|
|
12315
12574
|
};
|
|
12575
|
+
'window-wrap': VoidCall;
|
|
12576
|
+
'window-wrap-sync': VoidCall;
|
|
12577
|
+
'create-window': VoidCall;
|
|
12578
|
+
'get-current-window': VoidCall;
|
|
12579
|
+
'get-current-window-sync': VoidCall;
|
|
12580
|
+
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
12581
|
+
'external-application-wrap': VoidCall;
|
|
12582
|
+
'external-application-wrap-sync': VoidCall;
|
|
12583
|
+
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12584
|
+
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12585
|
+
'frame-wrap': VoidCall;
|
|
12586
|
+
'frame-wrap-sync': VoidCall;
|
|
12587
|
+
'frame-get-current': VoidCall;
|
|
12588
|
+
'frame-get-current-sync': VoidCall;
|
|
12589
|
+
'global-hotkey-register': {
|
|
12590
|
+
request: {
|
|
12591
|
+
hotkey: string;
|
|
12592
|
+
};
|
|
12593
|
+
response: void;
|
|
12594
|
+
};
|
|
12595
|
+
'global-hotkey-unregister': {
|
|
12596
|
+
request: {
|
|
12597
|
+
hotkey: string;
|
|
12598
|
+
};
|
|
12599
|
+
response: void;
|
|
12600
|
+
};
|
|
12601
|
+
'global-hotkey-unregister-all': {
|
|
12602
|
+
request: {};
|
|
12603
|
+
response: void;
|
|
12604
|
+
};
|
|
12605
|
+
'global-hotkey-is-registered': {
|
|
12606
|
+
request: {
|
|
12607
|
+
hotkey: string;
|
|
12608
|
+
};
|
|
12609
|
+
response: boolean;
|
|
12610
|
+
};
|
|
12611
|
+
'publish-message': {
|
|
12612
|
+
request: {
|
|
12613
|
+
topic: string;
|
|
12614
|
+
message: any;
|
|
12615
|
+
sourceWindowName: string;
|
|
12616
|
+
};
|
|
12617
|
+
response: void;
|
|
12618
|
+
};
|
|
12619
|
+
'send-message': {
|
|
12620
|
+
request: {
|
|
12621
|
+
destinationUuid: string;
|
|
12622
|
+
destinationWindowName: string | undefined;
|
|
12623
|
+
topic: string;
|
|
12624
|
+
message: any;
|
|
12625
|
+
sourceWindowName: string;
|
|
12626
|
+
};
|
|
12627
|
+
response: void;
|
|
12628
|
+
};
|
|
12629
|
+
'subscribe': {
|
|
12630
|
+
request: {
|
|
12631
|
+
sourceUuid: string;
|
|
12632
|
+
sourceWindowName: string;
|
|
12633
|
+
topic: string;
|
|
12634
|
+
destinationWindowName: string;
|
|
12635
|
+
messageKey?: any;
|
|
12636
|
+
};
|
|
12637
|
+
response: void;
|
|
12638
|
+
};
|
|
12639
|
+
'unsubscribe': {
|
|
12640
|
+
request: {
|
|
12641
|
+
sourceUuid: string;
|
|
12642
|
+
sourceWindowName: string;
|
|
12643
|
+
topic: string;
|
|
12644
|
+
destinationWindowName: string;
|
|
12645
|
+
};
|
|
12646
|
+
response: void;
|
|
12647
|
+
};
|
|
12648
|
+
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
12649
|
+
'connect-to-channel': {
|
|
12650
|
+
request: any;
|
|
12651
|
+
response: OpenFin.RoutingInfo;
|
|
12652
|
+
};
|
|
12653
|
+
'create-channel': ApiCall<{
|
|
12654
|
+
channelName: string;
|
|
12655
|
+
}, OpenFin.ProviderIdentity>;
|
|
12656
|
+
'destroy-channel': ApiCall<{
|
|
12657
|
+
channelName: string;
|
|
12658
|
+
}, void>;
|
|
12659
|
+
'disconnect-from-channel': {
|
|
12660
|
+
request: {
|
|
12661
|
+
channelName: string;
|
|
12662
|
+
uuid: string;
|
|
12663
|
+
name: string;
|
|
12664
|
+
endpointId: string;
|
|
12665
|
+
};
|
|
12666
|
+
response: void;
|
|
12667
|
+
};
|
|
12668
|
+
'send-channel-message': {
|
|
12669
|
+
request: any;
|
|
12670
|
+
response: any;
|
|
12671
|
+
};
|
|
12672
|
+
'get-version': GetterCall<string>;
|
|
12673
|
+
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
12674
|
+
'delete-cache-request': VoidCall;
|
|
12675
|
+
'exit-desktop': VoidCall;
|
|
12676
|
+
'fetch-manifest': ApiCall<{
|
|
12677
|
+
manifestUrl: string;
|
|
12678
|
+
}, any>;
|
|
12679
|
+
'flush-cookie-store': VoidCall;
|
|
12680
|
+
'get-all-windows': GetterCall<OpenFin.ApplicationWindowInfo[]>;
|
|
12681
|
+
'get-all-applications': GetterCall<OpenFin.ApplicationState[]>;
|
|
12682
|
+
'get-command-line-arguments': GetterCall<string>;
|
|
12683
|
+
'get-crash-reporter-state': GetterCall<OpenFin.CrashReporterState>;
|
|
12684
|
+
'start-crash-reporter': {
|
|
12685
|
+
request: OpenFin.CrashReporterOptions | {
|
|
12686
|
+
diagnosticMode: boolean;
|
|
12687
|
+
};
|
|
12688
|
+
response: OpenFin.CrashReporterState;
|
|
12689
|
+
};
|
|
12690
|
+
'get-unique-user-id': GetterCall<string>;
|
|
12691
|
+
'get-entity-info': {
|
|
12692
|
+
request: {
|
|
12693
|
+
uuid: string;
|
|
12694
|
+
name: string;
|
|
12695
|
+
};
|
|
12696
|
+
response: OpenFin.EntityInfo;
|
|
12697
|
+
};
|
|
12698
|
+
'get-environment-variable': {
|
|
12699
|
+
request: {
|
|
12700
|
+
environmentVariables: string;
|
|
12701
|
+
};
|
|
12702
|
+
response: string;
|
|
12703
|
+
};
|
|
12704
|
+
'get-focused-window': GetterCall<OpenFin.Identity | null>;
|
|
12705
|
+
'is-app-certified': {
|
|
12706
|
+
request: {
|
|
12707
|
+
manifestUrl: string;
|
|
12708
|
+
};
|
|
12709
|
+
response: {
|
|
12710
|
+
action: string;
|
|
12711
|
+
certifiedInfo: OpenFin.CertifiedAppInfo;
|
|
12712
|
+
};
|
|
12713
|
+
};
|
|
12714
|
+
'get-installed-runtimes': GetterCall<{
|
|
12715
|
+
action: string;
|
|
12716
|
+
runtimes: string[];
|
|
12717
|
+
}>;
|
|
12718
|
+
'get-installed-apps': GetterCall<OpenFin.InstalledApps>;
|
|
12719
|
+
'view-log': ApiCall<OpenFin.GetLogRequestType, string>;
|
|
12720
|
+
'get-machine-id': GetterCall<string>;
|
|
12721
|
+
'get-min-log-level': GetterCall<OpenFin.LogLevel>;
|
|
12722
|
+
'list-logs': GetterCall<OpenFin.LogInfo[]>;
|
|
12723
|
+
'get-monitor-info': GetterCall<OpenFin.MonitorInfo>;
|
|
12724
|
+
'get-mouse-position': GetterCall<OpenFin.PointTopLeft>;
|
|
12725
|
+
'process-snapshot': GetterCall<Array<any>>;
|
|
12726
|
+
'get-all-process-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.SystemProcessInfo>;
|
|
12727
|
+
'get-proxy-settings': GetterCall<OpenFin.ProxyInfo>;
|
|
12728
|
+
'get-runtime-info': GetterCall<OpenFin.RuntimeInfo>;
|
|
12729
|
+
'get-rvm-info': GetterCall<OpenFin.RVMInfo>;
|
|
12730
|
+
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12731
|
+
'get-os-info': GetterCall<OpenFin.OSInfo>;
|
|
12732
|
+
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity>;
|
|
12733
|
+
'monitor-external-process': ApiCall<OpenFin.ExternalProcessInfo, OpenFin.Identity>;
|
|
12734
|
+
'write-to-log': ApiCall<{
|
|
12735
|
+
level: string;
|
|
12736
|
+
message: string;
|
|
12737
|
+
}, void>;
|
|
12738
|
+
'open-url-with-browser': ApiCall<{
|
|
12739
|
+
url: string;
|
|
12740
|
+
}, void>;
|
|
12741
|
+
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12742
|
+
'unregister-custom-protocol': ApiCall<{
|
|
12743
|
+
protocolName: string;
|
|
12744
|
+
}, void>;
|
|
12745
|
+
'get-custom-protocol-state': ApiCall<{
|
|
12746
|
+
protocolName: string;
|
|
12747
|
+
}, OpenFin.CustomProtocolState>;
|
|
12748
|
+
'release-external-process': ApiCall<{
|
|
12749
|
+
uuid: string;
|
|
12750
|
+
}, void>;
|
|
12751
|
+
'show-developer-tools': ApiCall<OpenFin.Identity, void>;
|
|
12752
|
+
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void>;
|
|
12753
|
+
'update-proxy': ApiCall<OpenFin.ProxyConfig, void>;
|
|
12754
|
+
'download-asset': {
|
|
12755
|
+
request: OpenFin.AppAssetInfo & {
|
|
12756
|
+
downloadId: string;
|
|
12757
|
+
};
|
|
12758
|
+
response: void;
|
|
12759
|
+
};
|
|
12760
|
+
'download-runtime': {
|
|
12761
|
+
request: OpenFin.RuntimeDownloadOptions & {
|
|
12762
|
+
downloadId: string;
|
|
12763
|
+
};
|
|
12764
|
+
response: void;
|
|
12765
|
+
};
|
|
12766
|
+
'download-preload-scripts': ApiCall<{
|
|
12767
|
+
scripts: Array<OpenFin.DownloadPreloadOption>;
|
|
12768
|
+
}, Array<OpenFin.DownloadPreloadInfo>>;
|
|
12769
|
+
'get-all-external-applications': ApiCall<void, Array<OpenFin.Identity>>;
|
|
12770
|
+
'get-app-asset-info': ApiCall<OpenFin.AppAssetRequest, OpenFin.AppAssetInfo>;
|
|
12771
|
+
'get-cookies': {
|
|
12772
|
+
request: OpenFin.CookieOption & {
|
|
12773
|
+
url: string;
|
|
12774
|
+
};
|
|
12775
|
+
response: Array<OpenFin.CookieInfo>;
|
|
12776
|
+
};
|
|
12777
|
+
'set-min-log-level': ApiCall<{
|
|
12778
|
+
level: OpenFin.LogLevel;
|
|
12779
|
+
}, void>;
|
|
12780
|
+
'resolve-uuid': ApiCall<{
|
|
12781
|
+
entityKey: string;
|
|
12782
|
+
}, OpenFin.ApplicationType>;
|
|
12783
|
+
'read-registry-value': ApiCall<{
|
|
12784
|
+
rootKey: string;
|
|
12785
|
+
subkey: string;
|
|
12786
|
+
value: string;
|
|
12787
|
+
}, OpenFin.RegistryInfo>;
|
|
12788
|
+
'register-external-connection': ApiCall<{
|
|
12789
|
+
uuid: string;
|
|
12790
|
+
}, OpenFin.ExternalConnection>;
|
|
12791
|
+
'get-service-configuration': ApiCall<{
|
|
12792
|
+
name: string;
|
|
12793
|
+
}, OpenFin.ServiceConfiguration>;
|
|
12794
|
+
'get-system-app-configuration': ApiCall<{
|
|
12795
|
+
name: string;
|
|
12796
|
+
}, any>;
|
|
12797
|
+
'run-rvm-health-check': ApiCall<void, string[]>;
|
|
12316
12798
|
'launch-manifest': {
|
|
12317
12799
|
request: {
|
|
12318
12800
|
manifestUrl: string;
|
|
@@ -12324,17 +12806,12 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12324
12806
|
manifest: OpenFin.Manifest;
|
|
12325
12807
|
};
|
|
12326
12808
|
};
|
|
12327
|
-
'
|
|
12809
|
+
'query-permission-for-current-context': {
|
|
12328
12810
|
request: {
|
|
12329
|
-
|
|
12330
|
-
|
|
12331
|
-
response: any;
|
|
12332
|
-
};
|
|
12333
|
-
'show-popup-menu': {
|
|
12334
|
-
request: OpenFin.Identity & {
|
|
12335
|
-
options: OpenFin.ShowPopupMenuOptions;
|
|
12811
|
+
apiName: string;
|
|
12812
|
+
identity: OpenFin.Identity;
|
|
12336
12813
|
};
|
|
12337
|
-
response: OpenFin.
|
|
12814
|
+
response: OpenFin.QueryPermissionResult;
|
|
12338
12815
|
};
|
|
12339
12816
|
'enable-native-window-integration-provider': {
|
|
12340
12817
|
request: {
|
|
@@ -12342,24 +12819,34 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12342
12819
|
};
|
|
12343
12820
|
response: OpenFin.NativeWindowIntegrationProviderAuthorization;
|
|
12344
12821
|
};
|
|
12822
|
+
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
12823
|
+
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12824
|
+
'system-update-process-logging-options': ApiCall<{
|
|
12825
|
+
options: OpenFin.ProcessLoggingOptions;
|
|
12826
|
+
}, void>;
|
|
12827
|
+
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12828
|
+
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12829
|
+
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12830
|
+
}, void>;
|
|
12831
|
+
'system-register-shutdown-handler': VoidCall;
|
|
12345
12832
|
'get-permissions': GetterCall<any>;
|
|
12346
|
-
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
12347
|
-
'set-file-download-location': {
|
|
12348
|
-
request: OpenFin.Identity & {
|
|
12349
|
-
downloadLocation: string;
|
|
12350
|
-
};
|
|
12351
|
-
response: void;
|
|
12352
|
-
};
|
|
12353
|
-
'get-file-download-location': {
|
|
12354
|
-
request: OpenFin.ApplicationIdentity;
|
|
12355
|
-
response: string;
|
|
12356
|
-
};
|
|
12357
|
-
'close-popup-menu': IdentityCall;
|
|
12358
12833
|
'fdc3-add-context-listener': VoidCall;
|
|
12834
|
+
'fdc3-add-intent-listener': VoidCall;
|
|
12835
|
+
'fdc3-raise-intent': VoidCall;
|
|
12836
|
+
'fdc3-find-intent': VoidCall;
|
|
12837
|
+
'fdc3-find-intents-by-context': VoidCall;
|
|
12838
|
+
'fdc3-raise-intent-for-context': VoidCall;
|
|
12839
|
+
'fdc3-get-info': VoidCall;
|
|
12840
|
+
'fdc3-find-instances': VoidCall;
|
|
12841
|
+
'fdc3-get-app-metadata': VoidCall;
|
|
12359
12842
|
'fdc3-broadcast': VoidCall;
|
|
12843
|
+
'fdc3-open': VoidCall;
|
|
12844
|
+
'fdc3-get-or-create-channel': VoidCall;
|
|
12360
12845
|
'fdc3-get-system-channels': VoidCall;
|
|
12361
12846
|
'fdc3-join-channel': VoidCall;
|
|
12847
|
+
'fdc3-get-current-channel': VoidCall;
|
|
12362
12848
|
'fdc3-leave-current-channel': VoidCall;
|
|
12849
|
+
'interop-init': VoidCall;
|
|
12363
12850
|
'interop-connect-sync': VoidCall;
|
|
12364
12851
|
'interop-client-set-context': VoidCall;
|
|
12365
12852
|
'interop-client-add-context-handler': VoidCall;
|
|
@@ -12368,6 +12855,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12368
12855
|
'interop-client-remove-from-context-group': VoidCall;
|
|
12369
12856
|
'interop-client-get-all-clients-in-context-group': VoidCall;
|
|
12370
12857
|
'interop-client-get-info-for-context-group': VoidCall;
|
|
12858
|
+
'interop-client-fire-intent': VoidCall;
|
|
12859
|
+
'interop-client-register-intent-handler': VoidCall;
|
|
12860
|
+
'interop-client-get-current-context': VoidCall;
|
|
12861
|
+
'interop-client-get-info-for-intent': VoidCall;
|
|
12862
|
+
'interop-client-get-info-for-intents-by-context': VoidCall;
|
|
12863
|
+
'interop-client-fire-intent-for-context': VoidCall;
|
|
12864
|
+
'interop-client-add-ondisconnection-listener': VoidCall;
|
|
12371
12865
|
'interop-broker-add-client-to-context-group': VoidCall;
|
|
12372
12866
|
'interop-broker-get-all-clients-in-context-group': VoidCall;
|
|
12373
12867
|
'interop-broker-get-context-groups': VoidCall;
|
|
@@ -12379,13 +12873,100 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12379
12873
|
'interop-broker-remove-from-context-group': VoidCall;
|
|
12380
12874
|
'interop-broker-set-context': VoidCall;
|
|
12381
12875
|
'interop-broker-set-context-for-group': VoidCall;
|
|
12382
|
-
'
|
|
12383
|
-
|
|
12384
|
-
|
|
12385
|
-
|
|
12386
|
-
|
|
12387
|
-
|
|
12388
|
-
|
|
12876
|
+
'interop-broker-get-current-context': VoidCall;
|
|
12877
|
+
'interop-broker-set-intent-target': VoidCall;
|
|
12878
|
+
'interop-session-context-group-set-context': VoidCall;
|
|
12879
|
+
'interop-session-context-group-get-context': VoidCall;
|
|
12880
|
+
'interop-session-context-group-add-handler': VoidCall;
|
|
12881
|
+
'platform-wrap': VoidCall;
|
|
12882
|
+
'platform-wrap-sync': VoidCall;
|
|
12883
|
+
'platform-get-current': VoidCall;
|
|
12884
|
+
'platform-get-current-sync': VoidCall;
|
|
12885
|
+
'platform-start': VoidCall;
|
|
12886
|
+
'platform-start-from-manifest': VoidCall;
|
|
12887
|
+
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
12888
|
+
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
12889
|
+
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
12890
|
+
'platform-quit': ApplicationIdentityCall<{}, void>;
|
|
12891
|
+
'platform-close-view': ApplicationIdentityCall<{}, void>;
|
|
12892
|
+
'platform-reparent-view': ApplicationIdentityCall<{}, void>;
|
|
12893
|
+
'platform-get-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12894
|
+
'platform-apply-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12895
|
+
'platform-launch-content-manifest': ApplicationIdentityCall<{}, void>;
|
|
12896
|
+
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
12897
|
+
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
12898
|
+
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
12899
|
+
'layout-wrap': VoidCall;
|
|
12900
|
+
'layout-wrap-sync': VoidCall;
|
|
12901
|
+
'layout-get-current': VoidCall;
|
|
12902
|
+
'layout-get-current-sync': VoidCall;
|
|
12903
|
+
'layout-init': VoidCall;
|
|
12904
|
+
'layout-get-config': VoidCall;
|
|
12905
|
+
'layout-get-views': VoidCall;
|
|
12906
|
+
'layout-replace': VoidCall;
|
|
12907
|
+
'layout-get-root-item': VoidCall;
|
|
12908
|
+
'layout-replace-view': VoidCall;
|
|
12909
|
+
'layout-apply-preset': VoidCall;
|
|
12910
|
+
'layout-controller-get-root': VoidCall;
|
|
12911
|
+
'layout-controller-get-stack-by-view': VoidCall;
|
|
12912
|
+
'layout-controller-get-stack-views': VoidCall;
|
|
12913
|
+
'layout-controller-get-content': VoidCall;
|
|
12914
|
+
'layout-controller-get-parent': VoidCall;
|
|
12915
|
+
'layout-controller-is-root': VoidCall;
|
|
12916
|
+
'layout-controller-exists': VoidCall;
|
|
12917
|
+
'layout-controller-add-view-to-stack': VoidCall;
|
|
12918
|
+
'layout-controller-remove-view-from-stack': VoidCall;
|
|
12919
|
+
'layout-controller-create-adjacent-stack': VoidCall;
|
|
12920
|
+
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
12921
|
+
'layout-controller-set-stack-active-view': VoidCall;
|
|
12922
|
+
'snapshot-source-init': VoidCall;
|
|
12923
|
+
'snapshot-source-wrap-sync': VoidCall;
|
|
12924
|
+
'snapshot-source-wrap': VoidCall;
|
|
12925
|
+
'snapshot-source-ready': VoidCall;
|
|
12926
|
+
'snapshot-source-get-snapshot': VoidCall;
|
|
12927
|
+
'snapshot-source-apply-snapshot': VoidCall;
|
|
12928
|
+
'capture-page': IdentityCall<{
|
|
12929
|
+
options?: OpenFin.CapturePageOptions;
|
|
12930
|
+
}, string>;
|
|
12931
|
+
'execute-javascript-in-window': IdentityCall<{
|
|
12932
|
+
code: string;
|
|
12933
|
+
}, unknown>;
|
|
12934
|
+
'get-zoom-level': IdentityCall<{}, number>;
|
|
12935
|
+
'set-zoom-level': IdentityCall<{
|
|
12936
|
+
level: number;
|
|
12937
|
+
}, void>;
|
|
12938
|
+
'navigate-window': IdentityCall<{
|
|
12939
|
+
url: string;
|
|
12940
|
+
}, void>;
|
|
12941
|
+
'navigate-window-back': IdentityCall<{}, void>;
|
|
12942
|
+
'navigate-window-forward': IdentityCall<{}, void>;
|
|
12943
|
+
'stop-window-navigation': IdentityCall<{}, void>;
|
|
12944
|
+
'reload-window': IdentityCall<{
|
|
12945
|
+
ignoreCache: boolean;
|
|
12946
|
+
}, void>;
|
|
12947
|
+
'print': IdentityCall<{
|
|
12948
|
+
options: OpenFin.PrintOptions;
|
|
12949
|
+
}, void>;
|
|
12950
|
+
'find-in-page': IdentityCall<{
|
|
12951
|
+
searchTerm: string;
|
|
12952
|
+
options?: OpenFin.FindInPageOptions;
|
|
12953
|
+
}, void>;
|
|
12954
|
+
'stop-find-in-page': IdentityCall<{
|
|
12955
|
+
action: 'clearSelection' | 'keepSelection' | 'activateSelection';
|
|
12956
|
+
}, void>;
|
|
12957
|
+
'get-printers': IdentityCall<{}, OpenFin.PrinterInfo>;
|
|
12958
|
+
'focus-window': IdentityCall<{
|
|
12959
|
+
emitSynthFocused: boolean;
|
|
12960
|
+
}, void>;
|
|
12961
|
+
'get-process-info': IdentityCall<{}, OpenFin.EntityProcessDetails>;
|
|
12962
|
+
'get-shared-workers': IdentityCall<{}, OpenFin.SharedWorkerInfo[]>;
|
|
12963
|
+
'inspect-shared-worker': IdentityCall<{}, void>;
|
|
12964
|
+
'inspect-shared-worker-by-id': IdentityCall<{
|
|
12965
|
+
workerId: string;
|
|
12966
|
+
}, void>;
|
|
12967
|
+
'inspect-service-worker': IdentityCall<{}, void>;
|
|
12968
|
+
'view-show-popup-window': IdentityCall<{}, void>;
|
|
12969
|
+
'window-show-popup-window': IdentityCall<{}, void>;
|
|
12389
12970
|
'try-create-popup-window': {
|
|
12390
12971
|
request: OpenFin.Identity & {
|
|
12391
12972
|
options: OpenFin.PopupOptions;
|
|
@@ -12401,9 +12982,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12401
12982
|
};
|
|
12402
12983
|
response: OpenFin.PopupResult;
|
|
12403
12984
|
};
|
|
12404
|
-
'dispatch-popup-result': IdentityCall<{
|
|
12405
|
-
data: any;
|
|
12406
|
-
}>;
|
|
12407
12985
|
'render-overlay': {
|
|
12408
12986
|
request: {
|
|
12409
12987
|
bounds: OpenFin.Bounds;
|
|
@@ -12423,40 +13001,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12423
13001
|
};
|
|
12424
13002
|
response: void;
|
|
12425
13003
|
};
|
|
12426
|
-
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12427
|
-
'get-os-info': GetterCall<OpenFin.OSInfo>;
|
|
12428
|
-
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12429
|
-
'system-register-shutdown-handler': VoidCall;
|
|
12430
|
-
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12431
|
-
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12432
|
-
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12433
|
-
}, void>;
|
|
12434
|
-
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12435
|
-
deltaLeft: number;
|
|
12436
|
-
deltaTop: number;
|
|
12437
|
-
}>>;
|
|
12438
|
-
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12439
|
-
left: number;
|
|
12440
|
-
top: number;
|
|
12441
|
-
}>>;
|
|
12442
|
-
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12443
|
-
deltaWidth: number;
|
|
12444
|
-
deltaHeight: number;
|
|
12445
|
-
anchor: OpenFin.AnchorType;
|
|
12446
|
-
}>>;
|
|
12447
|
-
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12448
|
-
width: number;
|
|
12449
|
-
height: number;
|
|
12450
|
-
anchor: OpenFin.AnchorType;
|
|
12451
|
-
}>>;
|
|
12452
|
-
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12453
|
-
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12454
|
-
'unregister-custom-protocol': ApiCall<{
|
|
12455
|
-
protocolName: string;
|
|
12456
|
-
}, void>;
|
|
12457
|
-
'get-custom-protocol-state': ApiCall<{
|
|
12458
|
-
protocolName: string;
|
|
12459
|
-
}, OpenFin.CustomProtocolState>;
|
|
12460
13004
|
}
|
|
12461
13005
|
|
|
12462
13006
|
declare interface ProtocolMapBase {
|
|
@@ -12486,7 +13030,7 @@ declare type ProviderIdentity_3 = OpenFin.ProviderIdentity;
|
|
|
12486
13030
|
* Identity of a channel provider.
|
|
12487
13031
|
* @interface
|
|
12488
13032
|
*/
|
|
12489
|
-
declare type ProviderIdentity_4 =
|
|
13033
|
+
declare type ProviderIdentity_4 = Identity_4 & {
|
|
12490
13034
|
/**
|
|
12491
13035
|
* Identifier of the channel.
|
|
12492
13036
|
*/
|
|
@@ -12497,12 +13041,10 @@ declare type ProviderIdentity_4 = Identity_5 & {
|
|
|
12497
13041
|
channelName: string;
|
|
12498
13042
|
};
|
|
12499
13043
|
|
|
12500
|
-
declare type ProxyConfig = OpenFin.ProxyConfig;
|
|
12501
|
-
|
|
12502
13044
|
/**
|
|
12503
13045
|
* @interface
|
|
12504
13046
|
*/
|
|
12505
|
-
declare type
|
|
13047
|
+
declare type ProxyConfig = {
|
|
12506
13048
|
/**
|
|
12507
13049
|
* The configured proxy address.
|
|
12508
13050
|
*/
|
|
@@ -12514,13 +13056,11 @@ declare type ProxyConfig_2 = {
|
|
|
12514
13056
|
type: string;
|
|
12515
13057
|
};
|
|
12516
13058
|
|
|
12517
|
-
declare type ProxyInfo = OpenFin.ProxyInfo;
|
|
12518
|
-
|
|
12519
13059
|
/**
|
|
12520
13060
|
* @interface
|
|
12521
13061
|
*/
|
|
12522
|
-
declare type
|
|
12523
|
-
config:
|
|
13062
|
+
declare type ProxyInfo = {
|
|
13063
|
+
config: ProxyConfig;
|
|
12524
13064
|
system: ProxySystemInfo;
|
|
12525
13065
|
};
|
|
12526
13066
|
|
|
@@ -12626,12 +13166,10 @@ declare type RegisterUsageData = {
|
|
|
12626
13166
|
type: string;
|
|
12627
13167
|
};
|
|
12628
13168
|
|
|
12629
|
-
declare type RegistryInfo = OpenFin.RegistryInfo;
|
|
12630
|
-
|
|
12631
13169
|
/**
|
|
12632
13170
|
* @interface
|
|
12633
13171
|
*/
|
|
12634
|
-
declare type
|
|
13172
|
+
declare type RegistryInfo = {
|
|
12635
13173
|
data: any;
|
|
12636
13174
|
rootKey: string;
|
|
12637
13175
|
subkey: string;
|
|
@@ -12689,14 +13227,14 @@ declare type ReplaceLayoutPayload = {
|
|
|
12689
13227
|
/**
|
|
12690
13228
|
* Identity of the window whose layout will be replaced.
|
|
12691
13229
|
*/
|
|
12692
|
-
target:
|
|
13230
|
+
target: Identity_4 | LayoutIdentity;
|
|
12693
13231
|
};
|
|
12694
13232
|
|
|
12695
13233
|
/**
|
|
12696
13234
|
* @interface
|
|
12697
13235
|
*/
|
|
12698
13236
|
declare type ReplaceViewOptions = {
|
|
12699
|
-
viewToReplace:
|
|
13237
|
+
viewToReplace: Identity_4;
|
|
12700
13238
|
newView: ViewState;
|
|
12701
13239
|
};
|
|
12702
13240
|
|
|
@@ -12705,7 +13243,7 @@ declare type ReplaceViewOptions = {
|
|
|
12705
13243
|
*/
|
|
12706
13244
|
declare type ReplaceViewPayload = {
|
|
12707
13245
|
opts: {
|
|
12708
|
-
viewToReplace:
|
|
13246
|
+
viewToReplace: Identity_4;
|
|
12709
13247
|
newView: Partial<ViewOptions>;
|
|
12710
13248
|
};
|
|
12711
13249
|
target: LayoutIdentity;
|
|
@@ -13071,7 +13609,7 @@ declare type SetWindowContextPayload = {
|
|
|
13071
13609
|
/**
|
|
13072
13610
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
13073
13611
|
*/
|
|
13074
|
-
target:
|
|
13612
|
+
target: Identity_4;
|
|
13075
13613
|
};
|
|
13076
13614
|
|
|
13077
13615
|
/**
|
|
@@ -13521,7 +14059,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13521
14059
|
* fin.System.getAllWindows().then(wins => console.log(wins)).catch(err => console.log(err));
|
|
13522
14060
|
* ```
|
|
13523
14061
|
*/
|
|
13524
|
-
getAllWindows(): Promise<Array<ApplicationWindowInfo>>;
|
|
14062
|
+
getAllWindows(): Promise<Array<OpenFin.ApplicationWindowInfo>>;
|
|
13525
14063
|
/**
|
|
13526
14064
|
* Retrieves an array of data for all applications.
|
|
13527
14065
|
*
|
|
@@ -13530,7 +14068,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13530
14068
|
* fin.System.getAllApplications().then(apps => console.log(apps)).catch(err => console.log(err));
|
|
13531
14069
|
* ```
|
|
13532
14070
|
*/
|
|
13533
|
-
getAllApplications(): Promise<Array<ApplicationState>>;
|
|
14071
|
+
getAllApplications(): Promise<Array<OpenFin.ApplicationState>>;
|
|
13534
14072
|
/**
|
|
13535
14073
|
* Retrieves the command line argument string that started OpenFin Runtime.
|
|
13536
14074
|
*
|
|
@@ -13605,7 +14143,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13605
14143
|
* }
|
|
13606
14144
|
* ```
|
|
13607
14145
|
*/
|
|
13608
|
-
getEntityInfo(uuid: string, name: string): Promise<EntityInfo>;
|
|
14146
|
+
getEntityInfo(uuid: string, name: string): Promise<OpenFin.EntityInfo>;
|
|
13609
14147
|
/**
|
|
13610
14148
|
* Gets the value of a given environment variable on the computer on which the runtime is installed
|
|
13611
14149
|
*
|
|
@@ -13647,7 +14185,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13647
14185
|
* ```
|
|
13648
14186
|
*/
|
|
13649
14187
|
getInstalledRuntimes(): Promise<string[]>;
|
|
13650
|
-
getInstalledApps(): Promise<InstalledApps>;
|
|
14188
|
+
getInstalledApps(): Promise<OpenFin.InstalledApps>;
|
|
13651
14189
|
/**
|
|
13652
14190
|
* Retrieves the contents of the log with the specified filename.
|
|
13653
14191
|
* @param options A object that id defined by the GetLogRequestType interface
|
|
@@ -13662,7 +14200,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13662
14200
|
* getLog().then(log => console.log(log)).catch(err => console.log(err));
|
|
13663
14201
|
* ```
|
|
13664
14202
|
*/
|
|
13665
|
-
getLog(options: GetLogRequestType): Promise<string>;
|
|
14203
|
+
getLog(options: OpenFin.GetLogRequestType): Promise<string>;
|
|
13666
14204
|
/**
|
|
13667
14205
|
* Returns a unique identifier (UUID) provided by the machine.
|
|
13668
14206
|
*
|
|
@@ -13680,7 +14218,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13680
14218
|
* fin.System.getMinLogLevel().then(level => console.log(level)).catch(err => console.log(err));
|
|
13681
14219
|
* ```
|
|
13682
14220
|
*/
|
|
13683
|
-
getMinLogLevel(): Promise<LogLevel>;
|
|
14221
|
+
getMinLogLevel(): Promise<OpenFin.LogLevel>;
|
|
13684
14222
|
/**
|
|
13685
14223
|
* Retrieves an array containing information for each log file.
|
|
13686
14224
|
*
|
|
@@ -13689,7 +14227,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13689
14227
|
* fin.System.getLogList().then(logList => console.log(logList)).catch(err => console.log(err));
|
|
13690
14228
|
* ```
|
|
13691
14229
|
*/
|
|
13692
|
-
getLogList(): Promise<Array<LogInfo>>;
|
|
14230
|
+
getLogList(): Promise<Array<OpenFin.LogInfo>>;
|
|
13693
14231
|
/**
|
|
13694
14232
|
* Retrieves an object that contains data about the monitor setup of the
|
|
13695
14233
|
* computer that the runtime is running on.
|
|
@@ -13760,7 +14298,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13760
14298
|
* }
|
|
13761
14299
|
* ```
|
|
13762
14300
|
*/
|
|
13763
|
-
getProxySettings(): Promise<ProxyInfo>;
|
|
14301
|
+
getProxySettings(): Promise<OpenFin.ProxyInfo>;
|
|
13764
14302
|
/**
|
|
13765
14303
|
* Returns information about the running Runtime in an object.
|
|
13766
14304
|
*
|
|
@@ -14127,7 +14665,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14127
14665
|
* }
|
|
14128
14666
|
* ```
|
|
14129
14667
|
*/
|
|
14130
|
-
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<
|
|
14668
|
+
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<Identity>;
|
|
14131
14669
|
/**
|
|
14132
14670
|
* Monitors a running process. A pid for the process must be included in options.
|
|
14133
14671
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -14144,7 +14682,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14144
14682
|
* }).then(processIdentity => console.log(processIdentity)).catch(err => console.log(err));
|
|
14145
14683
|
* ```
|
|
14146
14684
|
*/
|
|
14147
|
-
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<
|
|
14685
|
+
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<Identity>;
|
|
14148
14686
|
/**
|
|
14149
14687
|
* Writes the passed message into both the log file and the console.
|
|
14150
14688
|
* @param level The log level for the entry. Can be either "info", "warning" or "error"
|
|
@@ -14278,7 +14816,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14278
14816
|
*
|
|
14279
14817
|
* @tutorial System.showDeveloperTools
|
|
14280
14818
|
*/
|
|
14281
|
-
showDeveloperTools(identity:
|
|
14819
|
+
showDeveloperTools(identity: Identity): Promise<void>;
|
|
14282
14820
|
/**
|
|
14283
14821
|
* Attempt to close an external process. The process will be terminated if it
|
|
14284
14822
|
* has not closed after the elapsed timeout in milliseconds.
|
|
@@ -14312,7 +14850,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14312
14850
|
* .catch(err => console.error(err));
|
|
14313
14851
|
* ```
|
|
14314
14852
|
*/
|
|
14315
|
-
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
14853
|
+
updateProxySettings(options: OpenFin.ProxyConfig): Promise<void>;
|
|
14316
14854
|
/**
|
|
14317
14855
|
* Downloads the given application asset.
|
|
14318
14856
|
*
|
|
@@ -14404,7 +14942,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14404
14942
|
* .catch(err => console.log(err));
|
|
14405
14943
|
* ```
|
|
14406
14944
|
*/
|
|
14407
|
-
getAllExternalApplications(): Promise<Array<
|
|
14945
|
+
getAllExternalApplications(): Promise<Array<Identity>>;
|
|
14408
14946
|
/**
|
|
14409
14947
|
* Retrieves app asset information.
|
|
14410
14948
|
* @param options
|
|
@@ -14433,7 +14971,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14433
14971
|
* fin.System.setMinLogLevel("verbose").then(() => console.log("log level is set to verbose")).catch(err => console.log(err));
|
|
14434
14972
|
* ```
|
|
14435
14973
|
*/
|
|
14436
|
-
setMinLogLevel(level: LogLevel): Promise<void>;
|
|
14974
|
+
setMinLogLevel(level: OpenFin.LogLevel): Promise<void>;
|
|
14437
14975
|
/**
|
|
14438
14976
|
* Retrieves the UUID of the computer on which the runtime is installed
|
|
14439
14977
|
* @param uuid The uuid of the running application
|
|
@@ -14443,7 +14981,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14443
14981
|
* fin.System.resolveUuid('OpenfinPOC').then(entity => console.log(entity)).catch(err => console.log(err));
|
|
14444
14982
|
* ```
|
|
14445
14983
|
*/
|
|
14446
|
-
resolveUuid(uuid: string): Promise<
|
|
14984
|
+
resolveUuid(uuid: string): Promise<OpenFin.ApplicationType>;
|
|
14447
14985
|
/**
|
|
14448
14986
|
* Retrieves an array of data for all external applications
|
|
14449
14987
|
* @param requestingIdentity This object is described in the Identity typedef
|
|
@@ -14451,7 +14989,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14451
14989
|
*
|
|
14452
14990
|
* @ignore
|
|
14453
14991
|
*/
|
|
14454
|
-
executeOnRemote(requestingIdentity:
|
|
14992
|
+
executeOnRemote(requestingIdentity: Identity, data: any): Promise<any>;
|
|
14455
14993
|
/**
|
|
14456
14994
|
* Reads the specifed value from the registry.
|
|
14457
14995
|
* @remarks This method is restricted by default and must be enabled via
|
|
@@ -14544,7 +15082,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14544
15082
|
* }
|
|
14545
15083
|
* ```
|
|
14546
15084
|
*/
|
|
14547
|
-
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<RegistryInfo>;
|
|
15085
|
+
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<OpenFin.RegistryInfo>;
|
|
14548
15086
|
/**
|
|
14549
15087
|
* This function call will register a unique id and produce a token.
|
|
14550
15088
|
* The token can be used to broker an external connection.
|
|
@@ -14759,7 +15297,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14759
15297
|
* });
|
|
14760
15298
|
* ```
|
|
14761
15299
|
*/
|
|
14762
|
-
getPrinters(): Promise<PrinterInfo[]>;
|
|
15300
|
+
getPrinters(): Promise<OpenFin.PrinterInfo[]>;
|
|
14763
15301
|
/**
|
|
14764
15302
|
* Updates Process Logging values: periodic interval and outlier detection entries and interval.
|
|
14765
15303
|
* @param options Process Logging updatable options.
|
|
@@ -15385,14 +15923,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
15385
15923
|
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
|
15386
15924
|
|
|
15387
15925
|
/**
|
|
15388
|
-
*
|
|
15926
|
+
* An event that fires when a window's bounds are changed directly by the user.
|
|
15927
|
+
*
|
|
15389
15928
|
* @interface
|
|
15390
15929
|
*/
|
|
15391
|
-
declare type UserBoundsChangeEvent =
|
|
15392
|
-
height: number;
|
|
15393
|
-
left: number;
|
|
15394
|
-
top: number;
|
|
15395
|
-
width: number;
|
|
15930
|
+
declare type UserBoundsChangeEvent = BoundsEvent & {
|
|
15396
15931
|
windowState: 'minimized' | 'normal' | 'maximized';
|
|
15397
15932
|
};
|
|
15398
15933
|
|
|
@@ -15830,7 +16365,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
15830
16365
|
*/
|
|
15831
16366
|
getInfo: () => Promise<OpenFin.ViewInfo>;
|
|
15832
16367
|
/**
|
|
15833
|
-
* Retrieves the
|
|
16368
|
+
* Retrieves the OpenFin.Layout instance for the Window the View is attached to.
|
|
15834
16369
|
*
|
|
15835
16370
|
* @example
|
|
15836
16371
|
* ```js
|
|
@@ -16028,6 +16563,24 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
16028
16563
|
options?: Partial<ViewOptions>;
|
|
16029
16564
|
};
|
|
16030
16565
|
|
|
16566
|
+
/**
|
|
16567
|
+
* @interface
|
|
16568
|
+
*/
|
|
16569
|
+
declare type ViewCreationFailure = {
|
|
16570
|
+
/**
|
|
16571
|
+
* The identity of the created view
|
|
16572
|
+
*/
|
|
16573
|
+
identity: Identity_4;
|
|
16574
|
+
/**
|
|
16575
|
+
* Whether the view was created with errors
|
|
16576
|
+
*/
|
|
16577
|
+
success: false;
|
|
16578
|
+
/**
|
|
16579
|
+
* Error thrown during view creation
|
|
16580
|
+
*/
|
|
16581
|
+
error: Error;
|
|
16582
|
+
};
|
|
16583
|
+
|
|
16031
16584
|
/**
|
|
16032
16585
|
* The options object required by {@link View.ViewModule.create View.create}.
|
|
16033
16586
|
*
|
|
@@ -16038,11 +16591,30 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
16038
16591
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
16039
16592
|
name: string;
|
|
16040
16593
|
url: string;
|
|
16041
|
-
target:
|
|
16594
|
+
target: Identity_4;
|
|
16042
16595
|
};
|
|
16043
16596
|
|
|
16044
16597
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
|
16045
16598
|
|
|
16599
|
+
/**
|
|
16600
|
+
* A view creation state
|
|
16601
|
+
*/
|
|
16602
|
+
declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
|
|
16603
|
+
|
|
16604
|
+
/**
|
|
16605
|
+
* @interface
|
|
16606
|
+
*/
|
|
16607
|
+
declare type ViewCreationSuccess = {
|
|
16608
|
+
/**
|
|
16609
|
+
* The identity of the created view
|
|
16610
|
+
*/
|
|
16611
|
+
identity: Identity_4;
|
|
16612
|
+
/**
|
|
16613
|
+
* Whether the view was created without errors
|
|
16614
|
+
*/
|
|
16615
|
+
success: true;
|
|
16616
|
+
};
|
|
16617
|
+
|
|
16046
16618
|
/**
|
|
16047
16619
|
* Generated when a window has a view detached from it.
|
|
16048
16620
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
@@ -16224,15 +16796,15 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
16224
16796
|
/**
|
|
16225
16797
|
* Identity of the Window.
|
|
16226
16798
|
*/
|
|
16227
|
-
windowId:
|
|
16799
|
+
windowId: Identity_4;
|
|
16228
16800
|
/**
|
|
16229
16801
|
* Identities of the Views that are preventing an unload
|
|
16230
16802
|
*/
|
|
16231
|
-
viewsPreventingUnload:
|
|
16803
|
+
viewsPreventingUnload: Identity_4[];
|
|
16232
16804
|
/**
|
|
16233
16805
|
* Identities of the Views that are not preventing an unload
|
|
16234
16806
|
*/
|
|
16235
|
-
viewsNotPreventingUnload:
|
|
16807
|
+
viewsNotPreventingUnload: Identity_4[];
|
|
16236
16808
|
/**
|
|
16237
16809
|
* Source of the close action.
|
|
16238
16810
|
*/
|
|
@@ -16257,11 +16829,11 @@ declare interface ViewStatuses {
|
|
|
16257
16829
|
/**
|
|
16258
16830
|
* Identities of the Views that are preventing an unload.
|
|
16259
16831
|
*/
|
|
16260
|
-
viewsPreventingUnload:
|
|
16832
|
+
viewsPreventingUnload: Identity_4[];
|
|
16261
16833
|
/**
|
|
16262
16834
|
* Identities of the Views that are not preventing an unload.
|
|
16263
16835
|
*/
|
|
16264
|
-
viewsNotPreventingUnload:
|
|
16836
|
+
viewsNotPreventingUnload: Identity_4[];
|
|
16265
16837
|
}
|
|
16266
16838
|
|
|
16267
16839
|
/**
|
|
@@ -16766,7 +17338,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
16766
17338
|
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
16767
17339
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
16768
17340
|
*/
|
|
16769
|
-
stopFindInPage(action:
|
|
17341
|
+
stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): Promise<void>;
|
|
16770
17342
|
/**
|
|
16771
17343
|
* Returns an array with all system printers
|
|
16772
17344
|
* @deprecated use System.getPrinters instead
|
|
@@ -17359,11 +17931,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
17359
17931
|
* A general will-move or will-resize event without event type.
|
|
17360
17932
|
* @interface
|
|
17361
17933
|
*/
|
|
17362
|
-
declare type WillMoveOrResizeEvent =
|
|
17363
|
-
height: number;
|
|
17364
|
-
left: number;
|
|
17365
|
-
top: number;
|
|
17366
|
-
width: number;
|
|
17934
|
+
declare type WillMoveOrResizeEvent = BoundsEvent & {
|
|
17367
17935
|
monitorScaleFactor: number;
|
|
17368
17936
|
};
|
|
17369
17937
|
|
|
@@ -18558,16 +19126,21 @@ declare namespace WindowEvents {
|
|
|
18558
19126
|
PreloadScriptInfoRunning,
|
|
18559
19127
|
PreloadScriptInfo,
|
|
18560
19128
|
PreloadScriptsStateChangeEvent,
|
|
18561
|
-
|
|
19129
|
+
BoundsEvent,
|
|
18562
19130
|
BoundsChangeEvent,
|
|
18563
19131
|
WillMoveOrResizeEvent,
|
|
19132
|
+
BoundsDidChangeEvent,
|
|
19133
|
+
BoundsChangedEvent,
|
|
19134
|
+
BoundsChangingEvent,
|
|
19135
|
+
DisabledMovementBoundsChangedEvent,
|
|
19136
|
+
DisabledMovementBoundsChangingEvent,
|
|
19137
|
+
UserBoundsChangeEvent,
|
|
19138
|
+
BeginUserBoundsChangingEvent,
|
|
19139
|
+
EndUserBoundsChangingEvent,
|
|
18564
19140
|
PerformanceReportEvent,
|
|
18565
19141
|
InputEvent_2 as InputEvent,
|
|
18566
19142
|
LayoutInitializedEvent,
|
|
18567
19143
|
LayoutReadyEvent,
|
|
18568
|
-
BeginUserBoundsChangingEvent,
|
|
18569
|
-
BoundsChangedEvent,
|
|
18570
|
-
BoundsChangingEvent,
|
|
18571
19144
|
CloseRequestedEvent,
|
|
18572
19145
|
WindowCloseRequestedEvent,
|
|
18573
19146
|
ContextChangedEvent,
|
|
@@ -18575,10 +19148,7 @@ declare namespace WindowEvents {
|
|
|
18575
19148
|
WindowClosedEvent,
|
|
18576
19149
|
ClosingEvent,
|
|
18577
19150
|
WindowClosingEvent,
|
|
18578
|
-
DisabledMovementBoundsChangedEvent,
|
|
18579
|
-
DisabledMovementBoundsChangingEvent,
|
|
18580
19151
|
EmbeddedEvent,
|
|
18581
|
-
EndUserBoundsChangingEvent,
|
|
18582
19152
|
HotkeyEvent_2 as HotkeyEvent,
|
|
18583
19153
|
WindowHotkeyEvent,
|
|
18584
19154
|
InitializedEvent_2 as InitializedEvent,
|