@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-public.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
|
/**
|
|
@@ -930,15 +930,15 @@ declare namespace ApplicationEvents {
|
|
|
930
930
|
*/
|
|
931
931
|
declare type ApplicationEventType = EventType_3;
|
|
932
932
|
|
|
933
|
-
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
|
934
|
-
|
|
935
933
|
/**
|
|
936
934
|
* @interface
|
|
937
935
|
*/
|
|
938
|
-
declare type
|
|
936
|
+
declare type ApplicationIdentity = {
|
|
939
937
|
uuid: string;
|
|
940
938
|
};
|
|
941
939
|
|
|
940
|
+
declare type ApplicationIdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.ApplicationIdentity, Response>;
|
|
941
|
+
|
|
942
942
|
/**
|
|
943
943
|
* @interface
|
|
944
944
|
*/
|
|
@@ -1311,12 +1311,10 @@ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedE
|
|
|
1311
1311
|
*/
|
|
1312
1312
|
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1313
1313
|
|
|
1314
|
-
declare type ApplicationState = OpenFin.ApplicationState;
|
|
1315
|
-
|
|
1316
1314
|
/**
|
|
1317
1315
|
* @interface
|
|
1318
1316
|
*/
|
|
1319
|
-
declare type
|
|
1317
|
+
declare type ApplicationState = {
|
|
1320
1318
|
/**
|
|
1321
1319
|
* True when the application is a Platform controller
|
|
1322
1320
|
*/
|
|
@@ -1348,12 +1346,10 @@ declare type ApplicationType = {
|
|
|
1348
1346
|
*/
|
|
1349
1347
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
|
1350
1348
|
|
|
1351
|
-
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
|
1352
|
-
|
|
1353
1349
|
/**
|
|
1354
1350
|
* @interface
|
|
1355
1351
|
*/
|
|
1356
|
-
declare type
|
|
1352
|
+
declare type ApplicationWindowInfo = {
|
|
1357
1353
|
childWindows: Array<WindowDetail>;
|
|
1358
1354
|
mainWindow: WindowDetail;
|
|
1359
1355
|
/**
|
|
@@ -1615,7 +1611,7 @@ declare class Base {
|
|
|
1615
1611
|
* @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
|
|
1616
1612
|
* guaranteed to behave sensibly in all calling contexts.
|
|
1617
1613
|
*/
|
|
1618
|
-
get me(): Identity;
|
|
1614
|
+
get me(): OpenFin.Identity;
|
|
1619
1615
|
/* Excluded from this release type: isNodeEnvironment */
|
|
1620
1616
|
/* Excluded from this release type: isOpenFinEnvironment */
|
|
1621
1617
|
/* Excluded from this release type: isBrowserEnvironment */
|
|
@@ -1835,11 +1831,12 @@ declare type BeforeUnloadUserDecision = {
|
|
|
1835
1831
|
/**
|
|
1836
1832
|
* Array of views that will close.
|
|
1837
1833
|
*/
|
|
1838
|
-
viewsToClose:
|
|
1834
|
+
viewsToClose: Identity_4[];
|
|
1839
1835
|
};
|
|
1840
1836
|
|
|
1841
1837
|
/**
|
|
1842
1838
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
|
1839
|
+
*
|
|
1843
1840
|
* @interface
|
|
1844
1841
|
*/
|
|
1845
1842
|
declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
@@ -1880,31 +1877,33 @@ declare type Bounds = {
|
|
|
1880
1877
|
* Generated after changes in a window's size and/or position.
|
|
1881
1878
|
* @interface
|
|
1882
1879
|
*/
|
|
1883
|
-
declare type BoundsChangedEvent =
|
|
1880
|
+
declare type BoundsChangedEvent = BoundsDidChangeEvent & {
|
|
1884
1881
|
type: 'bounds-changed';
|
|
1885
1882
|
};
|
|
1886
1883
|
|
|
1887
|
-
|
|
1888
|
-
* A general bounds change event without event type.
|
|
1889
|
-
* @interface
|
|
1890
|
-
*/
|
|
1891
|
-
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1884
|
+
declare type BoundsChangeEvent = BoundsEvent & {
|
|
1892
1885
|
changeType: 0 | 1 | 2;
|
|
1893
|
-
deferred: boolean;
|
|
1894
|
-
height: number;
|
|
1895
|
-
left: number;
|
|
1896
|
-
top: number;
|
|
1897
|
-
width: number;
|
|
1898
1886
|
};
|
|
1899
1887
|
|
|
1900
1888
|
/**
|
|
1901
1889
|
* Generated during changes to a window's size and/or position.
|
|
1902
1890
|
* @interface
|
|
1903
1891
|
*/
|
|
1904
|
-
declare type BoundsChangingEvent =
|
|
1892
|
+
declare type BoundsChangingEvent = BoundsDidChangeEvent & {
|
|
1905
1893
|
type: 'bounds-changing';
|
|
1906
1894
|
};
|
|
1907
1895
|
|
|
1896
|
+
/**
|
|
1897
|
+
* An event that fires when a window's bounds are successfully changed.
|
|
1898
|
+
*
|
|
1899
|
+
* @interface
|
|
1900
|
+
*/
|
|
1901
|
+
declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
1902
|
+
reason: 'self' | 'animation';
|
|
1903
|
+
};
|
|
1904
|
+
|
|
1905
|
+
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1906
|
+
|
|
1908
1907
|
/**
|
|
1909
1908
|
* A rule prescribing content creation in the browser.
|
|
1910
1909
|
*
|
|
@@ -2986,7 +2985,7 @@ declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
|
2986
2985
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
2987
2986
|
* @interface
|
|
2988
2987
|
*/
|
|
2989
|
-
declare type ClientIdentity =
|
|
2988
|
+
declare type ClientIdentity = Identity_4 & {
|
|
2990
2989
|
/**
|
|
2991
2990
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
|
2992
2991
|
*/
|
|
@@ -3219,7 +3218,7 @@ declare type CloseViewOptions = {
|
|
|
3219
3218
|
/**
|
|
3220
3219
|
*View to be closed.
|
|
3221
3220
|
*/
|
|
3222
|
-
viewIdentity:
|
|
3221
|
+
viewIdentity: Identity_4;
|
|
3223
3222
|
};
|
|
3224
3223
|
|
|
3225
3224
|
/**
|
|
@@ -3229,7 +3228,7 @@ declare type CloseViewPayload = {
|
|
|
3229
3228
|
/**
|
|
3230
3229
|
*View to be closed.
|
|
3231
3230
|
*/
|
|
3232
|
-
view:
|
|
3231
|
+
view: Identity_4;
|
|
3233
3232
|
/**
|
|
3234
3233
|
* The target layout identity where this view should be closed. If not provided, will resolve to the
|
|
3235
3234
|
* visible layout.
|
|
@@ -3247,7 +3246,7 @@ declare interface CloseWindowPayload {
|
|
|
3247
3246
|
*
|
|
3248
3247
|
* Identity of the Window
|
|
3249
3248
|
*/
|
|
3250
|
-
windowId:
|
|
3249
|
+
windowId: Identity_4;
|
|
3251
3250
|
options: {
|
|
3252
3251
|
/**
|
|
3253
3252
|
* @defaultValue false
|
|
@@ -3365,7 +3364,7 @@ declare type ConstViewOptions = {
|
|
|
3365
3364
|
/**
|
|
3366
3365
|
* The identity of the window this view should be attached to.
|
|
3367
3366
|
*/
|
|
3368
|
-
target:
|
|
3367
|
+
target: Identity_4;
|
|
3369
3368
|
/**
|
|
3370
3369
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3371
3370
|
*/
|
|
@@ -3590,7 +3589,7 @@ declare type ConstWindowOptions = {
|
|
|
3590
3589
|
/**
|
|
3591
3590
|
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
3592
3591
|
*/
|
|
3593
|
-
modalParentIdentity:
|
|
3592
|
+
modalParentIdentity: Identity_4;
|
|
3594
3593
|
/**
|
|
3595
3594
|
* The name of the window.
|
|
3596
3595
|
*/
|
|
@@ -3608,7 +3607,9 @@ declare type ConstWindowOptions = {
|
|
|
3608
3607
|
*/
|
|
3609
3608
|
preloadScripts: PreloadScript[];
|
|
3610
3609
|
/**
|
|
3611
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
3610
|
+
* String tag that attempts to group like-tagged renderers together.
|
|
3611
|
+
* 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.
|
|
3612
|
+
* @remarks Will only be used if pages are on the same origin.
|
|
3612
3613
|
*/
|
|
3613
3614
|
processAffinity: string;
|
|
3614
3615
|
/**
|
|
@@ -3655,11 +3656,6 @@ declare type ConstWindowOptions = {
|
|
|
3655
3656
|
* @deprecated - use `icon` instead.
|
|
3656
3657
|
*/
|
|
3657
3658
|
taskbarIcon: string;
|
|
3658
|
-
/**
|
|
3659
|
-
* Specify a taskbar group for the window.
|
|
3660
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
3661
|
-
*/
|
|
3662
|
-
taskbarIconGroup: string;
|
|
3663
3659
|
/**
|
|
3664
3660
|
* @defaultValue "about:blank"
|
|
3665
3661
|
*
|
|
@@ -4074,13 +4070,13 @@ declare type CreateViewPayload = {
|
|
|
4074
4070
|
* Window the view will be added to. If no target is provided, a new window will be created.
|
|
4075
4071
|
*/
|
|
4076
4072
|
target?: CreateViewTarget;
|
|
4077
|
-
targetView?:
|
|
4073
|
+
targetView?: Identity_4;
|
|
4078
4074
|
};
|
|
4079
4075
|
|
|
4080
4076
|
/**
|
|
4081
4077
|
* @interface
|
|
4082
4078
|
*/
|
|
4083
|
-
declare type CreateViewTarget = (
|
|
4079
|
+
declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
|
|
4084
4080
|
/**
|
|
4085
4081
|
* If specified, view creation will not attach to a window and caller must
|
|
4086
4082
|
* insert the view into the layout explicitly
|
|
@@ -4526,7 +4522,7 @@ declare type EmitterAccessor = string[];
|
|
|
4526
4522
|
declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType extends EmitterEvent['type'] = EmitterEvent['type']> extends Base {
|
|
4527
4523
|
#private;
|
|
4528
4524
|
private topic;
|
|
4529
|
-
protected identity: ApplicationIdentity;
|
|
4525
|
+
protected identity: OpenFin.ApplicationIdentity;
|
|
4530
4526
|
constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
|
|
4531
4527
|
eventNames: () => (string | symbol)[];
|
|
4532
4528
|
/* Excluded from this release type: emit */
|
|
@@ -4601,20 +4597,17 @@ declare type EndLoadEvent = BaseEvent_5 & {
|
|
|
4601
4597
|
|
|
4602
4598
|
/**
|
|
4603
4599
|
* Generated at the end of a user-driven change to a window's size or position.
|
|
4600
|
+
*
|
|
4604
4601
|
* @interface
|
|
4605
4602
|
*/
|
|
4606
4603
|
declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
4607
4604
|
type: 'end-user-bounds-changing';
|
|
4608
4605
|
};
|
|
4609
4606
|
|
|
4610
|
-
declare type Entity = OpenFin.ApplicationType;
|
|
4611
|
-
|
|
4612
|
-
declare type EntityInfo = OpenFin.EntityInfo;
|
|
4613
|
-
|
|
4614
4607
|
/**
|
|
4615
4608
|
* @interface
|
|
4616
4609
|
*/
|
|
4617
|
-
declare type
|
|
4610
|
+
declare type EntityInfo = {
|
|
4618
4611
|
uuid: string;
|
|
4619
4612
|
name: string;
|
|
4620
4613
|
entityType: EntityType_4;
|
|
@@ -4700,6 +4693,7 @@ declare interface Environment {
|
|
|
4700
4693
|
getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
|
|
4701
4694
|
fdc3Version?: Version;
|
|
4702
4695
|
}>;
|
|
4696
|
+
getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
|
|
4703
4697
|
readonly type: EnvironmentType;
|
|
4704
4698
|
}
|
|
4705
4699
|
|
|
@@ -4963,7 +4957,7 @@ declare type ExternalApplicationEventType = EventType_4;
|
|
|
4963
4957
|
* @interface
|
|
4964
4958
|
*/
|
|
4965
4959
|
declare type ExternalApplicationInfo = {
|
|
4966
|
-
parent:
|
|
4960
|
+
parent: Identity_4;
|
|
4967
4961
|
};
|
|
4968
4962
|
|
|
4969
4963
|
/**
|
|
@@ -5768,7 +5762,7 @@ declare type FrameInfo = {
|
|
|
5768
5762
|
uuid: string;
|
|
5769
5763
|
url: string;
|
|
5770
5764
|
entityType: EntityType_4;
|
|
5771
|
-
parent:
|
|
5765
|
+
parent: Identity_4;
|
|
5772
5766
|
};
|
|
5773
5767
|
|
|
5774
5768
|
/**
|
|
@@ -5843,12 +5837,10 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
5843
5837
|
entityType: string;
|
|
5844
5838
|
};
|
|
5845
5839
|
|
|
5846
|
-
declare type GetLogRequestType = OpenFin.GetLogRequestType;
|
|
5847
|
-
|
|
5848
5840
|
/**
|
|
5849
5841
|
* @interface
|
|
5850
5842
|
*/
|
|
5851
|
-
declare type
|
|
5843
|
+
declare type GetLogRequestType = {
|
|
5852
5844
|
/**
|
|
5853
5845
|
* The name of the running application
|
|
5854
5846
|
*/
|
|
@@ -5868,7 +5860,7 @@ declare type GetWindowContextPayload = {
|
|
|
5868
5860
|
/**
|
|
5869
5861
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
5870
5862
|
*/
|
|
5871
|
-
target:
|
|
5863
|
+
target: Identity_4;
|
|
5872
5864
|
};
|
|
5873
5865
|
|
|
5874
5866
|
/**
|
|
@@ -6134,8 +6126,6 @@ declare type Identity_2 = OpenFin.Identity;
|
|
|
6134
6126
|
|
|
6135
6127
|
declare type Identity_3 = OpenFin.Identity;
|
|
6136
6128
|
|
|
6137
|
-
declare type Identity_4 = OpenFin.Identity;
|
|
6138
|
-
|
|
6139
6129
|
/**
|
|
6140
6130
|
* Unique identifier for a window, view or iframe.
|
|
6141
6131
|
*
|
|
@@ -6144,7 +6134,7 @@ declare type Identity_4 = OpenFin.Identity;
|
|
|
6144
6134
|
*
|
|
6145
6135
|
* @interface
|
|
6146
6136
|
*/
|
|
6147
|
-
declare type
|
|
6137
|
+
declare type Identity_4 = {
|
|
6148
6138
|
/**
|
|
6149
6139
|
* Universally unique identifier of the application that owns the component.
|
|
6150
6140
|
*/
|
|
@@ -6303,12 +6293,10 @@ declare type InstallationInfo = {
|
|
|
6303
6293
|
cachedManifest: any;
|
|
6304
6294
|
};
|
|
6305
6295
|
|
|
6306
|
-
declare type InstalledApps = OpenFin.InstalledApps;
|
|
6307
|
-
|
|
6308
6296
|
/**
|
|
6309
6297
|
* @interface
|
|
6310
6298
|
*/
|
|
6311
|
-
declare type
|
|
6299
|
+
declare type InstalledApps = {
|
|
6312
6300
|
[key: string]: InstallationInfo;
|
|
6313
6301
|
};
|
|
6314
6302
|
|
|
@@ -7079,7 +7067,7 @@ declare class InteropBroker extends Base {
|
|
|
7079
7067
|
* @param _id the identity tryinc to connect
|
|
7080
7068
|
* @param _connectionPayload optional payload to use in custom implementations, will be undefined by default
|
|
7081
7069
|
*/
|
|
7082
|
-
isConnectionAuthorized(_id:
|
|
7070
|
+
isConnectionAuthorized(_id: Identity_2, _connectionPayload?: any): Promise<boolean> | boolean;
|
|
7083
7071
|
/**
|
|
7084
7072
|
* Called before every action to check if this entity should be allowed to take the action.
|
|
7085
7073
|
* Return false to prevent the action
|
|
@@ -7872,6 +7860,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7872
7860
|
*/
|
|
7873
7861
|
declare class Layout extends Base {
|
|
7874
7862
|
#private;
|
|
7863
|
+
/* Excluded from this release type: getClient */
|
|
7875
7864
|
/* Excluded from this release type: init */
|
|
7876
7865
|
identity: OpenFin.Identity | OpenFin.LayoutIdentity;
|
|
7877
7866
|
private platform;
|
|
@@ -7971,6 +7960,17 @@ declare class Layout extends Base {
|
|
|
7971
7960
|
* ```
|
|
7972
7961
|
*/
|
|
7973
7962
|
getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
|
|
7963
|
+
/**
|
|
7964
|
+
* Retrieves the OpenFin.TabStack instance which the View belongs to.
|
|
7965
|
+
*
|
|
7966
|
+
* @example
|
|
7967
|
+
* ```js
|
|
7968
|
+
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
|
7969
|
+
* const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
|
|
7970
|
+
* console.log(await stack.getViews());
|
|
7971
|
+
* ```
|
|
7972
|
+
*/
|
|
7973
|
+
getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
|
|
7974
7974
|
/**
|
|
7975
7975
|
* Replaces the specified view with a view with the provided configuration.
|
|
7976
7976
|
*
|
|
@@ -7997,7 +7997,7 @@ declare class Layout extends Base {
|
|
|
7997
7997
|
* await layout.replaceView(viewToReplace.identity, newViewConfig);
|
|
7998
7998
|
* ```
|
|
7999
7999
|
*/
|
|
8000
|
-
replaceView: (viewToReplace:
|
|
8000
|
+
replaceView: (viewToReplace: Identity_3, newView: OpenFin.PlatformViewCreationOptions) => Promise<void>;
|
|
8001
8001
|
/**
|
|
8002
8002
|
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
8003
8003
|
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
@@ -8024,6 +8024,29 @@ declare class Layout extends Base {
|
|
|
8024
8024
|
* ```
|
|
8025
8025
|
*/
|
|
8026
8026
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8027
|
+
/**
|
|
8028
|
+
* Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
|
|
8029
|
+
*
|
|
8030
|
+
* @param viewOptions - The options for creating the view.
|
|
8031
|
+
* @param options - Optional parameters for adding the view.
|
|
8032
|
+
* @param options.location - The location where the view should be added.
|
|
8033
|
+
* @param options.targetView - The target view to which the new view should be added.
|
|
8034
|
+
* @returns A promise that resolves to an object containing the identity of the added view.
|
|
8035
|
+
*/
|
|
8036
|
+
addView(viewOptions: OpenFin.PlatformViewCreationOptions, { location, targetView }?: {
|
|
8037
|
+
location?: OpenFin.CreateViewTarget['location'];
|
|
8038
|
+
targetView?: OpenFin.Identity;
|
|
8039
|
+
}): Promise<{
|
|
8040
|
+
identity: OpenFin.Identity;
|
|
8041
|
+
}>;
|
|
8042
|
+
/**
|
|
8043
|
+
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8044
|
+
* Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
|
|
8045
|
+
*
|
|
8046
|
+
* @param viewIdentity - The identity of the view to close.
|
|
8047
|
+
* @returns A promise that resolves when the view is closed.
|
|
8048
|
+
*/
|
|
8049
|
+
closeView(viewIdentity: OpenFin.Identity): Promise<void>;
|
|
8027
8050
|
}
|
|
8028
8051
|
|
|
8029
8052
|
/**
|
|
@@ -8036,7 +8059,7 @@ declare type LayoutColumn = LayoutItemConfig & {
|
|
|
8036
8059
|
/**
|
|
8037
8060
|
* @interface
|
|
8038
8061
|
*/
|
|
8039
|
-
declare type LayoutComponent = LayoutItemConfig & {
|
|
8062
|
+
declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
8040
8063
|
/**
|
|
8041
8064
|
* Only a component type will have this property and it should be set to view.
|
|
8042
8065
|
*/
|
|
@@ -8045,6 +8068,7 @@ declare type LayoutComponent = LayoutItemConfig & {
|
|
|
8045
8068
|
* Only a component type will have this property and it represents the view options of a given component.
|
|
8046
8069
|
*/
|
|
8047
8070
|
componentState?: Partial<ViewCreationOptions>;
|
|
8071
|
+
type: 'component';
|
|
8048
8072
|
};
|
|
8049
8073
|
|
|
8050
8074
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
|
@@ -8052,7 +8076,7 @@ declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn |
|
|
|
8052
8076
|
/**
|
|
8053
8077
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
|
8054
8078
|
*/
|
|
8055
|
-
declare type LayoutDOMEvent =
|
|
8079
|
+
declare type LayoutDOMEvent = Identity_4 & {
|
|
8056
8080
|
type: string;
|
|
8057
8081
|
topic: 'openfin-DOM-event';
|
|
8058
8082
|
tabSelector: string;
|
|
@@ -8113,7 +8137,7 @@ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
|
|
|
8113
8137
|
/**
|
|
8114
8138
|
* @interface
|
|
8115
8139
|
*/
|
|
8116
|
-
declare type LayoutIdentity =
|
|
8140
|
+
declare type LayoutIdentity = Identity_4 & {
|
|
8117
8141
|
/**
|
|
8118
8142
|
* The name of the layout in a given window.
|
|
8119
8143
|
*/
|
|
@@ -8128,10 +8152,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
|
8128
8152
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8129
8153
|
type: 'layout-initialized';
|
|
8130
8154
|
layoutIdentity: OpenFin.LayoutIdentity;
|
|
8131
|
-
ofViews:
|
|
8132
|
-
identity: OpenFin.Identity;
|
|
8133
|
-
entityType: 'view';
|
|
8134
|
-
}[];
|
|
8155
|
+
ofViews: OpenFin.ViewCreationResult[];
|
|
8135
8156
|
};
|
|
8136
8157
|
|
|
8137
8158
|
/**
|
|
@@ -8222,7 +8243,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8222
8243
|
* @param identity
|
|
8223
8244
|
* @returns LayoutIdentity | undefined
|
|
8224
8245
|
*/
|
|
8225
|
-
resolveLayoutIdentity(identity?:
|
|
8246
|
+
resolveLayoutIdentity(identity?: Identity_4 | LayoutIdentity): LayoutIdentity | undefined;
|
|
8226
8247
|
/**
|
|
8227
8248
|
* @experimental
|
|
8228
8249
|
*
|
|
@@ -8239,7 +8260,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8239
8260
|
/**
|
|
8240
8261
|
* @experimental
|
|
8241
8262
|
*/
|
|
8242
|
-
getLayoutIdentityForView(viewIdentity:
|
|
8263
|
+
getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
|
|
8243
8264
|
/**
|
|
8244
8265
|
* @experimental
|
|
8245
8266
|
*/
|
|
@@ -8340,6 +8361,17 @@ declare class LayoutModule extends Base {
|
|
|
8340
8361
|
* ```
|
|
8341
8362
|
*/
|
|
8342
8363
|
getCurrentSync(): OpenFin.Layout;
|
|
8364
|
+
/**
|
|
8365
|
+
* Retrieves the OpenFin.Layout instance for the Window the View is attached to.
|
|
8366
|
+
*
|
|
8367
|
+
* @example
|
|
8368
|
+
* ```js
|
|
8369
|
+
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
|
8370
|
+
* const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
|
|
8371
|
+
* console.log(await layout.getCurrentViews());
|
|
8372
|
+
* ```
|
|
8373
|
+
*/
|
|
8374
|
+
getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
|
|
8343
8375
|
/**
|
|
8344
8376
|
* Initialize the window's Layout.
|
|
8345
8377
|
*
|
|
@@ -8543,12 +8575,10 @@ declare type Listener<T extends {
|
|
|
8543
8575
|
type: string;
|
|
8544
8576
|
}> = (payload: T) => void;
|
|
8545
8577
|
|
|
8546
|
-
declare type LogInfo = OpenFin.LogInfo;
|
|
8547
|
-
|
|
8548
8578
|
/**
|
|
8549
8579
|
* @interface
|
|
8550
8580
|
*/
|
|
8551
|
-
declare type
|
|
8581
|
+
declare type LogInfo = {
|
|
8552
8582
|
/**
|
|
8553
8583
|
* The filename of the log
|
|
8554
8584
|
*/
|
|
@@ -8563,8 +8593,6 @@ declare type LogInfo_2 = {
|
|
|
8563
8593
|
date: string;
|
|
8564
8594
|
};
|
|
8565
8595
|
|
|
8566
|
-
declare type LogLevel = OpenFin.LogLevel;
|
|
8567
|
-
|
|
8568
8596
|
/**
|
|
8569
8597
|
* Describes the minimum level (inclusive) above which logs will be written.
|
|
8570
8598
|
*
|
|
@@ -8574,7 +8602,7 @@ declare type LogLevel = OpenFin.LogLevel;
|
|
|
8574
8602
|
* `error` and above<br>
|
|
8575
8603
|
* `fatal`: fatal only, indicates a crash is imminent
|
|
8576
8604
|
*/
|
|
8577
|
-
declare type
|
|
8605
|
+
declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
8578
8606
|
|
|
8579
8607
|
declare type LogUploaderUIOptions = {
|
|
8580
8608
|
title?: string;
|
|
@@ -9223,6 +9251,12 @@ declare type MutableWindowOptions = {
|
|
|
9223
9251
|
* Shows the window's icon in the taskbar.
|
|
9224
9252
|
*/
|
|
9225
9253
|
showTaskbarIcon: boolean;
|
|
9254
|
+
/**
|
|
9255
|
+
* Specify a taskbar group for the window.
|
|
9256
|
+
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
9257
|
+
* @remarks It's only updatable when `enableJumpList` is set to false.
|
|
9258
|
+
*/
|
|
9259
|
+
taskbarIconGroup: string;
|
|
9226
9260
|
interop: InteropConfig;
|
|
9227
9261
|
/* Excluded from this release type: _internalWorkspaceData */
|
|
9228
9262
|
/* Excluded from this release type: workspacePlatform */
|
|
@@ -9402,13 +9436,13 @@ declare namespace OpenFin {
|
|
|
9402
9436
|
LayoutPosition,
|
|
9403
9437
|
WebContent,
|
|
9404
9438
|
PlatformProvider,
|
|
9405
|
-
|
|
9406
|
-
|
|
9439
|
+
ApplicationIdentity,
|
|
9440
|
+
Identity_4 as Identity,
|
|
9407
9441
|
ClientIdentity,
|
|
9408
9442
|
ClientInfo,
|
|
9409
9443
|
ClientIdentityMultiRuntime,
|
|
9410
9444
|
ClientConnectionPayload,
|
|
9411
|
-
|
|
9445
|
+
EntityInfo,
|
|
9412
9446
|
EntityType_4 as EntityType,
|
|
9413
9447
|
Bounds,
|
|
9414
9448
|
WindowBounds,
|
|
@@ -9479,6 +9513,9 @@ declare namespace OpenFin {
|
|
|
9479
9513
|
ViewOptions,
|
|
9480
9514
|
ConstViewOptions,
|
|
9481
9515
|
ViewState,
|
|
9516
|
+
ViewCreationSuccess,
|
|
9517
|
+
ViewCreationFailure,
|
|
9518
|
+
ViewCreationResult,
|
|
9482
9519
|
Certificate,
|
|
9483
9520
|
HostContextChangedPayload,
|
|
9484
9521
|
ApplySnapshotOptions,
|
|
@@ -9544,7 +9581,7 @@ declare namespace OpenFin {
|
|
|
9544
9581
|
GpuInfo,
|
|
9545
9582
|
OSInfo,
|
|
9546
9583
|
HostSpecs,
|
|
9547
|
-
|
|
9584
|
+
PrinterInfo,
|
|
9548
9585
|
Dpi,
|
|
9549
9586
|
Margins,
|
|
9550
9587
|
PrintOptions,
|
|
@@ -9652,24 +9689,24 @@ declare namespace OpenFin {
|
|
|
9652
9689
|
BeforeUnloadUserDecision,
|
|
9653
9690
|
ViewStatuses,
|
|
9654
9691
|
CloseWindowPayload,
|
|
9655
|
-
|
|
9656
|
-
|
|
9692
|
+
ProxyInfo,
|
|
9693
|
+
ProxyConfig,
|
|
9657
9694
|
ProxySystemInfo,
|
|
9658
9695
|
ChannelAction_2 as ChannelAction,
|
|
9659
9696
|
ChannelMiddleware_2 as ChannelMiddleware,
|
|
9660
9697
|
ErrorMiddleware_2 as ErrorMiddleware,
|
|
9661
|
-
|
|
9662
|
-
|
|
9698
|
+
ApplicationState,
|
|
9699
|
+
InstalledApps,
|
|
9663
9700
|
InstallationInfo,
|
|
9664
|
-
|
|
9665
|
-
|
|
9701
|
+
GetLogRequestType,
|
|
9702
|
+
LogInfo,
|
|
9666
9703
|
SendApplicationLogResponse,
|
|
9667
|
-
|
|
9704
|
+
LogLevel,
|
|
9668
9705
|
PermissionState_2 as PermissionState,
|
|
9669
|
-
|
|
9706
|
+
RegistryInfo,
|
|
9670
9707
|
ApplicationType,
|
|
9671
9708
|
WindowInfo,
|
|
9672
|
-
|
|
9709
|
+
ApplicationWindowInfo,
|
|
9673
9710
|
WindowDetail,
|
|
9674
9711
|
LayoutPresetType,
|
|
9675
9712
|
LayoutIdentity,
|
|
@@ -11279,6 +11316,45 @@ declare interface PlatformProvider {
|
|
|
11279
11316
|
* @returns {Promise<void>}
|
|
11280
11317
|
*/
|
|
11281
11318
|
handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
|
|
11319
|
+
/**
|
|
11320
|
+
* @experimental
|
|
11321
|
+
*
|
|
11322
|
+
* This method is called to handle errors with view creation and initial navigation during layout creation.
|
|
11323
|
+
* Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
|
|
11324
|
+
* * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
|
|
11325
|
+
* * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
|
|
11326
|
+
* * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
|
|
11327
|
+
*
|
|
11328
|
+
* @param viewIdentity Identity of the view
|
|
11329
|
+
* @param error error thrown during a view creation
|
|
11330
|
+
* @returns {Promise<OpenFin.ViewCreationSuccess | void>}
|
|
11331
|
+
*
|
|
11332
|
+
* @example
|
|
11333
|
+
*
|
|
11334
|
+
* ```js
|
|
11335
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
11336
|
+
* class Override extends PlatformProvider {
|
|
11337
|
+
* async handleFailedViewCreation(viewIdentity, error) {
|
|
11338
|
+
* const view = fin.View.wrapSync(viewId);
|
|
11339
|
+
* try {
|
|
11340
|
+
* // navigate to an error page
|
|
11341
|
+
* await view.navigate('http://localhost:3000/errorPage.html');
|
|
11342
|
+
* // resolve a success result after redirecting to a error page
|
|
11343
|
+
* return {identity: viewIdentity, success: true};
|
|
11344
|
+
* } catch(e) {
|
|
11345
|
+
* // layout-initialized event will include this view with the error
|
|
11346
|
+
* throw error;
|
|
11347
|
+
* }
|
|
11348
|
+
* }
|
|
11349
|
+
* }
|
|
11350
|
+
* return new Override();
|
|
11351
|
+
* }
|
|
11352
|
+
*
|
|
11353
|
+
* fin.Platform.init({ overrideCallback });
|
|
11354
|
+
*
|
|
11355
|
+
* ```
|
|
11356
|
+
*/
|
|
11357
|
+
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
11282
11358
|
}
|
|
11283
11359
|
|
|
11284
11360
|
/**
|
|
@@ -11578,12 +11654,10 @@ declare type PresetLayoutOptions_2 = {
|
|
|
11578
11654
|
presetType: LayoutPresetType;
|
|
11579
11655
|
};
|
|
11580
11656
|
|
|
11581
|
-
declare type PrinterInfo = OpenFin.PrinterInfo;
|
|
11582
|
-
|
|
11583
11657
|
/**
|
|
11584
11658
|
* @interface
|
|
11585
11659
|
*/
|
|
11586
|
-
declare type
|
|
11660
|
+
declare type PrinterInfo = {
|
|
11587
11661
|
/**
|
|
11588
11662
|
* Printer Name
|
|
11589
11663
|
*/
|
|
@@ -11845,20 +11919,100 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
11845
11919
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
11846
11920
|
|
|
11847
11921
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
11922
|
+
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
11923
|
+
'destroy-application': ApplicationIdentityCall<{
|
|
11924
|
+
force: boolean;
|
|
11925
|
+
}, void>;
|
|
11926
|
+
'close-application': ApplicationIdentityCall<{
|
|
11927
|
+
force: boolean;
|
|
11928
|
+
}, void>;
|
|
11929
|
+
'application-close': ApplicationIdentityCall<{}, void>;
|
|
11930
|
+
'get-child-windows': ApplicationIdentityCall<{}, Array<unknown>>;
|
|
11931
|
+
'get-application-manifest': {
|
|
11932
|
+
request: {
|
|
11933
|
+
manifestUrl?: string;
|
|
11934
|
+
uuid?: string;
|
|
11935
|
+
};
|
|
11936
|
+
response: OpenFin.Manifest;
|
|
11937
|
+
};
|
|
11938
|
+
'get-parent-application': ApplicationIdentityCall<{}, string>;
|
|
11939
|
+
'get-shortcuts': ApplicationIdentityCall<{}, OpenFin.ShortCutConfig>;
|
|
11940
|
+
'application-get-views': ApplicationIdentityCall<{}, OpenFin.Identity[]>;
|
|
11941
|
+
'get-application-zoom-level': ApplicationIdentityCall<{}, number>;
|
|
11942
|
+
'application-get-window': ApplicationIdentityCall<{}, void>;
|
|
11943
|
+
'register-user': ApplicationIdentityCall<{
|
|
11944
|
+
userName: string;
|
|
11945
|
+
appName: string;
|
|
11946
|
+
}, void>;
|
|
11947
|
+
'remove-tray-icon': ApplicationIdentityCall<{}, void>;
|
|
11948
|
+
'restart-application': ApplicationIdentityCall<{}, void>;
|
|
11949
|
+
'application-run': ApplicationIdentityCall<{}, void>;
|
|
11950
|
+
'run-application': ApplicationIdentityCall<{
|
|
11951
|
+
manifestUrl?: string | undefined;
|
|
11952
|
+
opts?: OpenFin.RvmLaunchOptions;
|
|
11953
|
+
}, void>;
|
|
11954
|
+
'relaunch-on-close': ApplicationIdentityCall<{}, void>;
|
|
11955
|
+
'send-application-log': ApplicationIdentityCall<{}, OpenFin.SendApplicationLogResponse>;
|
|
11956
|
+
'set-jump-list': ApplicationIdentityCall<{
|
|
11957
|
+
config: OpenFin.JumpListCategory[] | null;
|
|
11958
|
+
}, void>;
|
|
11959
|
+
'set-tray-icon': ApplicationIdentityCall<{
|
|
11960
|
+
enabledIcon: string;
|
|
11961
|
+
}, void>;
|
|
11962
|
+
'set-shortcuts': ApplicationIdentityCall<{
|
|
11963
|
+
data: OpenFin.ShortCutConfig;
|
|
11964
|
+
}, void>;
|
|
11965
|
+
'set-shortcut-query-args': ApplicationIdentityCall<{
|
|
11966
|
+
data: string;
|
|
11967
|
+
}, void>;
|
|
11968
|
+
'set-application-zoom-level': ApplicationIdentityCall<{
|
|
11969
|
+
level: number;
|
|
11970
|
+
}, void>;
|
|
11971
|
+
'set-app-log-username': ApplicationIdentityCall<{
|
|
11972
|
+
data: string;
|
|
11973
|
+
}, void>;
|
|
11974
|
+
'get-tray-icon-info': ApplicationIdentityCall<{}, OpenFin.TrayInfo>;
|
|
11975
|
+
'has-tray-icon': ApplicationIdentityCall<{}, boolean>;
|
|
11976
|
+
'terminate-application': ApplicationIdentityCall<{}, void>;
|
|
11977
|
+
'wait-for-hung-application': ApplicationIdentityCall<{}, void>;
|
|
11978
|
+
'get-info': ApplicationIdentityCall<{}, OpenFin.ApplicationInfo>;
|
|
11979
|
+
'application-get-process-info': ApplicationIdentityCall<{}, OpenFin.AppProcessInfo>;
|
|
11980
|
+
'set-file-download-location': {
|
|
11981
|
+
request: OpenFin.Identity & {
|
|
11982
|
+
downloadLocation: string;
|
|
11983
|
+
};
|
|
11984
|
+
response: void;
|
|
11985
|
+
};
|
|
11986
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
11987
|
+
'show-tray-icon-popup-menu': {
|
|
11988
|
+
request: OpenFin.Identity & {
|
|
11989
|
+
options: OpenFin.ShowTrayIconPopupMenuOptions;
|
|
11990
|
+
};
|
|
11991
|
+
response: OpenFin.MenuResult;
|
|
11992
|
+
};
|
|
11993
|
+
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
11994
|
+
'wrap-application': VoidCall;
|
|
11995
|
+
'wrap-application-sync': VoidCall;
|
|
11996
|
+
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
11997
|
+
'application-create': VoidCall;
|
|
11998
|
+
'start-application': VoidCall;
|
|
11999
|
+
'run-applications': ApiCall<{
|
|
12000
|
+
applications: Array<OpenFin.ManifestInfo>;
|
|
12001
|
+
opts?: OpenFin.RvmLaunchOptions;
|
|
12002
|
+
}, void>;
|
|
12003
|
+
'get-current-application': VoidCall;
|
|
12004
|
+
'get-current-application-sync': VoidCall;
|
|
12005
|
+
'application-start-from-manifest': VoidCall;
|
|
12006
|
+
'application-create-from-manifest': VoidCall;
|
|
11848
12007
|
'request-external-authorization': {
|
|
11849
12008
|
request: any;
|
|
11850
12009
|
response: void;
|
|
11851
12010
|
specialResponse: AuthorizationPayload;
|
|
11852
12011
|
};
|
|
11853
|
-
'
|
|
11854
|
-
request:
|
|
11855
|
-
response: OpenFin.Identity[];
|
|
11856
|
-
};
|
|
11857
|
-
'set-jump-list': {
|
|
11858
|
-
request: {
|
|
11859
|
-
config: OpenFin.JumpListCategory[] | null;
|
|
11860
|
-
} & OpenFin.ApplicationIdentity;
|
|
12012
|
+
'request-authorization': {
|
|
12013
|
+
request: ExistingConnectConfig | RemoteConfig | ReceiverConfig;
|
|
11861
12014
|
response: void;
|
|
12015
|
+
specialResponse: Payload;
|
|
11862
12016
|
};
|
|
11863
12017
|
'clipboard-read-formats': {
|
|
11864
12018
|
request: {
|
|
@@ -11870,6 +12024,24 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11870
12024
|
request: OpenFin.ReadImageClipboardRequest;
|
|
11871
12025
|
response: string;
|
|
11872
12026
|
};
|
|
12027
|
+
'clipboard-read-text': {
|
|
12028
|
+
request: {
|
|
12029
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12030
|
+
};
|
|
12031
|
+
response: string;
|
|
12032
|
+
};
|
|
12033
|
+
'clipboard-read-html': {
|
|
12034
|
+
request: {
|
|
12035
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12036
|
+
};
|
|
12037
|
+
response: string;
|
|
12038
|
+
};
|
|
12039
|
+
'clipboard-read-rtf': {
|
|
12040
|
+
request: {
|
|
12041
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12042
|
+
};
|
|
12043
|
+
response: string;
|
|
12044
|
+
};
|
|
11873
12045
|
'clipboard-write-image': {
|
|
11874
12046
|
request: OpenFin.WriteImageClipboardRequest;
|
|
11875
12047
|
response: void;
|
|
@@ -11878,6 +12050,18 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11878
12050
|
request: OpenFin.WriteAnyRequestType;
|
|
11879
12051
|
response: void;
|
|
11880
12052
|
};
|
|
12053
|
+
'clipboard-write-text': {
|
|
12054
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12055
|
+
response: void;
|
|
12056
|
+
};
|
|
12057
|
+
'clipboard-write-html': {
|
|
12058
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12059
|
+
response: void;
|
|
12060
|
+
};
|
|
12061
|
+
'clipboard-write-rtf': {
|
|
12062
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12063
|
+
response: void;
|
|
12064
|
+
};
|
|
11881
12065
|
'get-view-window': IdentityCall<{}, OpenFin.Identity>;
|
|
11882
12066
|
'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
|
|
11883
12067
|
uuid: string;
|
|
@@ -11903,13 +12087,85 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11903
12087
|
options: OpenFin.UpdatableViewOptions;
|
|
11904
12088
|
}>;
|
|
11905
12089
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12090
|
+
'view-wrap-sync': VoidCall;
|
|
12091
|
+
'view-wrap': VoidCall;
|
|
12092
|
+
'view-get-current': VoidCall;
|
|
12093
|
+
'view-get-current-sync': VoidCall;
|
|
12094
|
+
'animate-window': IdentityCall<{
|
|
12095
|
+
transitions: OpenFin.Transition;
|
|
12096
|
+
options: OpenFin.TransitionOptions;
|
|
12097
|
+
}>;
|
|
12098
|
+
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12099
|
+
'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
|
|
12100
|
+
'center-window': IdentityCall;
|
|
12101
|
+
'blur-window': IdentityCall;
|
|
12102
|
+
'bring-window-to-front': IdentityCall;
|
|
12103
|
+
'hide-window': IdentityCall;
|
|
12104
|
+
'close-window': IdentityCall<{
|
|
12105
|
+
force: boolean;
|
|
12106
|
+
}>;
|
|
12107
|
+
'focused-webview-changed': IdentityCall;
|
|
12108
|
+
'get-window-native-id': IdentityCall<{}, string>;
|
|
11906
12109
|
'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
|
|
11907
|
-
'
|
|
12110
|
+
'disable-window-frame': IdentityCall;
|
|
12111
|
+
'enable-window-frame': IdentityCall;
|
|
12112
|
+
'flash-window': IdentityCall;
|
|
12113
|
+
'stop-flash-window': IdentityCall;
|
|
12114
|
+
'get-window-info': IdentityCall<{}, OpenFin.WindowInfo>;
|
|
12115
|
+
'get-window-options': IdentityCall<{}, OpenFin.WindowOptions>;
|
|
12116
|
+
'get-window-snapshot': IdentityCall<{
|
|
12117
|
+
area?: OpenFin.Rectangle;
|
|
12118
|
+
}, string>;
|
|
12119
|
+
'get-window-state': IdentityCall<{}, 'minimized' | 'maximized' | 'normal'>;
|
|
12120
|
+
'is-window-showing': IdentityCall<{}, boolean>;
|
|
12121
|
+
'maximize-window': IdentityCall;
|
|
12122
|
+
'minimize-window': IdentityCall;
|
|
12123
|
+
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12124
|
+
deltaLeft: number;
|
|
12125
|
+
deltaTop: number;
|
|
12126
|
+
}>>;
|
|
12127
|
+
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12128
|
+
left: number;
|
|
12129
|
+
top: number;
|
|
12130
|
+
}>>;
|
|
12131
|
+
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12132
|
+
deltaWidth: number;
|
|
12133
|
+
deltaHeight: number;
|
|
12134
|
+
anchor: OpenFin.AnchorType;
|
|
12135
|
+
}>>;
|
|
12136
|
+
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12137
|
+
width: number;
|
|
12138
|
+
height: number;
|
|
12139
|
+
anchor: OpenFin.AnchorType;
|
|
12140
|
+
}>>;
|
|
12141
|
+
'restore-window': IdentityCall;
|
|
12142
|
+
'set-foreground-window': IdentityCall;
|
|
12143
|
+
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12144
|
+
'show-window': IdentityCall<{
|
|
12145
|
+
force: boolean;
|
|
12146
|
+
}>;
|
|
12147
|
+
'show-at-window': IdentityCall<{
|
|
12148
|
+
left: number;
|
|
12149
|
+
top: number;
|
|
12150
|
+
force: boolean;
|
|
12151
|
+
}>;
|
|
12152
|
+
'update-window-options': IdentityCall<{
|
|
12153
|
+
options: OpenFin.UpdatableWindowOptions;
|
|
12154
|
+
}>;
|
|
12155
|
+
'window-authenticate': IdentityCall<{
|
|
12156
|
+
userName: string;
|
|
12157
|
+
password: string;
|
|
12158
|
+
}>;
|
|
12159
|
+
'show-popup-menu': {
|
|
11908
12160
|
request: OpenFin.Identity & {
|
|
11909
|
-
options: OpenFin.
|
|
12161
|
+
options: OpenFin.ShowPopupMenuOptions;
|
|
11910
12162
|
};
|
|
11911
|
-
response:
|
|
12163
|
+
response: OpenFin.MenuResult;
|
|
11912
12164
|
};
|
|
12165
|
+
'close-popup-menu': IdentityCall;
|
|
12166
|
+
'dispatch-popup-result': IdentityCall<{
|
|
12167
|
+
data: any;
|
|
12168
|
+
}>;
|
|
11913
12169
|
'print-screenshot': {
|
|
11914
12170
|
request: OpenFin.Identity;
|
|
11915
12171
|
response: void;
|
|
@@ -11920,6 +12176,229 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11920
12176
|
};
|
|
11921
12177
|
response: void;
|
|
11922
12178
|
};
|
|
12179
|
+
'window-wrap': VoidCall;
|
|
12180
|
+
'window-wrap-sync': VoidCall;
|
|
12181
|
+
'create-window': VoidCall;
|
|
12182
|
+
'get-current-window': VoidCall;
|
|
12183
|
+
'get-current-window-sync': VoidCall;
|
|
12184
|
+
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
12185
|
+
'external-application-wrap': VoidCall;
|
|
12186
|
+
'external-application-wrap-sync': VoidCall;
|
|
12187
|
+
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12188
|
+
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12189
|
+
'frame-wrap': VoidCall;
|
|
12190
|
+
'frame-wrap-sync': VoidCall;
|
|
12191
|
+
'frame-get-current': VoidCall;
|
|
12192
|
+
'frame-get-current-sync': VoidCall;
|
|
12193
|
+
'global-hotkey-register': {
|
|
12194
|
+
request: {
|
|
12195
|
+
hotkey: string;
|
|
12196
|
+
};
|
|
12197
|
+
response: void;
|
|
12198
|
+
};
|
|
12199
|
+
'global-hotkey-unregister': {
|
|
12200
|
+
request: {
|
|
12201
|
+
hotkey: string;
|
|
12202
|
+
};
|
|
12203
|
+
response: void;
|
|
12204
|
+
};
|
|
12205
|
+
'global-hotkey-unregister-all': {
|
|
12206
|
+
request: {};
|
|
12207
|
+
response: void;
|
|
12208
|
+
};
|
|
12209
|
+
'global-hotkey-is-registered': {
|
|
12210
|
+
request: {
|
|
12211
|
+
hotkey: string;
|
|
12212
|
+
};
|
|
12213
|
+
response: boolean;
|
|
12214
|
+
};
|
|
12215
|
+
'publish-message': {
|
|
12216
|
+
request: {
|
|
12217
|
+
topic: string;
|
|
12218
|
+
message: any;
|
|
12219
|
+
sourceWindowName: string;
|
|
12220
|
+
};
|
|
12221
|
+
response: void;
|
|
12222
|
+
};
|
|
12223
|
+
'send-message': {
|
|
12224
|
+
request: {
|
|
12225
|
+
destinationUuid: string;
|
|
12226
|
+
destinationWindowName: string | undefined;
|
|
12227
|
+
topic: string;
|
|
12228
|
+
message: any;
|
|
12229
|
+
sourceWindowName: string;
|
|
12230
|
+
};
|
|
12231
|
+
response: void;
|
|
12232
|
+
};
|
|
12233
|
+
'subscribe': {
|
|
12234
|
+
request: {
|
|
12235
|
+
sourceUuid: string;
|
|
12236
|
+
sourceWindowName: string;
|
|
12237
|
+
topic: string;
|
|
12238
|
+
destinationWindowName: string;
|
|
12239
|
+
messageKey?: any;
|
|
12240
|
+
};
|
|
12241
|
+
response: void;
|
|
12242
|
+
};
|
|
12243
|
+
'unsubscribe': {
|
|
12244
|
+
request: {
|
|
12245
|
+
sourceUuid: string;
|
|
12246
|
+
sourceWindowName: string;
|
|
12247
|
+
topic: string;
|
|
12248
|
+
destinationWindowName: string;
|
|
12249
|
+
};
|
|
12250
|
+
response: void;
|
|
12251
|
+
};
|
|
12252
|
+
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
12253
|
+
'connect-to-channel': {
|
|
12254
|
+
request: any;
|
|
12255
|
+
response: OpenFin.RoutingInfo;
|
|
12256
|
+
};
|
|
12257
|
+
'create-channel': ApiCall<{
|
|
12258
|
+
channelName: string;
|
|
12259
|
+
}, OpenFin.ProviderIdentity>;
|
|
12260
|
+
'destroy-channel': ApiCall<{
|
|
12261
|
+
channelName: string;
|
|
12262
|
+
}, void>;
|
|
12263
|
+
'disconnect-from-channel': {
|
|
12264
|
+
request: {
|
|
12265
|
+
channelName: string;
|
|
12266
|
+
uuid: string;
|
|
12267
|
+
name: string;
|
|
12268
|
+
endpointId: string;
|
|
12269
|
+
};
|
|
12270
|
+
response: void;
|
|
12271
|
+
};
|
|
12272
|
+
'send-channel-message': {
|
|
12273
|
+
request: any;
|
|
12274
|
+
response: any;
|
|
12275
|
+
};
|
|
12276
|
+
'get-version': GetterCall<string>;
|
|
12277
|
+
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
12278
|
+
'delete-cache-request': VoidCall;
|
|
12279
|
+
'exit-desktop': VoidCall;
|
|
12280
|
+
'fetch-manifest': ApiCall<{
|
|
12281
|
+
manifestUrl: string;
|
|
12282
|
+
}, any>;
|
|
12283
|
+
'flush-cookie-store': VoidCall;
|
|
12284
|
+
'get-all-windows': GetterCall<OpenFin.ApplicationWindowInfo[]>;
|
|
12285
|
+
'get-all-applications': GetterCall<OpenFin.ApplicationState[]>;
|
|
12286
|
+
'get-command-line-arguments': GetterCall<string>;
|
|
12287
|
+
'get-crash-reporter-state': GetterCall<OpenFin.CrashReporterState>;
|
|
12288
|
+
'start-crash-reporter': {
|
|
12289
|
+
request: OpenFin.CrashReporterOptions | {
|
|
12290
|
+
diagnosticMode: boolean;
|
|
12291
|
+
};
|
|
12292
|
+
response: OpenFin.CrashReporterState;
|
|
12293
|
+
};
|
|
12294
|
+
'get-unique-user-id': GetterCall<string>;
|
|
12295
|
+
'get-entity-info': {
|
|
12296
|
+
request: {
|
|
12297
|
+
uuid: string;
|
|
12298
|
+
name: string;
|
|
12299
|
+
};
|
|
12300
|
+
response: OpenFin.EntityInfo;
|
|
12301
|
+
};
|
|
12302
|
+
'get-environment-variable': {
|
|
12303
|
+
request: {
|
|
12304
|
+
environmentVariables: string;
|
|
12305
|
+
};
|
|
12306
|
+
response: string;
|
|
12307
|
+
};
|
|
12308
|
+
'get-focused-window': GetterCall<OpenFin.Identity | null>;
|
|
12309
|
+
'is-app-certified': {
|
|
12310
|
+
request: {
|
|
12311
|
+
manifestUrl: string;
|
|
12312
|
+
};
|
|
12313
|
+
response: {
|
|
12314
|
+
action: string;
|
|
12315
|
+
certifiedInfo: OpenFin.CertifiedAppInfo;
|
|
12316
|
+
};
|
|
12317
|
+
};
|
|
12318
|
+
'get-installed-runtimes': GetterCall<{
|
|
12319
|
+
action: string;
|
|
12320
|
+
runtimes: string[];
|
|
12321
|
+
}>;
|
|
12322
|
+
'get-installed-apps': GetterCall<OpenFin.InstalledApps>;
|
|
12323
|
+
'view-log': ApiCall<OpenFin.GetLogRequestType, string>;
|
|
12324
|
+
'get-machine-id': GetterCall<string>;
|
|
12325
|
+
'get-min-log-level': GetterCall<OpenFin.LogLevel>;
|
|
12326
|
+
'list-logs': GetterCall<OpenFin.LogInfo[]>;
|
|
12327
|
+
'get-monitor-info': GetterCall<OpenFin.MonitorInfo>;
|
|
12328
|
+
'get-mouse-position': GetterCall<OpenFin.PointTopLeft>;
|
|
12329
|
+
'process-snapshot': GetterCall<Array<any>>;
|
|
12330
|
+
'get-all-process-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.SystemProcessInfo>;
|
|
12331
|
+
'get-proxy-settings': GetterCall<OpenFin.ProxyInfo>;
|
|
12332
|
+
'get-runtime-info': GetterCall<OpenFin.RuntimeInfo>;
|
|
12333
|
+
'get-rvm-info': GetterCall<OpenFin.RVMInfo>;
|
|
12334
|
+
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12335
|
+
'get-os-info': GetterCall<OpenFin.OSInfo>;
|
|
12336
|
+
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity>;
|
|
12337
|
+
'monitor-external-process': ApiCall<OpenFin.ExternalProcessInfo, OpenFin.Identity>;
|
|
12338
|
+
'write-to-log': ApiCall<{
|
|
12339
|
+
level: string;
|
|
12340
|
+
message: string;
|
|
12341
|
+
}, void>;
|
|
12342
|
+
'open-url-with-browser': ApiCall<{
|
|
12343
|
+
url: string;
|
|
12344
|
+
}, void>;
|
|
12345
|
+
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12346
|
+
'unregister-custom-protocol': ApiCall<{
|
|
12347
|
+
protocolName: string;
|
|
12348
|
+
}, void>;
|
|
12349
|
+
'get-custom-protocol-state': ApiCall<{
|
|
12350
|
+
protocolName: string;
|
|
12351
|
+
}, OpenFin.CustomProtocolState>;
|
|
12352
|
+
'release-external-process': ApiCall<{
|
|
12353
|
+
uuid: string;
|
|
12354
|
+
}, void>;
|
|
12355
|
+
'show-developer-tools': ApiCall<OpenFin.Identity, void>;
|
|
12356
|
+
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void>;
|
|
12357
|
+
'update-proxy': ApiCall<OpenFin.ProxyConfig, void>;
|
|
12358
|
+
'download-asset': {
|
|
12359
|
+
request: OpenFin.AppAssetInfo & {
|
|
12360
|
+
downloadId: string;
|
|
12361
|
+
};
|
|
12362
|
+
response: void;
|
|
12363
|
+
};
|
|
12364
|
+
'download-runtime': {
|
|
12365
|
+
request: OpenFin.RuntimeDownloadOptions & {
|
|
12366
|
+
downloadId: string;
|
|
12367
|
+
};
|
|
12368
|
+
response: void;
|
|
12369
|
+
};
|
|
12370
|
+
'download-preload-scripts': ApiCall<{
|
|
12371
|
+
scripts: Array<OpenFin.DownloadPreloadOption>;
|
|
12372
|
+
}, Array<OpenFin.DownloadPreloadInfo>>;
|
|
12373
|
+
'get-all-external-applications': ApiCall<void, Array<OpenFin.Identity>>;
|
|
12374
|
+
'get-app-asset-info': ApiCall<OpenFin.AppAssetRequest, OpenFin.AppAssetInfo>;
|
|
12375
|
+
'get-cookies': {
|
|
12376
|
+
request: OpenFin.CookieOption & {
|
|
12377
|
+
url: string;
|
|
12378
|
+
};
|
|
12379
|
+
response: Array<OpenFin.CookieInfo>;
|
|
12380
|
+
};
|
|
12381
|
+
'set-min-log-level': ApiCall<{
|
|
12382
|
+
level: OpenFin.LogLevel;
|
|
12383
|
+
}, void>;
|
|
12384
|
+
'resolve-uuid': ApiCall<{
|
|
12385
|
+
entityKey: string;
|
|
12386
|
+
}, OpenFin.ApplicationType>;
|
|
12387
|
+
'read-registry-value': ApiCall<{
|
|
12388
|
+
rootKey: string;
|
|
12389
|
+
subkey: string;
|
|
12390
|
+
value: string;
|
|
12391
|
+
}, OpenFin.RegistryInfo>;
|
|
12392
|
+
'register-external-connection': ApiCall<{
|
|
12393
|
+
uuid: string;
|
|
12394
|
+
}, OpenFin.ExternalConnection>;
|
|
12395
|
+
'get-service-configuration': ApiCall<{
|
|
12396
|
+
name: string;
|
|
12397
|
+
}, OpenFin.ServiceConfiguration>;
|
|
12398
|
+
'get-system-app-configuration': ApiCall<{
|
|
12399
|
+
name: string;
|
|
12400
|
+
}, any>;
|
|
12401
|
+
'run-rvm-health-check': ApiCall<void, string[]>;
|
|
11923
12402
|
'launch-manifest': {
|
|
11924
12403
|
request: {
|
|
11925
12404
|
manifestUrl: string;
|
|
@@ -11931,17 +12410,12 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11931
12410
|
manifest: OpenFin.Manifest;
|
|
11932
12411
|
};
|
|
11933
12412
|
};
|
|
11934
|
-
'
|
|
12413
|
+
'query-permission-for-current-context': {
|
|
11935
12414
|
request: {
|
|
11936
|
-
|
|
11937
|
-
|
|
11938
|
-
response: any;
|
|
11939
|
-
};
|
|
11940
|
-
'show-popup-menu': {
|
|
11941
|
-
request: OpenFin.Identity & {
|
|
11942
|
-
options: OpenFin.ShowPopupMenuOptions;
|
|
12415
|
+
apiName: string;
|
|
12416
|
+
identity: OpenFin.Identity;
|
|
11943
12417
|
};
|
|
11944
|
-
response: OpenFin.
|
|
12418
|
+
response: OpenFin.QueryPermissionResult;
|
|
11945
12419
|
};
|
|
11946
12420
|
'enable-native-window-integration-provider': {
|
|
11947
12421
|
request: {
|
|
@@ -11949,24 +12423,34 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11949
12423
|
};
|
|
11950
12424
|
response: OpenFin.NativeWindowIntegrationProviderAuthorization;
|
|
11951
12425
|
};
|
|
12426
|
+
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
12427
|
+
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12428
|
+
'system-update-process-logging-options': ApiCall<{
|
|
12429
|
+
options: OpenFin.ProcessLoggingOptions;
|
|
12430
|
+
}, void>;
|
|
12431
|
+
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12432
|
+
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12433
|
+
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12434
|
+
}, void>;
|
|
12435
|
+
'system-register-shutdown-handler': VoidCall;
|
|
11952
12436
|
'get-permissions': GetterCall<any>;
|
|
11953
|
-
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
11954
|
-
'set-file-download-location': {
|
|
11955
|
-
request: OpenFin.Identity & {
|
|
11956
|
-
downloadLocation: string;
|
|
11957
|
-
};
|
|
11958
|
-
response: void;
|
|
11959
|
-
};
|
|
11960
|
-
'get-file-download-location': {
|
|
11961
|
-
request: OpenFin.ApplicationIdentity;
|
|
11962
|
-
response: string;
|
|
11963
|
-
};
|
|
11964
|
-
'close-popup-menu': IdentityCall;
|
|
11965
12437
|
'fdc3-add-context-listener': VoidCall;
|
|
12438
|
+
'fdc3-add-intent-listener': VoidCall;
|
|
12439
|
+
'fdc3-raise-intent': VoidCall;
|
|
12440
|
+
'fdc3-find-intent': VoidCall;
|
|
12441
|
+
'fdc3-find-intents-by-context': VoidCall;
|
|
12442
|
+
'fdc3-raise-intent-for-context': VoidCall;
|
|
12443
|
+
'fdc3-get-info': VoidCall;
|
|
12444
|
+
'fdc3-find-instances': VoidCall;
|
|
12445
|
+
'fdc3-get-app-metadata': VoidCall;
|
|
11966
12446
|
'fdc3-broadcast': VoidCall;
|
|
12447
|
+
'fdc3-open': VoidCall;
|
|
12448
|
+
'fdc3-get-or-create-channel': VoidCall;
|
|
11967
12449
|
'fdc3-get-system-channels': VoidCall;
|
|
11968
12450
|
'fdc3-join-channel': VoidCall;
|
|
12451
|
+
'fdc3-get-current-channel': VoidCall;
|
|
11969
12452
|
'fdc3-leave-current-channel': VoidCall;
|
|
12453
|
+
'interop-init': VoidCall;
|
|
11970
12454
|
'interop-connect-sync': VoidCall;
|
|
11971
12455
|
'interop-client-set-context': VoidCall;
|
|
11972
12456
|
'interop-client-add-context-handler': VoidCall;
|
|
@@ -11975,6 +12459,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11975
12459
|
'interop-client-remove-from-context-group': VoidCall;
|
|
11976
12460
|
'interop-client-get-all-clients-in-context-group': VoidCall;
|
|
11977
12461
|
'interop-client-get-info-for-context-group': VoidCall;
|
|
12462
|
+
'interop-client-fire-intent': VoidCall;
|
|
12463
|
+
'interop-client-register-intent-handler': VoidCall;
|
|
12464
|
+
'interop-client-get-current-context': VoidCall;
|
|
12465
|
+
'interop-client-get-info-for-intent': VoidCall;
|
|
12466
|
+
'interop-client-get-info-for-intents-by-context': VoidCall;
|
|
12467
|
+
'interop-client-fire-intent-for-context': VoidCall;
|
|
12468
|
+
'interop-client-add-ondisconnection-listener': VoidCall;
|
|
11978
12469
|
'interop-broker-add-client-to-context-group': VoidCall;
|
|
11979
12470
|
'interop-broker-get-all-clients-in-context-group': VoidCall;
|
|
11980
12471
|
'interop-broker-get-context-groups': VoidCall;
|
|
@@ -11986,13 +12477,100 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11986
12477
|
'interop-broker-remove-from-context-group': VoidCall;
|
|
11987
12478
|
'interop-broker-set-context': VoidCall;
|
|
11988
12479
|
'interop-broker-set-context-for-group': VoidCall;
|
|
11989
|
-
'
|
|
11990
|
-
|
|
11991
|
-
|
|
11992
|
-
|
|
11993
|
-
|
|
11994
|
-
|
|
11995
|
-
|
|
12480
|
+
'interop-broker-get-current-context': VoidCall;
|
|
12481
|
+
'interop-broker-set-intent-target': VoidCall;
|
|
12482
|
+
'interop-session-context-group-set-context': VoidCall;
|
|
12483
|
+
'interop-session-context-group-get-context': VoidCall;
|
|
12484
|
+
'interop-session-context-group-add-handler': VoidCall;
|
|
12485
|
+
'platform-wrap': VoidCall;
|
|
12486
|
+
'platform-wrap-sync': VoidCall;
|
|
12487
|
+
'platform-get-current': VoidCall;
|
|
12488
|
+
'platform-get-current-sync': VoidCall;
|
|
12489
|
+
'platform-start': VoidCall;
|
|
12490
|
+
'platform-start-from-manifest': VoidCall;
|
|
12491
|
+
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
12492
|
+
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
12493
|
+
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
12494
|
+
'platform-quit': ApplicationIdentityCall<{}, void>;
|
|
12495
|
+
'platform-close-view': ApplicationIdentityCall<{}, void>;
|
|
12496
|
+
'platform-reparent-view': ApplicationIdentityCall<{}, void>;
|
|
12497
|
+
'platform-get-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12498
|
+
'platform-apply-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12499
|
+
'platform-launch-content-manifest': ApplicationIdentityCall<{}, void>;
|
|
12500
|
+
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
12501
|
+
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
12502
|
+
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
12503
|
+
'layout-wrap': VoidCall;
|
|
12504
|
+
'layout-wrap-sync': VoidCall;
|
|
12505
|
+
'layout-get-current': VoidCall;
|
|
12506
|
+
'layout-get-current-sync': VoidCall;
|
|
12507
|
+
'layout-init': VoidCall;
|
|
12508
|
+
'layout-get-config': VoidCall;
|
|
12509
|
+
'layout-get-views': VoidCall;
|
|
12510
|
+
'layout-replace': VoidCall;
|
|
12511
|
+
'layout-get-root-item': VoidCall;
|
|
12512
|
+
'layout-replace-view': VoidCall;
|
|
12513
|
+
'layout-apply-preset': VoidCall;
|
|
12514
|
+
'layout-controller-get-root': VoidCall;
|
|
12515
|
+
'layout-controller-get-stack-by-view': VoidCall;
|
|
12516
|
+
'layout-controller-get-stack-views': VoidCall;
|
|
12517
|
+
'layout-controller-get-content': VoidCall;
|
|
12518
|
+
'layout-controller-get-parent': VoidCall;
|
|
12519
|
+
'layout-controller-is-root': VoidCall;
|
|
12520
|
+
'layout-controller-exists': VoidCall;
|
|
12521
|
+
'layout-controller-add-view-to-stack': VoidCall;
|
|
12522
|
+
'layout-controller-remove-view-from-stack': VoidCall;
|
|
12523
|
+
'layout-controller-create-adjacent-stack': VoidCall;
|
|
12524
|
+
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
12525
|
+
'layout-controller-set-stack-active-view': VoidCall;
|
|
12526
|
+
'snapshot-source-init': VoidCall;
|
|
12527
|
+
'snapshot-source-wrap-sync': VoidCall;
|
|
12528
|
+
'snapshot-source-wrap': VoidCall;
|
|
12529
|
+
'snapshot-source-ready': VoidCall;
|
|
12530
|
+
'snapshot-source-get-snapshot': VoidCall;
|
|
12531
|
+
'snapshot-source-apply-snapshot': VoidCall;
|
|
12532
|
+
'capture-page': IdentityCall<{
|
|
12533
|
+
options?: OpenFin.CapturePageOptions;
|
|
12534
|
+
}, string>;
|
|
12535
|
+
'execute-javascript-in-window': IdentityCall<{
|
|
12536
|
+
code: string;
|
|
12537
|
+
}, unknown>;
|
|
12538
|
+
'get-zoom-level': IdentityCall<{}, number>;
|
|
12539
|
+
'set-zoom-level': IdentityCall<{
|
|
12540
|
+
level: number;
|
|
12541
|
+
}, void>;
|
|
12542
|
+
'navigate-window': IdentityCall<{
|
|
12543
|
+
url: string;
|
|
12544
|
+
}, void>;
|
|
12545
|
+
'navigate-window-back': IdentityCall<{}, void>;
|
|
12546
|
+
'navigate-window-forward': IdentityCall<{}, void>;
|
|
12547
|
+
'stop-window-navigation': IdentityCall<{}, void>;
|
|
12548
|
+
'reload-window': IdentityCall<{
|
|
12549
|
+
ignoreCache: boolean;
|
|
12550
|
+
}, void>;
|
|
12551
|
+
'print': IdentityCall<{
|
|
12552
|
+
options: OpenFin.PrintOptions;
|
|
12553
|
+
}, void>;
|
|
12554
|
+
'find-in-page': IdentityCall<{
|
|
12555
|
+
searchTerm: string;
|
|
12556
|
+
options?: OpenFin.FindInPageOptions;
|
|
12557
|
+
}, void>;
|
|
12558
|
+
'stop-find-in-page': IdentityCall<{
|
|
12559
|
+
action: 'clearSelection' | 'keepSelection' | 'activateSelection';
|
|
12560
|
+
}, void>;
|
|
12561
|
+
'get-printers': IdentityCall<{}, OpenFin.PrinterInfo>;
|
|
12562
|
+
'focus-window': IdentityCall<{
|
|
12563
|
+
emitSynthFocused: boolean;
|
|
12564
|
+
}, void>;
|
|
12565
|
+
'get-process-info': IdentityCall<{}, OpenFin.EntityProcessDetails>;
|
|
12566
|
+
'get-shared-workers': IdentityCall<{}, OpenFin.SharedWorkerInfo[]>;
|
|
12567
|
+
'inspect-shared-worker': IdentityCall<{}, void>;
|
|
12568
|
+
'inspect-shared-worker-by-id': IdentityCall<{
|
|
12569
|
+
workerId: string;
|
|
12570
|
+
}, void>;
|
|
12571
|
+
'inspect-service-worker': IdentityCall<{}, void>;
|
|
12572
|
+
'view-show-popup-window': IdentityCall<{}, void>;
|
|
12573
|
+
'window-show-popup-window': IdentityCall<{}, void>;
|
|
11996
12574
|
'try-create-popup-window': {
|
|
11997
12575
|
request: OpenFin.Identity & {
|
|
11998
12576
|
options: OpenFin.PopupOptions;
|
|
@@ -12008,9 +12586,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12008
12586
|
};
|
|
12009
12587
|
response: OpenFin.PopupResult;
|
|
12010
12588
|
};
|
|
12011
|
-
'dispatch-popup-result': IdentityCall<{
|
|
12012
|
-
data: any;
|
|
12013
|
-
}>;
|
|
12014
12589
|
'render-overlay': {
|
|
12015
12590
|
request: {
|
|
12016
12591
|
bounds: OpenFin.Bounds;
|
|
@@ -12030,40 +12605,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12030
12605
|
};
|
|
12031
12606
|
response: void;
|
|
12032
12607
|
};
|
|
12033
|
-
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12034
|
-
'get-os-info': GetterCall<OpenFin.OSInfo>;
|
|
12035
|
-
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12036
|
-
'system-register-shutdown-handler': VoidCall;
|
|
12037
|
-
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12038
|
-
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12039
|
-
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12040
|
-
}, void>;
|
|
12041
|
-
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12042
|
-
deltaLeft: number;
|
|
12043
|
-
deltaTop: number;
|
|
12044
|
-
}>>;
|
|
12045
|
-
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12046
|
-
left: number;
|
|
12047
|
-
top: number;
|
|
12048
|
-
}>>;
|
|
12049
|
-
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12050
|
-
deltaWidth: number;
|
|
12051
|
-
deltaHeight: number;
|
|
12052
|
-
anchor: OpenFin.AnchorType;
|
|
12053
|
-
}>>;
|
|
12054
|
-
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12055
|
-
width: number;
|
|
12056
|
-
height: number;
|
|
12057
|
-
anchor: OpenFin.AnchorType;
|
|
12058
|
-
}>>;
|
|
12059
|
-
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12060
|
-
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12061
|
-
'unregister-custom-protocol': ApiCall<{
|
|
12062
|
-
protocolName: string;
|
|
12063
|
-
}, void>;
|
|
12064
|
-
'get-custom-protocol-state': ApiCall<{
|
|
12065
|
-
protocolName: string;
|
|
12066
|
-
}, OpenFin.CustomProtocolState>;
|
|
12067
12608
|
}
|
|
12068
12609
|
|
|
12069
12610
|
declare interface ProtocolMapBase {
|
|
@@ -12093,7 +12634,7 @@ declare type ProviderIdentity_3 = OpenFin.ProviderIdentity;
|
|
|
12093
12634
|
* Identity of a channel provider.
|
|
12094
12635
|
* @interface
|
|
12095
12636
|
*/
|
|
12096
|
-
declare type ProviderIdentity_4 =
|
|
12637
|
+
declare type ProviderIdentity_4 = Identity_4 & {
|
|
12097
12638
|
/**
|
|
12098
12639
|
* Identifier of the channel.
|
|
12099
12640
|
*/
|
|
@@ -12104,12 +12645,10 @@ declare type ProviderIdentity_4 = Identity_5 & {
|
|
|
12104
12645
|
channelName: string;
|
|
12105
12646
|
};
|
|
12106
12647
|
|
|
12107
|
-
declare type ProxyConfig = OpenFin.ProxyConfig;
|
|
12108
|
-
|
|
12109
12648
|
/**
|
|
12110
12649
|
* @interface
|
|
12111
12650
|
*/
|
|
12112
|
-
declare type
|
|
12651
|
+
declare type ProxyConfig = {
|
|
12113
12652
|
/**
|
|
12114
12653
|
* The configured proxy address.
|
|
12115
12654
|
*/
|
|
@@ -12121,13 +12660,11 @@ declare type ProxyConfig_2 = {
|
|
|
12121
12660
|
type: string;
|
|
12122
12661
|
};
|
|
12123
12662
|
|
|
12124
|
-
declare type ProxyInfo = OpenFin.ProxyInfo;
|
|
12125
|
-
|
|
12126
12663
|
/**
|
|
12127
12664
|
* @interface
|
|
12128
12665
|
*/
|
|
12129
|
-
declare type
|
|
12130
|
-
config:
|
|
12666
|
+
declare type ProxyInfo = {
|
|
12667
|
+
config: ProxyConfig;
|
|
12131
12668
|
system: ProxySystemInfo;
|
|
12132
12669
|
};
|
|
12133
12670
|
|
|
@@ -12233,12 +12770,10 @@ declare type RegisterUsageData = {
|
|
|
12233
12770
|
type: string;
|
|
12234
12771
|
};
|
|
12235
12772
|
|
|
12236
|
-
declare type RegistryInfo = OpenFin.RegistryInfo;
|
|
12237
|
-
|
|
12238
12773
|
/**
|
|
12239
12774
|
* @interface
|
|
12240
12775
|
*/
|
|
12241
|
-
declare type
|
|
12776
|
+
declare type RegistryInfo = {
|
|
12242
12777
|
data: any;
|
|
12243
12778
|
rootKey: string;
|
|
12244
12779
|
subkey: string;
|
|
@@ -12296,14 +12831,14 @@ declare type ReplaceLayoutPayload = {
|
|
|
12296
12831
|
/**
|
|
12297
12832
|
* Identity of the window whose layout will be replaced.
|
|
12298
12833
|
*/
|
|
12299
|
-
target:
|
|
12834
|
+
target: Identity_4 | LayoutIdentity;
|
|
12300
12835
|
};
|
|
12301
12836
|
|
|
12302
12837
|
/**
|
|
12303
12838
|
* @interface
|
|
12304
12839
|
*/
|
|
12305
12840
|
declare type ReplaceViewOptions = {
|
|
12306
|
-
viewToReplace:
|
|
12841
|
+
viewToReplace: Identity_4;
|
|
12307
12842
|
newView: ViewState;
|
|
12308
12843
|
};
|
|
12309
12844
|
|
|
@@ -12312,7 +12847,7 @@ declare type ReplaceViewOptions = {
|
|
|
12312
12847
|
*/
|
|
12313
12848
|
declare type ReplaceViewPayload = {
|
|
12314
12849
|
opts: {
|
|
12315
|
-
viewToReplace:
|
|
12850
|
+
viewToReplace: Identity_4;
|
|
12316
12851
|
newView: Partial<ViewOptions>;
|
|
12317
12852
|
};
|
|
12318
12853
|
target: LayoutIdentity;
|
|
@@ -12678,7 +13213,7 @@ declare type SetWindowContextPayload = {
|
|
|
12678
13213
|
/**
|
|
12679
13214
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
12680
13215
|
*/
|
|
12681
|
-
target:
|
|
13216
|
+
target: Identity_4;
|
|
12682
13217
|
};
|
|
12683
13218
|
|
|
12684
13219
|
/**
|
|
@@ -13122,7 +13657,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13122
13657
|
* fin.System.getAllWindows().then(wins => console.log(wins)).catch(err => console.log(err));
|
|
13123
13658
|
* ```
|
|
13124
13659
|
*/
|
|
13125
|
-
getAllWindows(): Promise<Array<ApplicationWindowInfo>>;
|
|
13660
|
+
getAllWindows(): Promise<Array<OpenFin.ApplicationWindowInfo>>;
|
|
13126
13661
|
/**
|
|
13127
13662
|
* Retrieves an array of data for all applications.
|
|
13128
13663
|
*
|
|
@@ -13131,7 +13666,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13131
13666
|
* fin.System.getAllApplications().then(apps => console.log(apps)).catch(err => console.log(err));
|
|
13132
13667
|
* ```
|
|
13133
13668
|
*/
|
|
13134
|
-
getAllApplications(): Promise<Array<ApplicationState>>;
|
|
13669
|
+
getAllApplications(): Promise<Array<OpenFin.ApplicationState>>;
|
|
13135
13670
|
/**
|
|
13136
13671
|
* Retrieves the command line argument string that started OpenFin Runtime.
|
|
13137
13672
|
*
|
|
@@ -13206,7 +13741,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13206
13741
|
* }
|
|
13207
13742
|
* ```
|
|
13208
13743
|
*/
|
|
13209
|
-
getEntityInfo(uuid: string, name: string): Promise<EntityInfo>;
|
|
13744
|
+
getEntityInfo(uuid: string, name: string): Promise<OpenFin.EntityInfo>;
|
|
13210
13745
|
/**
|
|
13211
13746
|
* Gets the value of a given environment variable on the computer on which the runtime is installed
|
|
13212
13747
|
*
|
|
@@ -13248,7 +13783,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13248
13783
|
* ```
|
|
13249
13784
|
*/
|
|
13250
13785
|
getInstalledRuntimes(): Promise<string[]>;
|
|
13251
|
-
getInstalledApps(): Promise<InstalledApps>;
|
|
13786
|
+
getInstalledApps(): Promise<OpenFin.InstalledApps>;
|
|
13252
13787
|
/**
|
|
13253
13788
|
* Retrieves the contents of the log with the specified filename.
|
|
13254
13789
|
* @param options A object that id defined by the GetLogRequestType interface
|
|
@@ -13263,7 +13798,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13263
13798
|
* getLog().then(log => console.log(log)).catch(err => console.log(err));
|
|
13264
13799
|
* ```
|
|
13265
13800
|
*/
|
|
13266
|
-
getLog(options: GetLogRequestType): Promise<string>;
|
|
13801
|
+
getLog(options: OpenFin.GetLogRequestType): Promise<string>;
|
|
13267
13802
|
/**
|
|
13268
13803
|
* Returns a unique identifier (UUID) provided by the machine.
|
|
13269
13804
|
*
|
|
@@ -13281,7 +13816,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13281
13816
|
* fin.System.getMinLogLevel().then(level => console.log(level)).catch(err => console.log(err));
|
|
13282
13817
|
* ```
|
|
13283
13818
|
*/
|
|
13284
|
-
getMinLogLevel(): Promise<LogLevel>;
|
|
13819
|
+
getMinLogLevel(): Promise<OpenFin.LogLevel>;
|
|
13285
13820
|
/**
|
|
13286
13821
|
* Retrieves an array containing information for each log file.
|
|
13287
13822
|
*
|
|
@@ -13290,7 +13825,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13290
13825
|
* fin.System.getLogList().then(logList => console.log(logList)).catch(err => console.log(err));
|
|
13291
13826
|
* ```
|
|
13292
13827
|
*/
|
|
13293
|
-
getLogList(): Promise<Array<LogInfo>>;
|
|
13828
|
+
getLogList(): Promise<Array<OpenFin.LogInfo>>;
|
|
13294
13829
|
/**
|
|
13295
13830
|
* Retrieves an object that contains data about the monitor setup of the
|
|
13296
13831
|
* computer that the runtime is running on.
|
|
@@ -13361,7 +13896,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13361
13896
|
* }
|
|
13362
13897
|
* ```
|
|
13363
13898
|
*/
|
|
13364
|
-
getProxySettings(): Promise<ProxyInfo>;
|
|
13899
|
+
getProxySettings(): Promise<OpenFin.ProxyInfo>;
|
|
13365
13900
|
/**
|
|
13366
13901
|
* Returns information about the running Runtime in an object.
|
|
13367
13902
|
*
|
|
@@ -13728,7 +14263,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13728
14263
|
* }
|
|
13729
14264
|
* ```
|
|
13730
14265
|
*/
|
|
13731
|
-
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<
|
|
14266
|
+
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<Identity>;
|
|
13732
14267
|
/**
|
|
13733
14268
|
* Monitors a running process. A pid for the process must be included in options.
|
|
13734
14269
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -13745,7 +14280,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13745
14280
|
* }).then(processIdentity => console.log(processIdentity)).catch(err => console.log(err));
|
|
13746
14281
|
* ```
|
|
13747
14282
|
*/
|
|
13748
|
-
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<
|
|
14283
|
+
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<Identity>;
|
|
13749
14284
|
/**
|
|
13750
14285
|
* Writes the passed message into both the log file and the console.
|
|
13751
14286
|
* @param level The log level for the entry. Can be either "info", "warning" or "error"
|
|
@@ -13879,7 +14414,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13879
14414
|
*
|
|
13880
14415
|
* @tutorial System.showDeveloperTools
|
|
13881
14416
|
*/
|
|
13882
|
-
showDeveloperTools(identity:
|
|
14417
|
+
showDeveloperTools(identity: Identity): Promise<void>;
|
|
13883
14418
|
/**
|
|
13884
14419
|
* Attempt to close an external process. The process will be terminated if it
|
|
13885
14420
|
* has not closed after the elapsed timeout in milliseconds.
|
|
@@ -13913,7 +14448,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13913
14448
|
* .catch(err => console.error(err));
|
|
13914
14449
|
* ```
|
|
13915
14450
|
*/
|
|
13916
|
-
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
14451
|
+
updateProxySettings(options: OpenFin.ProxyConfig): Promise<void>;
|
|
13917
14452
|
/**
|
|
13918
14453
|
* Downloads the given application asset.
|
|
13919
14454
|
*
|
|
@@ -14005,7 +14540,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14005
14540
|
* .catch(err => console.log(err));
|
|
14006
14541
|
* ```
|
|
14007
14542
|
*/
|
|
14008
|
-
getAllExternalApplications(): Promise<Array<
|
|
14543
|
+
getAllExternalApplications(): Promise<Array<Identity>>;
|
|
14009
14544
|
/**
|
|
14010
14545
|
* Retrieves app asset information.
|
|
14011
14546
|
* @param options
|
|
@@ -14034,7 +14569,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14034
14569
|
* fin.System.setMinLogLevel("verbose").then(() => console.log("log level is set to verbose")).catch(err => console.log(err));
|
|
14035
14570
|
* ```
|
|
14036
14571
|
*/
|
|
14037
|
-
setMinLogLevel(level: LogLevel): Promise<void>;
|
|
14572
|
+
setMinLogLevel(level: OpenFin.LogLevel): Promise<void>;
|
|
14038
14573
|
/**
|
|
14039
14574
|
* Retrieves the UUID of the computer on which the runtime is installed
|
|
14040
14575
|
* @param uuid The uuid of the running application
|
|
@@ -14044,7 +14579,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14044
14579
|
* fin.System.resolveUuid('OpenfinPOC').then(entity => console.log(entity)).catch(err => console.log(err));
|
|
14045
14580
|
* ```
|
|
14046
14581
|
*/
|
|
14047
|
-
resolveUuid(uuid: string): Promise<
|
|
14582
|
+
resolveUuid(uuid: string): Promise<OpenFin.ApplicationType>;
|
|
14048
14583
|
/**
|
|
14049
14584
|
* Retrieves an array of data for all external applications
|
|
14050
14585
|
* @param requestingIdentity This object is described in the Identity typedef
|
|
@@ -14052,7 +14587,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14052
14587
|
*
|
|
14053
14588
|
* @ignore
|
|
14054
14589
|
*/
|
|
14055
|
-
executeOnRemote(requestingIdentity:
|
|
14590
|
+
executeOnRemote(requestingIdentity: Identity, data: any): Promise<any>;
|
|
14056
14591
|
/**
|
|
14057
14592
|
* Reads the specifed value from the registry.
|
|
14058
14593
|
* @remarks This method is restricted by default and must be enabled via
|
|
@@ -14145,7 +14680,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14145
14680
|
* }
|
|
14146
14681
|
* ```
|
|
14147
14682
|
*/
|
|
14148
|
-
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<RegistryInfo>;
|
|
14683
|
+
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<OpenFin.RegistryInfo>;
|
|
14149
14684
|
/**
|
|
14150
14685
|
* This function call will register a unique id and produce a token.
|
|
14151
14686
|
* The token can be used to broker an external connection.
|
|
@@ -14360,7 +14895,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14360
14895
|
* });
|
|
14361
14896
|
* ```
|
|
14362
14897
|
*/
|
|
14363
|
-
getPrinters(): Promise<PrinterInfo[]>;
|
|
14898
|
+
getPrinters(): Promise<OpenFin.PrinterInfo[]>;
|
|
14364
14899
|
/**
|
|
14365
14900
|
* Updates Process Logging values: periodic interval and outlier detection entries and interval.
|
|
14366
14901
|
* @param options Process Logging updatable options.
|
|
@@ -14979,14 +15514,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
14979
15514
|
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
|
14980
15515
|
|
|
14981
15516
|
/**
|
|
14982
|
-
*
|
|
15517
|
+
* An event that fires when a window's bounds are changed directly by the user.
|
|
15518
|
+
*
|
|
14983
15519
|
* @interface
|
|
14984
15520
|
*/
|
|
14985
|
-
declare type UserBoundsChangeEvent =
|
|
14986
|
-
height: number;
|
|
14987
|
-
left: number;
|
|
14988
|
-
top: number;
|
|
14989
|
-
width: number;
|
|
15521
|
+
declare type UserBoundsChangeEvent = BoundsEvent & {
|
|
14990
15522
|
windowState: 'minimized' | 'normal' | 'maximized';
|
|
14991
15523
|
};
|
|
14992
15524
|
|
|
@@ -15421,7 +15953,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
15421
15953
|
*/
|
|
15422
15954
|
getInfo: () => Promise<OpenFin.ViewInfo>;
|
|
15423
15955
|
/**
|
|
15424
|
-
* Retrieves the
|
|
15956
|
+
* Retrieves the OpenFin.Layout instance for the Window the View is attached to.
|
|
15425
15957
|
*
|
|
15426
15958
|
* @example
|
|
15427
15959
|
* ```js
|
|
@@ -15585,6 +16117,24 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
15585
16117
|
options?: Partial<ViewOptions>;
|
|
15586
16118
|
};
|
|
15587
16119
|
|
|
16120
|
+
/**
|
|
16121
|
+
* @interface
|
|
16122
|
+
*/
|
|
16123
|
+
declare type ViewCreationFailure = {
|
|
16124
|
+
/**
|
|
16125
|
+
* The identity of the created view
|
|
16126
|
+
*/
|
|
16127
|
+
identity: Identity_4;
|
|
16128
|
+
/**
|
|
16129
|
+
* Whether the view was created with errors
|
|
16130
|
+
*/
|
|
16131
|
+
success: false;
|
|
16132
|
+
/**
|
|
16133
|
+
* Error thrown during view creation
|
|
16134
|
+
*/
|
|
16135
|
+
error: Error;
|
|
16136
|
+
};
|
|
16137
|
+
|
|
15588
16138
|
/**
|
|
15589
16139
|
* The options object required by {@link View.ViewModule.create View.create}.
|
|
15590
16140
|
*
|
|
@@ -15595,11 +16145,30 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
15595
16145
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
15596
16146
|
name: string;
|
|
15597
16147
|
url: string;
|
|
15598
|
-
target:
|
|
16148
|
+
target: Identity_4;
|
|
15599
16149
|
};
|
|
15600
16150
|
|
|
15601
16151
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
|
15602
16152
|
|
|
16153
|
+
/**
|
|
16154
|
+
* A view creation state
|
|
16155
|
+
*/
|
|
16156
|
+
declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
|
|
16157
|
+
|
|
16158
|
+
/**
|
|
16159
|
+
* @interface
|
|
16160
|
+
*/
|
|
16161
|
+
declare type ViewCreationSuccess = {
|
|
16162
|
+
/**
|
|
16163
|
+
* The identity of the created view
|
|
16164
|
+
*/
|
|
16165
|
+
identity: Identity_4;
|
|
16166
|
+
/**
|
|
16167
|
+
* Whether the view was created without errors
|
|
16168
|
+
*/
|
|
16169
|
+
success: true;
|
|
16170
|
+
};
|
|
16171
|
+
|
|
15603
16172
|
/**
|
|
15604
16173
|
* Generated when a window has a view detached from it.
|
|
15605
16174
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
@@ -15781,15 +16350,15 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
15781
16350
|
/**
|
|
15782
16351
|
* Identity of the Window.
|
|
15783
16352
|
*/
|
|
15784
|
-
windowId:
|
|
16353
|
+
windowId: Identity_4;
|
|
15785
16354
|
/**
|
|
15786
16355
|
* Identities of the Views that are preventing an unload
|
|
15787
16356
|
*/
|
|
15788
|
-
viewsPreventingUnload:
|
|
16357
|
+
viewsPreventingUnload: Identity_4[];
|
|
15789
16358
|
/**
|
|
15790
16359
|
* Identities of the Views that are not preventing an unload
|
|
15791
16360
|
*/
|
|
15792
|
-
viewsNotPreventingUnload:
|
|
16361
|
+
viewsNotPreventingUnload: Identity_4[];
|
|
15793
16362
|
/**
|
|
15794
16363
|
* Source of the close action.
|
|
15795
16364
|
*/
|
|
@@ -15814,11 +16383,11 @@ declare interface ViewStatuses {
|
|
|
15814
16383
|
/**
|
|
15815
16384
|
* Identities of the Views that are preventing an unload.
|
|
15816
16385
|
*/
|
|
15817
|
-
viewsPreventingUnload:
|
|
16386
|
+
viewsPreventingUnload: Identity_4[];
|
|
15818
16387
|
/**
|
|
15819
16388
|
* Identities of the Views that are not preventing an unload.
|
|
15820
16389
|
*/
|
|
15821
|
-
viewsNotPreventingUnload:
|
|
16390
|
+
viewsNotPreventingUnload: Identity_4[];
|
|
15822
16391
|
}
|
|
15823
16392
|
|
|
15824
16393
|
/**
|
|
@@ -16323,7 +16892,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
16323
16892
|
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
16324
16893
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
16325
16894
|
*/
|
|
16326
|
-
stopFindInPage(action:
|
|
16895
|
+
stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): Promise<void>;
|
|
16327
16896
|
/**
|
|
16328
16897
|
* Returns an array with all system printers
|
|
16329
16898
|
* @deprecated use System.getPrinters instead
|
|
@@ -16916,11 +17485,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
16916
17485
|
* A general will-move or will-resize event without event type.
|
|
16917
17486
|
* @interface
|
|
16918
17487
|
*/
|
|
16919
|
-
declare type WillMoveOrResizeEvent =
|
|
16920
|
-
height: number;
|
|
16921
|
-
left: number;
|
|
16922
|
-
top: number;
|
|
16923
|
-
width: number;
|
|
17488
|
+
declare type WillMoveOrResizeEvent = BoundsEvent & {
|
|
16924
17489
|
monitorScaleFactor: number;
|
|
16925
17490
|
};
|
|
16926
17491
|
|
|
@@ -18112,16 +18677,21 @@ declare namespace WindowEvents {
|
|
|
18112
18677
|
PreloadScriptInfoRunning,
|
|
18113
18678
|
PreloadScriptInfo,
|
|
18114
18679
|
PreloadScriptsStateChangeEvent,
|
|
18115
|
-
|
|
18680
|
+
BoundsEvent,
|
|
18116
18681
|
BoundsChangeEvent,
|
|
18117
18682
|
WillMoveOrResizeEvent,
|
|
18683
|
+
BoundsDidChangeEvent,
|
|
18684
|
+
BoundsChangedEvent,
|
|
18685
|
+
BoundsChangingEvent,
|
|
18686
|
+
DisabledMovementBoundsChangedEvent,
|
|
18687
|
+
DisabledMovementBoundsChangingEvent,
|
|
18688
|
+
UserBoundsChangeEvent,
|
|
18689
|
+
BeginUserBoundsChangingEvent,
|
|
18690
|
+
EndUserBoundsChangingEvent,
|
|
18118
18691
|
PerformanceReportEvent,
|
|
18119
18692
|
InputEvent_2 as InputEvent,
|
|
18120
18693
|
LayoutInitializedEvent,
|
|
18121
18694
|
LayoutReadyEvent,
|
|
18122
|
-
BeginUserBoundsChangingEvent,
|
|
18123
|
-
BoundsChangedEvent,
|
|
18124
|
-
BoundsChangingEvent,
|
|
18125
18695
|
CloseRequestedEvent,
|
|
18126
18696
|
WindowCloseRequestedEvent,
|
|
18127
18697
|
ContextChangedEvent,
|
|
@@ -18129,10 +18699,7 @@ declare namespace WindowEvents {
|
|
|
18129
18699
|
WindowClosedEvent,
|
|
18130
18700
|
ClosingEvent,
|
|
18131
18701
|
WindowClosingEvent,
|
|
18132
|
-
DisabledMovementBoundsChangedEvent,
|
|
18133
|
-
DisabledMovementBoundsChangingEvent,
|
|
18134
18702
|
EmbeddedEvent,
|
|
18135
|
-
EndUserBoundsChangingEvent,
|
|
18136
18703
|
HotkeyEvent_2 as HotkeyEvent,
|
|
18137
18704
|
WindowHotkeyEvent,
|
|
18138
18705
|
InitializedEvent_2 as InitializedEvent,
|