@openfin/core 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/mock-alpha.d.ts +791 -224
- package/out/mock-beta.d.ts +791 -224
- package/out/mock-public.d.ts +791 -224
- package/out/mock.d.ts +794 -224
- package/out/mock.js +1477 -1329
- package/package.json +1 -1
package/out/mock.d.ts
CHANGED
|
@@ -61,7 +61,7 @@ declare type AddedToLayoutEvent = BaseEvent_4 & {
|
|
|
61
61
|
*/
|
|
62
62
|
declare type AddViewOptions = CreateViewTarget & {
|
|
63
63
|
options: ViewState;
|
|
64
|
-
targetView?:
|
|
64
|
+
targetView?: Identity_4;
|
|
65
65
|
};
|
|
66
66
|
|
|
67
67
|
/**
|
|
@@ -939,15 +939,15 @@ declare namespace ApplicationEvents {
|
|
|
939
939
|
*/
|
|
940
940
|
declare type ApplicationEventType = EventType_3;
|
|
941
941
|
|
|
942
|
-
declare type ApplicationIdentity = OpenFin_2.ApplicationIdentity;
|
|
943
|
-
|
|
944
942
|
/**
|
|
945
943
|
* @interface
|
|
946
944
|
*/
|
|
947
|
-
declare type
|
|
945
|
+
declare type ApplicationIdentity = {
|
|
948
946
|
uuid: string;
|
|
949
947
|
};
|
|
950
948
|
|
|
949
|
+
declare type ApplicationIdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin_2.ApplicationIdentity, Response>;
|
|
950
|
+
|
|
951
951
|
/**
|
|
952
952
|
* @interface
|
|
953
953
|
*/
|
|
@@ -1320,12 +1320,10 @@ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedE
|
|
|
1320
1320
|
*/
|
|
1321
1321
|
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1322
1322
|
|
|
1323
|
-
declare type ApplicationState = OpenFin_2.ApplicationState;
|
|
1324
|
-
|
|
1325
1323
|
/**
|
|
1326
1324
|
* @interface
|
|
1327
1325
|
*/
|
|
1328
|
-
declare type
|
|
1326
|
+
declare type ApplicationState = {
|
|
1329
1327
|
/**
|
|
1330
1328
|
* True when the application is a Platform controller
|
|
1331
1329
|
*/
|
|
@@ -1357,12 +1355,10 @@ declare type ApplicationType = {
|
|
|
1357
1355
|
*/
|
|
1358
1356
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
|
1359
1357
|
|
|
1360
|
-
declare type ApplicationWindowInfo = OpenFin_2.ApplicationWindowInfo;
|
|
1361
|
-
|
|
1362
1358
|
/**
|
|
1363
1359
|
* @interface
|
|
1364
1360
|
*/
|
|
1365
|
-
declare type
|
|
1361
|
+
declare type ApplicationWindowInfo = {
|
|
1366
1362
|
childWindows: Array<WindowDetail>;
|
|
1367
1363
|
mainWindow: WindowDetail;
|
|
1368
1364
|
/**
|
|
@@ -1638,7 +1634,7 @@ declare class Base {
|
|
|
1638
1634
|
* @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
|
|
1639
1635
|
* guaranteed to behave sensibly in all calling contexts.
|
|
1640
1636
|
*/
|
|
1641
|
-
get me(): Identity;
|
|
1637
|
+
get me(): OpenFin_2.Identity;
|
|
1642
1638
|
/**
|
|
1643
1639
|
* @internal
|
|
1644
1640
|
* @deprecated
|
|
@@ -1870,11 +1866,12 @@ declare type BeforeUnloadUserDecision = {
|
|
|
1870
1866
|
/**
|
|
1871
1867
|
* Array of views that will close.
|
|
1872
1868
|
*/
|
|
1873
|
-
viewsToClose:
|
|
1869
|
+
viewsToClose: Identity_4[];
|
|
1874
1870
|
};
|
|
1875
1871
|
|
|
1876
1872
|
/**
|
|
1877
1873
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
|
1874
|
+
*
|
|
1878
1875
|
* @interface
|
|
1879
1876
|
*/
|
|
1880
1877
|
declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
@@ -1915,31 +1912,33 @@ declare type Bounds = {
|
|
|
1915
1912
|
* Generated after changes in a window's size and/or position.
|
|
1916
1913
|
* @interface
|
|
1917
1914
|
*/
|
|
1918
|
-
declare type BoundsChangedEvent =
|
|
1915
|
+
declare type BoundsChangedEvent = BoundsDidChangeEvent & {
|
|
1919
1916
|
type: 'bounds-changed';
|
|
1920
1917
|
};
|
|
1921
1918
|
|
|
1922
|
-
|
|
1923
|
-
* A general bounds change event without event type.
|
|
1924
|
-
* @interface
|
|
1925
|
-
*/
|
|
1926
|
-
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1919
|
+
declare type BoundsChangeEvent = BoundsEvent & {
|
|
1927
1920
|
changeType: 0 | 1 | 2;
|
|
1928
|
-
deferred: boolean;
|
|
1929
|
-
height: number;
|
|
1930
|
-
left: number;
|
|
1931
|
-
top: number;
|
|
1932
|
-
width: number;
|
|
1933
1921
|
};
|
|
1934
1922
|
|
|
1935
1923
|
/**
|
|
1936
1924
|
* Generated during changes to a window's size and/or position.
|
|
1937
1925
|
* @interface
|
|
1938
1926
|
*/
|
|
1939
|
-
declare type BoundsChangingEvent =
|
|
1927
|
+
declare type BoundsChangingEvent = BoundsDidChangeEvent & {
|
|
1940
1928
|
type: 'bounds-changing';
|
|
1941
1929
|
};
|
|
1942
1930
|
|
|
1931
|
+
/**
|
|
1932
|
+
* An event that fires when a window's bounds are successfully changed.
|
|
1933
|
+
*
|
|
1934
|
+
* @interface
|
|
1935
|
+
*/
|
|
1936
|
+
declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
1937
|
+
reason: 'self' | 'animation';
|
|
1938
|
+
};
|
|
1939
|
+
|
|
1940
|
+
declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
|
|
1941
|
+
|
|
1943
1942
|
/**
|
|
1944
1943
|
* A rule prescribing content creation in the browser.
|
|
1945
1944
|
*
|
|
@@ -3045,7 +3044,7 @@ declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
|
3045
3044
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
3046
3045
|
* @interface
|
|
3047
3046
|
*/
|
|
3048
|
-
declare type ClientIdentity =
|
|
3047
|
+
declare type ClientIdentity = Identity_4 & {
|
|
3049
3048
|
/**
|
|
3050
3049
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
|
3051
3050
|
*/
|
|
@@ -3278,7 +3277,7 @@ declare type CloseViewOptions = {
|
|
|
3278
3277
|
/**
|
|
3279
3278
|
*View to be closed.
|
|
3280
3279
|
*/
|
|
3281
|
-
viewIdentity:
|
|
3280
|
+
viewIdentity: Identity_4;
|
|
3282
3281
|
};
|
|
3283
3282
|
|
|
3284
3283
|
/**
|
|
@@ -3288,7 +3287,7 @@ declare type CloseViewPayload = {
|
|
|
3288
3287
|
/**
|
|
3289
3288
|
*View to be closed.
|
|
3290
3289
|
*/
|
|
3291
|
-
view:
|
|
3290
|
+
view: Identity_4;
|
|
3292
3291
|
/**
|
|
3293
3292
|
* The target layout identity where this view should be closed. If not provided, will resolve to the
|
|
3294
3293
|
* visible layout.
|
|
@@ -3306,7 +3305,7 @@ declare interface CloseWindowPayload {
|
|
|
3306
3305
|
*
|
|
3307
3306
|
* Identity of the Window
|
|
3308
3307
|
*/
|
|
3309
|
-
windowId:
|
|
3308
|
+
windowId: Identity_4;
|
|
3310
3309
|
options: {
|
|
3311
3310
|
/**
|
|
3312
3311
|
* @defaultValue false
|
|
@@ -3427,7 +3426,7 @@ declare type ConstViewOptions = {
|
|
|
3427
3426
|
/**
|
|
3428
3427
|
* The identity of the window this view should be attached to.
|
|
3429
3428
|
*/
|
|
3430
|
-
target:
|
|
3429
|
+
target: Identity_4;
|
|
3431
3430
|
/**
|
|
3432
3431
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3433
3432
|
*/
|
|
@@ -3652,7 +3651,7 @@ declare type ConstWindowOptions = {
|
|
|
3652
3651
|
/**
|
|
3653
3652
|
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
3654
3653
|
*/
|
|
3655
|
-
modalParentIdentity:
|
|
3654
|
+
modalParentIdentity: Identity_4;
|
|
3656
3655
|
/**
|
|
3657
3656
|
* The name of the window.
|
|
3658
3657
|
*/
|
|
@@ -3670,7 +3669,9 @@ declare type ConstWindowOptions = {
|
|
|
3670
3669
|
*/
|
|
3671
3670
|
preloadScripts: PreloadScript[];
|
|
3672
3671
|
/**
|
|
3673
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
3672
|
+
* String tag that attempts to group like-tagged renderers together.
|
|
3673
|
+
* 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.
|
|
3674
|
+
* @remarks Will only be used if pages are on the same origin.
|
|
3674
3675
|
*/
|
|
3675
3676
|
processAffinity: string;
|
|
3676
3677
|
/**
|
|
@@ -3717,11 +3718,6 @@ declare type ConstWindowOptions = {
|
|
|
3717
3718
|
* @deprecated - use `icon` instead.
|
|
3718
3719
|
*/
|
|
3719
3720
|
taskbarIcon: string;
|
|
3720
|
-
/**
|
|
3721
|
-
* Specify a taskbar group for the window.
|
|
3722
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
3723
|
-
*/
|
|
3724
|
-
taskbarIconGroup: string;
|
|
3725
3721
|
/**
|
|
3726
3722
|
* @defaultValue "about:blank"
|
|
3727
3723
|
*
|
|
@@ -4136,13 +4132,13 @@ declare type CreateViewPayload = {
|
|
|
4136
4132
|
* Window the view will be added to. If no target is provided, a new window will be created.
|
|
4137
4133
|
*/
|
|
4138
4134
|
target?: CreateViewTarget;
|
|
4139
|
-
targetView?:
|
|
4135
|
+
targetView?: Identity_4;
|
|
4140
4136
|
};
|
|
4141
4137
|
|
|
4142
4138
|
/**
|
|
4143
4139
|
* @interface
|
|
4144
4140
|
*/
|
|
4145
|
-
declare type CreateViewTarget = (
|
|
4141
|
+
declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
|
|
4146
4142
|
/**
|
|
4147
4143
|
* If specified, view creation will not attach to a window and caller must
|
|
4148
4144
|
* insert the view into the layout explicitly
|
|
@@ -4588,7 +4584,7 @@ declare type EmitterAccessor = string[];
|
|
|
4588
4584
|
declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType extends EmitterEvent['type'] = EmitterEvent['type']> extends Base {
|
|
4589
4585
|
#private;
|
|
4590
4586
|
private topic;
|
|
4591
|
-
protected identity: ApplicationIdentity;
|
|
4587
|
+
protected identity: OpenFin_2.ApplicationIdentity;
|
|
4592
4588
|
constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
|
|
4593
4589
|
eventNames: () => (string | symbol)[];
|
|
4594
4590
|
/**
|
|
@@ -4668,20 +4664,17 @@ declare type EndLoadEvent = BaseEvent_5 & {
|
|
|
4668
4664
|
|
|
4669
4665
|
/**
|
|
4670
4666
|
* Generated at the end of a user-driven change to a window's size or position.
|
|
4667
|
+
*
|
|
4671
4668
|
* @interface
|
|
4672
4669
|
*/
|
|
4673
4670
|
declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
4674
4671
|
type: 'end-user-bounds-changing';
|
|
4675
4672
|
};
|
|
4676
4673
|
|
|
4677
|
-
declare type Entity = OpenFin_2.ApplicationType;
|
|
4678
|
-
|
|
4679
|
-
declare type EntityInfo = OpenFin_2.EntityInfo;
|
|
4680
|
-
|
|
4681
4674
|
/**
|
|
4682
4675
|
* @interface
|
|
4683
4676
|
*/
|
|
4684
|
-
declare type
|
|
4677
|
+
declare type EntityInfo = {
|
|
4685
4678
|
uuid: string;
|
|
4686
4679
|
name: string;
|
|
4687
4680
|
entityType: EntityType_4;
|
|
@@ -4767,6 +4760,7 @@ declare interface Environment {
|
|
|
4767
4760
|
getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
|
|
4768
4761
|
fdc3Version?: Version;
|
|
4769
4762
|
}>;
|
|
4763
|
+
getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
|
|
4770
4764
|
readonly type: EnvironmentType;
|
|
4771
4765
|
}
|
|
4772
4766
|
|
|
@@ -5051,7 +5045,7 @@ declare type ExternalApplicationEventType = EventType_4;
|
|
|
5051
5045
|
* @interface
|
|
5052
5046
|
*/
|
|
5053
5047
|
declare type ExternalApplicationInfo = {
|
|
5054
|
-
parent:
|
|
5048
|
+
parent: Identity_4;
|
|
5055
5049
|
};
|
|
5056
5050
|
|
|
5057
5051
|
/**
|
|
@@ -5514,7 +5508,7 @@ declare type FrameInfo = {
|
|
|
5514
5508
|
uuid: string;
|
|
5515
5509
|
url: string;
|
|
5516
5510
|
entityType: EntityType_4;
|
|
5517
|
-
parent:
|
|
5511
|
+
parent: Identity_4;
|
|
5518
5512
|
};
|
|
5519
5513
|
|
|
5520
5514
|
/**
|
|
@@ -5589,12 +5583,10 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
5589
5583
|
entityType: string;
|
|
5590
5584
|
};
|
|
5591
5585
|
|
|
5592
|
-
declare type GetLogRequestType = OpenFin_2.GetLogRequestType;
|
|
5593
|
-
|
|
5594
5586
|
/**
|
|
5595
5587
|
* @interface
|
|
5596
5588
|
*/
|
|
5597
|
-
declare type
|
|
5589
|
+
declare type GetLogRequestType = {
|
|
5598
5590
|
/**
|
|
5599
5591
|
* The name of the running application
|
|
5600
5592
|
*/
|
|
@@ -5614,7 +5606,7 @@ declare type GetWindowContextPayload = {
|
|
|
5614
5606
|
/**
|
|
5615
5607
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
5616
5608
|
*/
|
|
5617
|
-
target:
|
|
5609
|
+
target: Identity_4;
|
|
5618
5610
|
};
|
|
5619
5611
|
|
|
5620
5612
|
/**
|
|
@@ -5883,8 +5875,6 @@ declare type Identity_2 = OpenFin_2.Identity;
|
|
|
5883
5875
|
|
|
5884
5876
|
declare type Identity_3 = OpenFin_2.Identity;
|
|
5885
5877
|
|
|
5886
|
-
declare type Identity_4 = OpenFin_2.Identity;
|
|
5887
|
-
|
|
5888
5878
|
/**
|
|
5889
5879
|
* Unique identifier for a window, view or iframe.
|
|
5890
5880
|
*
|
|
@@ -5893,7 +5883,7 @@ declare type Identity_4 = OpenFin_2.Identity;
|
|
|
5893
5883
|
*
|
|
5894
5884
|
* @interface
|
|
5895
5885
|
*/
|
|
5896
|
-
declare type
|
|
5886
|
+
declare type Identity_4 = {
|
|
5897
5887
|
/**
|
|
5898
5888
|
* Universally unique identifier of the application that owns the component.
|
|
5899
5889
|
*/
|
|
@@ -6055,12 +6045,10 @@ declare type InstallationInfo = {
|
|
|
6055
6045
|
cachedManifest: any;
|
|
6056
6046
|
};
|
|
6057
6047
|
|
|
6058
|
-
declare type InstalledApps = OpenFin_2.InstalledApps;
|
|
6059
|
-
|
|
6060
6048
|
/**
|
|
6061
6049
|
* @interface
|
|
6062
6050
|
*/
|
|
6063
|
-
declare type
|
|
6051
|
+
declare type InstalledApps = {
|
|
6064
6052
|
[key: string]: InstallationInfo;
|
|
6065
6053
|
};
|
|
6066
6054
|
|
|
@@ -6846,7 +6834,7 @@ declare class InteropBroker extends Base {
|
|
|
6846
6834
|
* @param _id the identity tryinc to connect
|
|
6847
6835
|
* @param _connectionPayload optional payload to use in custom implementations, will be undefined by default
|
|
6848
6836
|
*/
|
|
6849
|
-
isConnectionAuthorized(_id:
|
|
6837
|
+
isConnectionAuthorized(_id: Identity_2, _connectionPayload?: any): Promise<boolean> | boolean;
|
|
6850
6838
|
/**
|
|
6851
6839
|
* Called before every action to check if this entity should be allowed to take the action.
|
|
6852
6840
|
* Return false to prevent the action
|
|
@@ -7647,6 +7635,10 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
7647
7635
|
*/
|
|
7648
7636
|
declare class Layout extends Base {
|
|
7649
7637
|
#private;
|
|
7638
|
+
/**
|
|
7639
|
+
* @internal
|
|
7640
|
+
*/
|
|
7641
|
+
static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
|
|
7650
7642
|
/**
|
|
7651
7643
|
* @internal
|
|
7652
7644
|
*/
|
|
@@ -7752,6 +7744,17 @@ declare class Layout extends Base {
|
|
|
7752
7744
|
* ```
|
|
7753
7745
|
*/
|
|
7754
7746
|
getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
|
|
7747
|
+
/**
|
|
7748
|
+
* Retrieves the OpenFin.TabStack instance which the View belongs to.
|
|
7749
|
+
*
|
|
7750
|
+
* @example
|
|
7751
|
+
* ```js
|
|
7752
|
+
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
|
7753
|
+
* const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
|
|
7754
|
+
* console.log(await stack.getViews());
|
|
7755
|
+
* ```
|
|
7756
|
+
*/
|
|
7757
|
+
getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
|
|
7755
7758
|
/**
|
|
7756
7759
|
* Replaces the specified view with a view with the provided configuration.
|
|
7757
7760
|
*
|
|
@@ -7778,7 +7781,7 @@ declare class Layout extends Base {
|
|
|
7778
7781
|
* await layout.replaceView(viewToReplace.identity, newViewConfig);
|
|
7779
7782
|
* ```
|
|
7780
7783
|
*/
|
|
7781
|
-
replaceView: (viewToReplace:
|
|
7784
|
+
replaceView: (viewToReplace: Identity_3, newView: OpenFin_2.PlatformViewCreationOptions) => Promise<void>;
|
|
7782
7785
|
/**
|
|
7783
7786
|
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
7784
7787
|
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
@@ -7805,6 +7808,29 @@ declare class Layout extends Base {
|
|
|
7805
7808
|
* ```
|
|
7806
7809
|
*/
|
|
7807
7810
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
7811
|
+
/**
|
|
7812
|
+
* Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
|
|
7813
|
+
*
|
|
7814
|
+
* @param viewOptions - The options for creating the view.
|
|
7815
|
+
* @param options - Optional parameters for adding the view.
|
|
7816
|
+
* @param options.location - The location where the view should be added.
|
|
7817
|
+
* @param options.targetView - The target view to which the new view should be added.
|
|
7818
|
+
* @returns A promise that resolves to an object containing the identity of the added view.
|
|
7819
|
+
*/
|
|
7820
|
+
addView(viewOptions: OpenFin_2.PlatformViewCreationOptions, { location, targetView }?: {
|
|
7821
|
+
location?: OpenFin_2.CreateViewTarget['location'];
|
|
7822
|
+
targetView?: OpenFin_2.Identity;
|
|
7823
|
+
}): Promise<{
|
|
7824
|
+
identity: OpenFin_2.Identity;
|
|
7825
|
+
}>;
|
|
7826
|
+
/**
|
|
7827
|
+
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
7828
|
+
* Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
|
|
7829
|
+
*
|
|
7830
|
+
* @param viewIdentity - The identity of the view to close.
|
|
7831
|
+
* @returns A promise that resolves when the view is closed.
|
|
7832
|
+
*/
|
|
7833
|
+
closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
|
|
7808
7834
|
}
|
|
7809
7835
|
|
|
7810
7836
|
/**
|
|
@@ -7817,7 +7843,7 @@ declare type LayoutColumn = LayoutItemConfig & {
|
|
|
7817
7843
|
/**
|
|
7818
7844
|
* @interface
|
|
7819
7845
|
*/
|
|
7820
|
-
declare type LayoutComponent = LayoutItemConfig & {
|
|
7846
|
+
declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
7821
7847
|
/**
|
|
7822
7848
|
* Only a component type will have this property and it should be set to view.
|
|
7823
7849
|
*/
|
|
@@ -7826,6 +7852,7 @@ declare type LayoutComponent = LayoutItemConfig & {
|
|
|
7826
7852
|
* Only a component type will have this property and it represents the view options of a given component.
|
|
7827
7853
|
*/
|
|
7828
7854
|
componentState?: Partial<ViewCreationOptions>;
|
|
7855
|
+
type: 'component';
|
|
7829
7856
|
};
|
|
7830
7857
|
|
|
7831
7858
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
|
@@ -7833,7 +7860,7 @@ declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn |
|
|
|
7833
7860
|
/**
|
|
7834
7861
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
|
7835
7862
|
*/
|
|
7836
|
-
declare type LayoutDOMEvent =
|
|
7863
|
+
declare type LayoutDOMEvent = Identity_4 & {
|
|
7837
7864
|
type: string;
|
|
7838
7865
|
topic: 'openfin-DOM-event';
|
|
7839
7866
|
tabSelector: string;
|
|
@@ -7894,7 +7921,7 @@ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
|
|
|
7894
7921
|
/**
|
|
7895
7922
|
* @interface
|
|
7896
7923
|
*/
|
|
7897
|
-
declare type LayoutIdentity =
|
|
7924
|
+
declare type LayoutIdentity = Identity_4 & {
|
|
7898
7925
|
/**
|
|
7899
7926
|
* The name of the layout in a given window.
|
|
7900
7927
|
*/
|
|
@@ -7909,10 +7936,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
|
7909
7936
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
7910
7937
|
type: 'layout-initialized';
|
|
7911
7938
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
|
7912
|
-
ofViews:
|
|
7913
|
-
identity: OpenFin_2.Identity;
|
|
7914
|
-
entityType: 'view';
|
|
7915
|
-
}[];
|
|
7939
|
+
ofViews: OpenFin_2.ViewCreationResult[];
|
|
7916
7940
|
};
|
|
7917
7941
|
|
|
7918
7942
|
/**
|
|
@@ -8003,7 +8027,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8003
8027
|
* @param identity
|
|
8004
8028
|
* @returns LayoutIdentity | undefined
|
|
8005
8029
|
*/
|
|
8006
|
-
resolveLayoutIdentity(identity?:
|
|
8030
|
+
resolveLayoutIdentity(identity?: Identity_4 | LayoutIdentity): LayoutIdentity | undefined;
|
|
8007
8031
|
/**
|
|
8008
8032
|
* @experimental
|
|
8009
8033
|
*
|
|
@@ -8020,7 +8044,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8020
8044
|
/**
|
|
8021
8045
|
* @experimental
|
|
8022
8046
|
*/
|
|
8023
|
-
getLayoutIdentityForView(viewIdentity:
|
|
8047
|
+
getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
|
|
8024
8048
|
/**
|
|
8025
8049
|
* @experimental
|
|
8026
8050
|
*/
|
|
@@ -8121,6 +8145,17 @@ declare class LayoutModule extends Base {
|
|
|
8121
8145
|
* ```
|
|
8122
8146
|
*/
|
|
8123
8147
|
getCurrentSync(): OpenFin_2.Layout;
|
|
8148
|
+
/**
|
|
8149
|
+
* Retrieves the OpenFin.Layout instance for the Window the View is attached to.
|
|
8150
|
+
*
|
|
8151
|
+
* @example
|
|
8152
|
+
* ```js
|
|
8153
|
+
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
|
8154
|
+
* const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
|
|
8155
|
+
* console.log(await layout.getCurrentViews());
|
|
8156
|
+
* ```
|
|
8157
|
+
*/
|
|
8158
|
+
getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
|
|
8124
8159
|
/**
|
|
8125
8160
|
* Initialize the window's Layout.
|
|
8126
8161
|
*
|
|
@@ -8494,12 +8529,10 @@ declare type Listener<T extends {
|
|
|
8494
8529
|
type: string;
|
|
8495
8530
|
}> = (payload: T) => void;
|
|
8496
8531
|
|
|
8497
|
-
declare type LogInfo = OpenFin_2.LogInfo;
|
|
8498
|
-
|
|
8499
8532
|
/**
|
|
8500
8533
|
* @interface
|
|
8501
8534
|
*/
|
|
8502
|
-
declare type
|
|
8535
|
+
declare type LogInfo = {
|
|
8503
8536
|
/**
|
|
8504
8537
|
* The filename of the log
|
|
8505
8538
|
*/
|
|
@@ -8514,8 +8547,6 @@ declare type LogInfo_2 = {
|
|
|
8514
8547
|
date: string;
|
|
8515
8548
|
};
|
|
8516
8549
|
|
|
8517
|
-
declare type LogLevel = OpenFin_2.LogLevel;
|
|
8518
|
-
|
|
8519
8550
|
/**
|
|
8520
8551
|
* Describes the minimum level (inclusive) above which logs will be written.
|
|
8521
8552
|
*
|
|
@@ -8525,7 +8556,7 @@ declare type LogLevel = OpenFin_2.LogLevel;
|
|
|
8525
8556
|
* `error` and above<br>
|
|
8526
8557
|
* `fatal`: fatal only, indicates a crash is imminent
|
|
8527
8558
|
*/
|
|
8528
|
-
declare type
|
|
8559
|
+
declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
8529
8560
|
|
|
8530
8561
|
declare type LogUploaderUIOptions = {
|
|
8531
8562
|
title?: string;
|
|
@@ -9178,6 +9209,12 @@ declare type MutableWindowOptions = {
|
|
|
9178
9209
|
* Shows the window's icon in the taskbar.
|
|
9179
9210
|
*/
|
|
9180
9211
|
showTaskbarIcon: boolean;
|
|
9212
|
+
/**
|
|
9213
|
+
* Specify a taskbar group for the window.
|
|
9214
|
+
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
9215
|
+
* @remarks It's only updatable when `enableJumpList` is set to false.
|
|
9216
|
+
*/
|
|
9217
|
+
taskbarIconGroup: string;
|
|
9181
9218
|
interop: InteropConfig;
|
|
9182
9219
|
/**
|
|
9183
9220
|
* @internal
|
|
@@ -9375,13 +9412,13 @@ declare namespace OpenFin_2 {
|
|
|
9375
9412
|
LayoutPosition,
|
|
9376
9413
|
WebContent,
|
|
9377
9414
|
PlatformProvider,
|
|
9378
|
-
|
|
9379
|
-
|
|
9415
|
+
ApplicationIdentity,
|
|
9416
|
+
Identity_4 as Identity,
|
|
9380
9417
|
ClientIdentity,
|
|
9381
9418
|
ClientInfo,
|
|
9382
9419
|
ClientIdentityMultiRuntime,
|
|
9383
9420
|
ClientConnectionPayload,
|
|
9384
|
-
|
|
9421
|
+
EntityInfo,
|
|
9385
9422
|
EntityType_4 as EntityType,
|
|
9386
9423
|
Bounds,
|
|
9387
9424
|
WindowBounds,
|
|
@@ -9452,6 +9489,9 @@ declare namespace OpenFin_2 {
|
|
|
9452
9489
|
ViewOptions,
|
|
9453
9490
|
ConstViewOptions,
|
|
9454
9491
|
ViewState,
|
|
9492
|
+
ViewCreationSuccess,
|
|
9493
|
+
ViewCreationFailure,
|
|
9494
|
+
ViewCreationResult,
|
|
9455
9495
|
Certificate,
|
|
9456
9496
|
HostContextChangedPayload,
|
|
9457
9497
|
ApplySnapshotOptions,
|
|
@@ -9517,7 +9557,7 @@ declare namespace OpenFin_2 {
|
|
|
9517
9557
|
GpuInfo,
|
|
9518
9558
|
OSInfo,
|
|
9519
9559
|
HostSpecs,
|
|
9520
|
-
|
|
9560
|
+
PrinterInfo,
|
|
9521
9561
|
Dpi,
|
|
9522
9562
|
Margins,
|
|
9523
9563
|
PrintOptions,
|
|
@@ -9625,24 +9665,24 @@ declare namespace OpenFin_2 {
|
|
|
9625
9665
|
BeforeUnloadUserDecision,
|
|
9626
9666
|
ViewStatuses,
|
|
9627
9667
|
CloseWindowPayload,
|
|
9628
|
-
|
|
9629
|
-
|
|
9668
|
+
ProxyInfo,
|
|
9669
|
+
ProxyConfig,
|
|
9630
9670
|
ProxySystemInfo,
|
|
9631
9671
|
ChannelAction_2 as ChannelAction,
|
|
9632
9672
|
ChannelMiddleware_2 as ChannelMiddleware,
|
|
9633
9673
|
ErrorMiddleware_2 as ErrorMiddleware,
|
|
9634
|
-
|
|
9635
|
-
|
|
9674
|
+
ApplicationState,
|
|
9675
|
+
InstalledApps,
|
|
9636
9676
|
InstallationInfo,
|
|
9637
|
-
|
|
9638
|
-
|
|
9677
|
+
GetLogRequestType,
|
|
9678
|
+
LogInfo,
|
|
9639
9679
|
SendApplicationLogResponse,
|
|
9640
|
-
|
|
9680
|
+
LogLevel,
|
|
9641
9681
|
PermissionState_2 as PermissionState,
|
|
9642
|
-
|
|
9682
|
+
RegistryInfo,
|
|
9643
9683
|
ApplicationType,
|
|
9644
9684
|
WindowInfo,
|
|
9645
|
-
|
|
9685
|
+
ApplicationWindowInfo,
|
|
9646
9686
|
WindowDetail,
|
|
9647
9687
|
LayoutPresetType,
|
|
9648
9688
|
LayoutIdentity,
|
|
@@ -11332,6 +11372,45 @@ declare interface PlatformProvider {
|
|
|
11332
11372
|
* @returns {Promise<void>}
|
|
11333
11373
|
*/
|
|
11334
11374
|
handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
|
|
11375
|
+
/**
|
|
11376
|
+
* @experimental
|
|
11377
|
+
*
|
|
11378
|
+
* This method is called to handle errors with view creation and initial navigation during layout creation.
|
|
11379
|
+
* Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
|
|
11380
|
+
* * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
|
|
11381
|
+
* * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
|
|
11382
|
+
* * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
|
|
11383
|
+
*
|
|
11384
|
+
* @param viewIdentity Identity of the view
|
|
11385
|
+
* @param error error thrown during a view creation
|
|
11386
|
+
* @returns {Promise<OpenFin.ViewCreationSuccess | void>}
|
|
11387
|
+
*
|
|
11388
|
+
* @example
|
|
11389
|
+
*
|
|
11390
|
+
* ```js
|
|
11391
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
11392
|
+
* class Override extends PlatformProvider {
|
|
11393
|
+
* async handleFailedViewCreation(viewIdentity, error) {
|
|
11394
|
+
* const view = fin.View.wrapSync(viewId);
|
|
11395
|
+
* try {
|
|
11396
|
+
* // navigate to an error page
|
|
11397
|
+
* await view.navigate('http://localhost:3000/errorPage.html');
|
|
11398
|
+
* // resolve a success result after redirecting to a error page
|
|
11399
|
+
* return {identity: viewIdentity, success: true};
|
|
11400
|
+
* } catch(e) {
|
|
11401
|
+
* // layout-initialized event will include this view with the error
|
|
11402
|
+
* throw error;
|
|
11403
|
+
* }
|
|
11404
|
+
* }
|
|
11405
|
+
* }
|
|
11406
|
+
* return new Override();
|
|
11407
|
+
* }
|
|
11408
|
+
*
|
|
11409
|
+
* fin.Platform.init({ overrideCallback });
|
|
11410
|
+
*
|
|
11411
|
+
* ```
|
|
11412
|
+
*/
|
|
11413
|
+
handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
|
|
11335
11414
|
}
|
|
11336
11415
|
|
|
11337
11416
|
/**
|
|
@@ -11631,12 +11710,10 @@ declare type PresetLayoutOptions_2 = {
|
|
|
11631
11710
|
presetType: LayoutPresetType;
|
|
11632
11711
|
};
|
|
11633
11712
|
|
|
11634
|
-
declare type PrinterInfo = OpenFin_2.PrinterInfo;
|
|
11635
|
-
|
|
11636
11713
|
/**
|
|
11637
11714
|
* @interface
|
|
11638
11715
|
*/
|
|
11639
|
-
declare type
|
|
11716
|
+
declare type PrinterInfo = {
|
|
11640
11717
|
/**
|
|
11641
11718
|
* Printer Name
|
|
11642
11719
|
*/
|
|
@@ -11898,20 +11975,100 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
11898
11975
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
11899
11976
|
|
|
11900
11977
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
11978
|
+
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
11979
|
+
'destroy-application': ApplicationIdentityCall<{
|
|
11980
|
+
force: boolean;
|
|
11981
|
+
}, void>;
|
|
11982
|
+
'close-application': ApplicationIdentityCall<{
|
|
11983
|
+
force: boolean;
|
|
11984
|
+
}, void>;
|
|
11985
|
+
'application-close': ApplicationIdentityCall<{}, void>;
|
|
11986
|
+
'get-child-windows': ApplicationIdentityCall<{}, Array<unknown>>;
|
|
11987
|
+
'get-application-manifest': {
|
|
11988
|
+
request: {
|
|
11989
|
+
manifestUrl?: string;
|
|
11990
|
+
uuid?: string;
|
|
11991
|
+
};
|
|
11992
|
+
response: OpenFin_2.Manifest;
|
|
11993
|
+
};
|
|
11994
|
+
'get-parent-application': ApplicationIdentityCall<{}, string>;
|
|
11995
|
+
'get-shortcuts': ApplicationIdentityCall<{}, OpenFin_2.ShortCutConfig>;
|
|
11996
|
+
'application-get-views': ApplicationIdentityCall<{}, OpenFin_2.Identity[]>;
|
|
11997
|
+
'get-application-zoom-level': ApplicationIdentityCall<{}, number>;
|
|
11998
|
+
'application-get-window': ApplicationIdentityCall<{}, void>;
|
|
11999
|
+
'register-user': ApplicationIdentityCall<{
|
|
12000
|
+
userName: string;
|
|
12001
|
+
appName: string;
|
|
12002
|
+
}, void>;
|
|
12003
|
+
'remove-tray-icon': ApplicationIdentityCall<{}, void>;
|
|
12004
|
+
'restart-application': ApplicationIdentityCall<{}, void>;
|
|
12005
|
+
'application-run': ApplicationIdentityCall<{}, void>;
|
|
12006
|
+
'run-application': ApplicationIdentityCall<{
|
|
12007
|
+
manifestUrl?: string | undefined;
|
|
12008
|
+
opts?: OpenFin_2.RvmLaunchOptions;
|
|
12009
|
+
}, void>;
|
|
12010
|
+
'relaunch-on-close': ApplicationIdentityCall<{}, void>;
|
|
12011
|
+
'send-application-log': ApplicationIdentityCall<{}, OpenFin_2.SendApplicationLogResponse>;
|
|
12012
|
+
'set-jump-list': ApplicationIdentityCall<{
|
|
12013
|
+
config: OpenFin_2.JumpListCategory[] | null;
|
|
12014
|
+
}, void>;
|
|
12015
|
+
'set-tray-icon': ApplicationIdentityCall<{
|
|
12016
|
+
enabledIcon: string;
|
|
12017
|
+
}, void>;
|
|
12018
|
+
'set-shortcuts': ApplicationIdentityCall<{
|
|
12019
|
+
data: OpenFin_2.ShortCutConfig;
|
|
12020
|
+
}, void>;
|
|
12021
|
+
'set-shortcut-query-args': ApplicationIdentityCall<{
|
|
12022
|
+
data: string;
|
|
12023
|
+
}, void>;
|
|
12024
|
+
'set-application-zoom-level': ApplicationIdentityCall<{
|
|
12025
|
+
level: number;
|
|
12026
|
+
}, void>;
|
|
12027
|
+
'set-app-log-username': ApplicationIdentityCall<{
|
|
12028
|
+
data: string;
|
|
12029
|
+
}, void>;
|
|
12030
|
+
'get-tray-icon-info': ApplicationIdentityCall<{}, OpenFin_2.TrayInfo>;
|
|
12031
|
+
'has-tray-icon': ApplicationIdentityCall<{}, boolean>;
|
|
12032
|
+
'terminate-application': ApplicationIdentityCall<{}, void>;
|
|
12033
|
+
'wait-for-hung-application': ApplicationIdentityCall<{}, void>;
|
|
12034
|
+
'get-info': ApplicationIdentityCall<{}, OpenFin_2.ApplicationInfo>;
|
|
12035
|
+
'application-get-process-info': ApplicationIdentityCall<{}, OpenFin_2.AppProcessInfo>;
|
|
12036
|
+
'set-file-download-location': {
|
|
12037
|
+
request: OpenFin_2.Identity & {
|
|
12038
|
+
downloadLocation: string;
|
|
12039
|
+
};
|
|
12040
|
+
response: void;
|
|
12041
|
+
};
|
|
12042
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12043
|
+
'show-tray-icon-popup-menu': {
|
|
12044
|
+
request: OpenFin_2.Identity & {
|
|
12045
|
+
options: OpenFin_2.ShowTrayIconPopupMenuOptions;
|
|
12046
|
+
};
|
|
12047
|
+
response: OpenFin_2.MenuResult;
|
|
12048
|
+
};
|
|
12049
|
+
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12050
|
+
'wrap-application': VoidCall;
|
|
12051
|
+
'wrap-application-sync': VoidCall;
|
|
12052
|
+
'create-application': ApiCall<OpenFin_2.ApplicationCreationOptions, void>;
|
|
12053
|
+
'application-create': VoidCall;
|
|
12054
|
+
'start-application': VoidCall;
|
|
12055
|
+
'run-applications': ApiCall<{
|
|
12056
|
+
applications: Array<OpenFin_2.ManifestInfo>;
|
|
12057
|
+
opts?: OpenFin_2.RvmLaunchOptions;
|
|
12058
|
+
}, void>;
|
|
12059
|
+
'get-current-application': VoidCall;
|
|
12060
|
+
'get-current-application-sync': VoidCall;
|
|
12061
|
+
'application-start-from-manifest': VoidCall;
|
|
12062
|
+
'application-create-from-manifest': VoidCall;
|
|
11901
12063
|
'request-external-authorization': {
|
|
11902
12064
|
request: any;
|
|
11903
12065
|
response: void;
|
|
11904
12066
|
specialResponse: AuthorizationPayload;
|
|
11905
12067
|
};
|
|
11906
|
-
'
|
|
11907
|
-
request:
|
|
11908
|
-
response: OpenFin_2.Identity[];
|
|
11909
|
-
};
|
|
11910
|
-
'set-jump-list': {
|
|
11911
|
-
request: {
|
|
11912
|
-
config: OpenFin_2.JumpListCategory[] | null;
|
|
11913
|
-
} & OpenFin_2.ApplicationIdentity;
|
|
12068
|
+
'request-authorization': {
|
|
12069
|
+
request: ExistingConnectConfig | RemoteConfig | ReceiverConfig;
|
|
11914
12070
|
response: void;
|
|
12071
|
+
specialResponse: Payload;
|
|
11915
12072
|
};
|
|
11916
12073
|
'clipboard-read-formats': {
|
|
11917
12074
|
request: {
|
|
@@ -11923,6 +12080,24 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11923
12080
|
request: OpenFin_2.ReadImageClipboardRequest;
|
|
11924
12081
|
response: string;
|
|
11925
12082
|
};
|
|
12083
|
+
'clipboard-read-text': {
|
|
12084
|
+
request: {
|
|
12085
|
+
type?: OpenFin_2.ClipboardSelectionType;
|
|
12086
|
+
};
|
|
12087
|
+
response: string;
|
|
12088
|
+
};
|
|
12089
|
+
'clipboard-read-html': {
|
|
12090
|
+
request: {
|
|
12091
|
+
type?: OpenFin_2.ClipboardSelectionType;
|
|
12092
|
+
};
|
|
12093
|
+
response: string;
|
|
12094
|
+
};
|
|
12095
|
+
'clipboard-read-rtf': {
|
|
12096
|
+
request: {
|
|
12097
|
+
type?: OpenFin_2.ClipboardSelectionType;
|
|
12098
|
+
};
|
|
12099
|
+
response: string;
|
|
12100
|
+
};
|
|
11926
12101
|
'clipboard-write-image': {
|
|
11927
12102
|
request: OpenFin_2.WriteImageClipboardRequest;
|
|
11928
12103
|
response: void;
|
|
@@ -11931,6 +12106,18 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11931
12106
|
request: OpenFin_2.WriteAnyRequestType;
|
|
11932
12107
|
response: void;
|
|
11933
12108
|
};
|
|
12109
|
+
'clipboard-write-text': {
|
|
12110
|
+
request: OpenFin_2.WriteClipboardRequest;
|
|
12111
|
+
response: void;
|
|
12112
|
+
};
|
|
12113
|
+
'clipboard-write-html': {
|
|
12114
|
+
request: OpenFin_2.WriteClipboardRequest;
|
|
12115
|
+
response: void;
|
|
12116
|
+
};
|
|
12117
|
+
'clipboard-write-rtf': {
|
|
12118
|
+
request: OpenFin_2.WriteClipboardRequest;
|
|
12119
|
+
response: void;
|
|
12120
|
+
};
|
|
11934
12121
|
'get-view-window': IdentityCall<{}, OpenFin_2.Identity>;
|
|
11935
12122
|
'create-view': IdentityCall<OpenFin_2.ViewCreationOptions & {
|
|
11936
12123
|
uuid: string;
|
|
@@ -11956,13 +12143,85 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11956
12143
|
options: OpenFin_2.UpdatableViewOptions;
|
|
11957
12144
|
}>;
|
|
11958
12145
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12146
|
+
'view-wrap-sync': VoidCall;
|
|
12147
|
+
'view-wrap': VoidCall;
|
|
12148
|
+
'view-get-current': VoidCall;
|
|
12149
|
+
'view-get-current-sync': VoidCall;
|
|
12150
|
+
'animate-window': IdentityCall<{
|
|
12151
|
+
transitions: OpenFin_2.Transition;
|
|
12152
|
+
options: OpenFin_2.TransitionOptions;
|
|
12153
|
+
}>;
|
|
12154
|
+
'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
|
|
12155
|
+
'get-window-bounds': IdentityCall<{}, OpenFin_2.WindowBounds>;
|
|
12156
|
+
'center-window': IdentityCall;
|
|
12157
|
+
'blur-window': IdentityCall;
|
|
12158
|
+
'bring-window-to-front': IdentityCall;
|
|
12159
|
+
'hide-window': IdentityCall;
|
|
12160
|
+
'close-window': IdentityCall<{
|
|
12161
|
+
force: boolean;
|
|
12162
|
+
}>;
|
|
12163
|
+
'focused-webview-changed': IdentityCall;
|
|
12164
|
+
'get-window-native-id': IdentityCall<{}, string>;
|
|
11959
12165
|
'window-get-views': IdentityCall<{}, OpenFin_2.Identity[]>;
|
|
11960
|
-
'
|
|
12166
|
+
'disable-window-frame': IdentityCall;
|
|
12167
|
+
'enable-window-frame': IdentityCall;
|
|
12168
|
+
'flash-window': IdentityCall;
|
|
12169
|
+
'stop-flash-window': IdentityCall;
|
|
12170
|
+
'get-window-info': IdentityCall<{}, OpenFin_2.WindowInfo>;
|
|
12171
|
+
'get-window-options': IdentityCall<{}, OpenFin_2.WindowOptions>;
|
|
12172
|
+
'get-window-snapshot': IdentityCall<{
|
|
12173
|
+
area?: OpenFin_2.Rectangle;
|
|
12174
|
+
}, string>;
|
|
12175
|
+
'get-window-state': IdentityCall<{}, 'minimized' | 'maximized' | 'normal'>;
|
|
12176
|
+
'is-window-showing': IdentityCall<{}, boolean>;
|
|
12177
|
+
'maximize-window': IdentityCall;
|
|
12178
|
+
'minimize-window': IdentityCall;
|
|
12179
|
+
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12180
|
+
deltaLeft: number;
|
|
12181
|
+
deltaTop: number;
|
|
12182
|
+
}>>;
|
|
12183
|
+
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12184
|
+
left: number;
|
|
12185
|
+
top: number;
|
|
12186
|
+
}>>;
|
|
12187
|
+
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12188
|
+
deltaWidth: number;
|
|
12189
|
+
deltaHeight: number;
|
|
12190
|
+
anchor: OpenFin_2.AnchorType;
|
|
12191
|
+
}>>;
|
|
12192
|
+
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12193
|
+
width: number;
|
|
12194
|
+
height: number;
|
|
12195
|
+
anchor: OpenFin_2.AnchorType;
|
|
12196
|
+
}>>;
|
|
12197
|
+
'restore-window': IdentityCall;
|
|
12198
|
+
'set-foreground-window': IdentityCall;
|
|
12199
|
+
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
|
|
12200
|
+
'show-window': IdentityCall<{
|
|
12201
|
+
force: boolean;
|
|
12202
|
+
}>;
|
|
12203
|
+
'show-at-window': IdentityCall<{
|
|
12204
|
+
left: number;
|
|
12205
|
+
top: number;
|
|
12206
|
+
force: boolean;
|
|
12207
|
+
}>;
|
|
12208
|
+
'update-window-options': IdentityCall<{
|
|
12209
|
+
options: OpenFin_2.UpdatableWindowOptions;
|
|
12210
|
+
}>;
|
|
12211
|
+
'window-authenticate': IdentityCall<{
|
|
12212
|
+
userName: string;
|
|
12213
|
+
password: string;
|
|
12214
|
+
}>;
|
|
12215
|
+
'show-popup-menu': {
|
|
11961
12216
|
request: OpenFin_2.Identity & {
|
|
11962
|
-
options: OpenFin_2.
|
|
12217
|
+
options: OpenFin_2.ShowPopupMenuOptions;
|
|
11963
12218
|
};
|
|
11964
|
-
response:
|
|
12219
|
+
response: OpenFin_2.MenuResult;
|
|
11965
12220
|
};
|
|
12221
|
+
'close-popup-menu': IdentityCall;
|
|
12222
|
+
'dispatch-popup-result': IdentityCall<{
|
|
12223
|
+
data: any;
|
|
12224
|
+
}>;
|
|
11966
12225
|
'print-screenshot': {
|
|
11967
12226
|
request: OpenFin_2.Identity;
|
|
11968
12227
|
response: void;
|
|
@@ -11973,6 +12232,229 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11973
12232
|
};
|
|
11974
12233
|
response: void;
|
|
11975
12234
|
};
|
|
12235
|
+
'window-wrap': VoidCall;
|
|
12236
|
+
'window-wrap-sync': VoidCall;
|
|
12237
|
+
'create-window': VoidCall;
|
|
12238
|
+
'get-current-window': VoidCall;
|
|
12239
|
+
'get-current-window-sync': VoidCall;
|
|
12240
|
+
'get-external-application-info': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.ExternalApplicationInfo>;
|
|
12241
|
+
'external-application-wrap': VoidCall;
|
|
12242
|
+
'external-application-wrap-sync': VoidCall;
|
|
12243
|
+
'get-frame-info': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
|
|
12244
|
+
'get-parent-window': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
|
|
12245
|
+
'frame-wrap': VoidCall;
|
|
12246
|
+
'frame-wrap-sync': VoidCall;
|
|
12247
|
+
'frame-get-current': VoidCall;
|
|
12248
|
+
'frame-get-current-sync': VoidCall;
|
|
12249
|
+
'global-hotkey-register': {
|
|
12250
|
+
request: {
|
|
12251
|
+
hotkey: string;
|
|
12252
|
+
};
|
|
12253
|
+
response: void;
|
|
12254
|
+
};
|
|
12255
|
+
'global-hotkey-unregister': {
|
|
12256
|
+
request: {
|
|
12257
|
+
hotkey: string;
|
|
12258
|
+
};
|
|
12259
|
+
response: void;
|
|
12260
|
+
};
|
|
12261
|
+
'global-hotkey-unregister-all': {
|
|
12262
|
+
request: {};
|
|
12263
|
+
response: void;
|
|
12264
|
+
};
|
|
12265
|
+
'global-hotkey-is-registered': {
|
|
12266
|
+
request: {
|
|
12267
|
+
hotkey: string;
|
|
12268
|
+
};
|
|
12269
|
+
response: boolean;
|
|
12270
|
+
};
|
|
12271
|
+
'publish-message': {
|
|
12272
|
+
request: {
|
|
12273
|
+
topic: string;
|
|
12274
|
+
message: any;
|
|
12275
|
+
sourceWindowName: string;
|
|
12276
|
+
};
|
|
12277
|
+
response: void;
|
|
12278
|
+
};
|
|
12279
|
+
'send-message': {
|
|
12280
|
+
request: {
|
|
12281
|
+
destinationUuid: string;
|
|
12282
|
+
destinationWindowName: string | undefined;
|
|
12283
|
+
topic: string;
|
|
12284
|
+
message: any;
|
|
12285
|
+
sourceWindowName: string;
|
|
12286
|
+
};
|
|
12287
|
+
response: void;
|
|
12288
|
+
};
|
|
12289
|
+
'subscribe': {
|
|
12290
|
+
request: {
|
|
12291
|
+
sourceUuid: string;
|
|
12292
|
+
sourceWindowName: string;
|
|
12293
|
+
topic: string;
|
|
12294
|
+
destinationWindowName: string;
|
|
12295
|
+
messageKey?: any;
|
|
12296
|
+
};
|
|
12297
|
+
response: void;
|
|
12298
|
+
};
|
|
12299
|
+
'unsubscribe': {
|
|
12300
|
+
request: {
|
|
12301
|
+
sourceUuid: string;
|
|
12302
|
+
sourceWindowName: string;
|
|
12303
|
+
topic: string;
|
|
12304
|
+
destinationWindowName: string;
|
|
12305
|
+
};
|
|
12306
|
+
response: void;
|
|
12307
|
+
};
|
|
12308
|
+
'get-all-channels': GetterCall<OpenFin_2.ProviderIdentity[]>;
|
|
12309
|
+
'connect-to-channel': {
|
|
12310
|
+
request: any;
|
|
12311
|
+
response: OpenFin_2.RoutingInfo;
|
|
12312
|
+
};
|
|
12313
|
+
'create-channel': ApiCall<{
|
|
12314
|
+
channelName: string;
|
|
12315
|
+
}, OpenFin_2.ProviderIdentity>;
|
|
12316
|
+
'destroy-channel': ApiCall<{
|
|
12317
|
+
channelName: string;
|
|
12318
|
+
}, void>;
|
|
12319
|
+
'disconnect-from-channel': {
|
|
12320
|
+
request: {
|
|
12321
|
+
channelName: string;
|
|
12322
|
+
uuid: string;
|
|
12323
|
+
name: string;
|
|
12324
|
+
endpointId: string;
|
|
12325
|
+
};
|
|
12326
|
+
response: void;
|
|
12327
|
+
};
|
|
12328
|
+
'send-channel-message': {
|
|
12329
|
+
request: any;
|
|
12330
|
+
response: any;
|
|
12331
|
+
};
|
|
12332
|
+
'get-version': GetterCall<string>;
|
|
12333
|
+
'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
|
|
12334
|
+
'delete-cache-request': VoidCall;
|
|
12335
|
+
'exit-desktop': VoidCall;
|
|
12336
|
+
'fetch-manifest': ApiCall<{
|
|
12337
|
+
manifestUrl: string;
|
|
12338
|
+
}, any>;
|
|
12339
|
+
'flush-cookie-store': VoidCall;
|
|
12340
|
+
'get-all-windows': GetterCall<OpenFin_2.ApplicationWindowInfo[]>;
|
|
12341
|
+
'get-all-applications': GetterCall<OpenFin_2.ApplicationState[]>;
|
|
12342
|
+
'get-command-line-arguments': GetterCall<string>;
|
|
12343
|
+
'get-crash-reporter-state': GetterCall<OpenFin_2.CrashReporterState>;
|
|
12344
|
+
'start-crash-reporter': {
|
|
12345
|
+
request: OpenFin_2.CrashReporterOptions | {
|
|
12346
|
+
diagnosticMode: boolean;
|
|
12347
|
+
};
|
|
12348
|
+
response: OpenFin_2.CrashReporterState;
|
|
12349
|
+
};
|
|
12350
|
+
'get-unique-user-id': GetterCall<string>;
|
|
12351
|
+
'get-entity-info': {
|
|
12352
|
+
request: {
|
|
12353
|
+
uuid: string;
|
|
12354
|
+
name: string;
|
|
12355
|
+
};
|
|
12356
|
+
response: OpenFin_2.EntityInfo;
|
|
12357
|
+
};
|
|
12358
|
+
'get-environment-variable': {
|
|
12359
|
+
request: {
|
|
12360
|
+
environmentVariables: string;
|
|
12361
|
+
};
|
|
12362
|
+
response: string;
|
|
12363
|
+
};
|
|
12364
|
+
'get-focused-window': GetterCall<OpenFin_2.Identity | null>;
|
|
12365
|
+
'is-app-certified': {
|
|
12366
|
+
request: {
|
|
12367
|
+
manifestUrl: string;
|
|
12368
|
+
};
|
|
12369
|
+
response: {
|
|
12370
|
+
action: string;
|
|
12371
|
+
certifiedInfo: OpenFin_2.CertifiedAppInfo;
|
|
12372
|
+
};
|
|
12373
|
+
};
|
|
12374
|
+
'get-installed-runtimes': GetterCall<{
|
|
12375
|
+
action: string;
|
|
12376
|
+
runtimes: string[];
|
|
12377
|
+
}>;
|
|
12378
|
+
'get-installed-apps': GetterCall<OpenFin_2.InstalledApps>;
|
|
12379
|
+
'view-log': ApiCall<OpenFin_2.GetLogRequestType, string>;
|
|
12380
|
+
'get-machine-id': GetterCall<string>;
|
|
12381
|
+
'get-min-log-level': GetterCall<OpenFin_2.LogLevel>;
|
|
12382
|
+
'list-logs': GetterCall<OpenFin_2.LogInfo[]>;
|
|
12383
|
+
'get-monitor-info': GetterCall<OpenFin_2.MonitorInfo>;
|
|
12384
|
+
'get-mouse-position': GetterCall<OpenFin_2.PointTopLeft>;
|
|
12385
|
+
'process-snapshot': GetterCall<Array<any>>;
|
|
12386
|
+
'get-all-process-info': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.SystemProcessInfo>;
|
|
12387
|
+
'get-proxy-settings': GetterCall<OpenFin_2.ProxyInfo>;
|
|
12388
|
+
'get-runtime-info': GetterCall<OpenFin_2.RuntimeInfo>;
|
|
12389
|
+
'get-rvm-info': GetterCall<OpenFin_2.RVMInfo>;
|
|
12390
|
+
'get-host-specs': GetterCall<OpenFin_2.HostSpecs>;
|
|
12391
|
+
'get-os-info': GetterCall<OpenFin_2.OSInfo>;
|
|
12392
|
+
'launch-external-process': ApiCall<OpenFin_2.ExternalProcessRequestType, OpenFin_2.Identity>;
|
|
12393
|
+
'monitor-external-process': ApiCall<OpenFin_2.ExternalProcessInfo, OpenFin_2.Identity>;
|
|
12394
|
+
'write-to-log': ApiCall<{
|
|
12395
|
+
level: string;
|
|
12396
|
+
message: string;
|
|
12397
|
+
}, void>;
|
|
12398
|
+
'open-url-with-browser': ApiCall<{
|
|
12399
|
+
url: string;
|
|
12400
|
+
}, void>;
|
|
12401
|
+
'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void>;
|
|
12402
|
+
'unregister-custom-protocol': ApiCall<{
|
|
12403
|
+
protocolName: string;
|
|
12404
|
+
}, void>;
|
|
12405
|
+
'get-custom-protocol-state': ApiCall<{
|
|
12406
|
+
protocolName: string;
|
|
12407
|
+
}, OpenFin_2.CustomProtocolState>;
|
|
12408
|
+
'release-external-process': ApiCall<{
|
|
12409
|
+
uuid: string;
|
|
12410
|
+
}, void>;
|
|
12411
|
+
'show-developer-tools': ApiCall<OpenFin_2.Identity, void>;
|
|
12412
|
+
'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void>;
|
|
12413
|
+
'update-proxy': ApiCall<OpenFin_2.ProxyConfig, void>;
|
|
12414
|
+
'download-asset': {
|
|
12415
|
+
request: OpenFin_2.AppAssetInfo & {
|
|
12416
|
+
downloadId: string;
|
|
12417
|
+
};
|
|
12418
|
+
response: void;
|
|
12419
|
+
};
|
|
12420
|
+
'download-runtime': {
|
|
12421
|
+
request: OpenFin_2.RuntimeDownloadOptions & {
|
|
12422
|
+
downloadId: string;
|
|
12423
|
+
};
|
|
12424
|
+
response: void;
|
|
12425
|
+
};
|
|
12426
|
+
'download-preload-scripts': ApiCall<{
|
|
12427
|
+
scripts: Array<OpenFin_2.DownloadPreloadOption>;
|
|
12428
|
+
}, Array<OpenFin_2.DownloadPreloadInfo>>;
|
|
12429
|
+
'get-all-external-applications': ApiCall<void, Array<OpenFin_2.Identity>>;
|
|
12430
|
+
'get-app-asset-info': ApiCall<OpenFin_2.AppAssetRequest, OpenFin_2.AppAssetInfo>;
|
|
12431
|
+
'get-cookies': {
|
|
12432
|
+
request: OpenFin_2.CookieOption & {
|
|
12433
|
+
url: string;
|
|
12434
|
+
};
|
|
12435
|
+
response: Array<OpenFin_2.CookieInfo>;
|
|
12436
|
+
};
|
|
12437
|
+
'set-min-log-level': ApiCall<{
|
|
12438
|
+
level: OpenFin_2.LogLevel;
|
|
12439
|
+
}, void>;
|
|
12440
|
+
'resolve-uuid': ApiCall<{
|
|
12441
|
+
entityKey: string;
|
|
12442
|
+
}, OpenFin_2.ApplicationType>;
|
|
12443
|
+
'read-registry-value': ApiCall<{
|
|
12444
|
+
rootKey: string;
|
|
12445
|
+
subkey: string;
|
|
12446
|
+
value: string;
|
|
12447
|
+
}, OpenFin_2.RegistryInfo>;
|
|
12448
|
+
'register-external-connection': ApiCall<{
|
|
12449
|
+
uuid: string;
|
|
12450
|
+
}, OpenFin_2.ExternalConnection>;
|
|
12451
|
+
'get-service-configuration': ApiCall<{
|
|
12452
|
+
name: string;
|
|
12453
|
+
}, OpenFin_2.ServiceConfiguration>;
|
|
12454
|
+
'get-system-app-configuration': ApiCall<{
|
|
12455
|
+
name: string;
|
|
12456
|
+
}, any>;
|
|
12457
|
+
'run-rvm-health-check': ApiCall<void, string[]>;
|
|
11976
12458
|
'launch-manifest': {
|
|
11977
12459
|
request: {
|
|
11978
12460
|
manifestUrl: string;
|
|
@@ -11984,17 +12466,12 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11984
12466
|
manifest: OpenFin_2.Manifest;
|
|
11985
12467
|
};
|
|
11986
12468
|
};
|
|
11987
|
-
'
|
|
12469
|
+
'query-permission-for-current-context': {
|
|
11988
12470
|
request: {
|
|
11989
|
-
|
|
11990
|
-
|
|
11991
|
-
response: any;
|
|
11992
|
-
};
|
|
11993
|
-
'show-popup-menu': {
|
|
11994
|
-
request: OpenFin_2.Identity & {
|
|
11995
|
-
options: OpenFin_2.ShowPopupMenuOptions;
|
|
12471
|
+
apiName: string;
|
|
12472
|
+
identity: OpenFin_2.Identity;
|
|
11996
12473
|
};
|
|
11997
|
-
response: OpenFin_2.
|
|
12474
|
+
response: OpenFin_2.QueryPermissionResult;
|
|
11998
12475
|
};
|
|
11999
12476
|
'enable-native-window-integration-provider': {
|
|
12000
12477
|
request: {
|
|
@@ -12002,24 +12479,34 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12002
12479
|
};
|
|
12003
12480
|
response: OpenFin_2.NativeWindowIntegrationProviderAuthorization;
|
|
12004
12481
|
};
|
|
12482
|
+
'register-usage': ApiCall<OpenFin_2.RegisterUsageData, void>;
|
|
12483
|
+
'system-get-printers': GetterCall<OpenFin_2.PrinterInfo[]>;
|
|
12484
|
+
'system-update-process-logging-options': ApiCall<{
|
|
12485
|
+
options: OpenFin_2.ProcessLoggingOptions;
|
|
12486
|
+
}, void>;
|
|
12487
|
+
'get-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.DefaultDomainSettings>;
|
|
12488
|
+
'set-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity & {
|
|
12489
|
+
domainSettings: OpenFin_2.DefaultDomainSettings;
|
|
12490
|
+
}, void>;
|
|
12491
|
+
'system-register-shutdown-handler': VoidCall;
|
|
12005
12492
|
'get-permissions': GetterCall<any>;
|
|
12006
|
-
'get-all-channels': GetterCall<OpenFin_2.ProviderIdentity[]>;
|
|
12007
|
-
'set-file-download-location': {
|
|
12008
|
-
request: OpenFin_2.Identity & {
|
|
12009
|
-
downloadLocation: string;
|
|
12010
|
-
};
|
|
12011
|
-
response: void;
|
|
12012
|
-
};
|
|
12013
|
-
'get-file-download-location': {
|
|
12014
|
-
request: OpenFin_2.ApplicationIdentity;
|
|
12015
|
-
response: string;
|
|
12016
|
-
};
|
|
12017
|
-
'close-popup-menu': IdentityCall;
|
|
12018
12493
|
'fdc3-add-context-listener': VoidCall;
|
|
12494
|
+
'fdc3-add-intent-listener': VoidCall;
|
|
12495
|
+
'fdc3-raise-intent': VoidCall;
|
|
12496
|
+
'fdc3-find-intent': VoidCall;
|
|
12497
|
+
'fdc3-find-intents-by-context': VoidCall;
|
|
12498
|
+
'fdc3-raise-intent-for-context': VoidCall;
|
|
12499
|
+
'fdc3-get-info': VoidCall;
|
|
12500
|
+
'fdc3-find-instances': VoidCall;
|
|
12501
|
+
'fdc3-get-app-metadata': VoidCall;
|
|
12019
12502
|
'fdc3-broadcast': VoidCall;
|
|
12503
|
+
'fdc3-open': VoidCall;
|
|
12504
|
+
'fdc3-get-or-create-channel': VoidCall;
|
|
12020
12505
|
'fdc3-get-system-channels': VoidCall;
|
|
12021
12506
|
'fdc3-join-channel': VoidCall;
|
|
12507
|
+
'fdc3-get-current-channel': VoidCall;
|
|
12022
12508
|
'fdc3-leave-current-channel': VoidCall;
|
|
12509
|
+
'interop-init': VoidCall;
|
|
12023
12510
|
'interop-connect-sync': VoidCall;
|
|
12024
12511
|
'interop-client-set-context': VoidCall;
|
|
12025
12512
|
'interop-client-add-context-handler': VoidCall;
|
|
@@ -12028,6 +12515,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12028
12515
|
'interop-client-remove-from-context-group': VoidCall;
|
|
12029
12516
|
'interop-client-get-all-clients-in-context-group': VoidCall;
|
|
12030
12517
|
'interop-client-get-info-for-context-group': VoidCall;
|
|
12518
|
+
'interop-client-fire-intent': VoidCall;
|
|
12519
|
+
'interop-client-register-intent-handler': VoidCall;
|
|
12520
|
+
'interop-client-get-current-context': VoidCall;
|
|
12521
|
+
'interop-client-get-info-for-intent': VoidCall;
|
|
12522
|
+
'interop-client-get-info-for-intents-by-context': VoidCall;
|
|
12523
|
+
'interop-client-fire-intent-for-context': VoidCall;
|
|
12524
|
+
'interop-client-add-ondisconnection-listener': VoidCall;
|
|
12031
12525
|
'interop-broker-add-client-to-context-group': VoidCall;
|
|
12032
12526
|
'interop-broker-get-all-clients-in-context-group': VoidCall;
|
|
12033
12527
|
'interop-broker-get-context-groups': VoidCall;
|
|
@@ -12039,13 +12533,100 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12039
12533
|
'interop-broker-remove-from-context-group': VoidCall;
|
|
12040
12534
|
'interop-broker-set-context': VoidCall;
|
|
12041
12535
|
'interop-broker-set-context-for-group': VoidCall;
|
|
12042
|
-
'
|
|
12043
|
-
|
|
12044
|
-
|
|
12045
|
-
|
|
12046
|
-
|
|
12047
|
-
|
|
12048
|
-
|
|
12536
|
+
'interop-broker-get-current-context': VoidCall;
|
|
12537
|
+
'interop-broker-set-intent-target': VoidCall;
|
|
12538
|
+
'interop-session-context-group-set-context': VoidCall;
|
|
12539
|
+
'interop-session-context-group-get-context': VoidCall;
|
|
12540
|
+
'interop-session-context-group-add-handler': VoidCall;
|
|
12541
|
+
'platform-wrap': VoidCall;
|
|
12542
|
+
'platform-wrap-sync': VoidCall;
|
|
12543
|
+
'platform-get-current': VoidCall;
|
|
12544
|
+
'platform-get-current-sync': VoidCall;
|
|
12545
|
+
'platform-start': VoidCall;
|
|
12546
|
+
'platform-start-from-manifest': VoidCall;
|
|
12547
|
+
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
12548
|
+
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
12549
|
+
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
12550
|
+
'platform-quit': ApplicationIdentityCall<{}, void>;
|
|
12551
|
+
'platform-close-view': ApplicationIdentityCall<{}, void>;
|
|
12552
|
+
'platform-reparent-view': ApplicationIdentityCall<{}, void>;
|
|
12553
|
+
'platform-get-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12554
|
+
'platform-apply-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12555
|
+
'platform-launch-content-manifest': ApplicationIdentityCall<{}, void>;
|
|
12556
|
+
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
12557
|
+
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
12558
|
+
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
12559
|
+
'layout-wrap': VoidCall;
|
|
12560
|
+
'layout-wrap-sync': VoidCall;
|
|
12561
|
+
'layout-get-current': VoidCall;
|
|
12562
|
+
'layout-get-current-sync': VoidCall;
|
|
12563
|
+
'layout-init': VoidCall;
|
|
12564
|
+
'layout-get-config': VoidCall;
|
|
12565
|
+
'layout-get-views': VoidCall;
|
|
12566
|
+
'layout-replace': VoidCall;
|
|
12567
|
+
'layout-get-root-item': VoidCall;
|
|
12568
|
+
'layout-replace-view': VoidCall;
|
|
12569
|
+
'layout-apply-preset': VoidCall;
|
|
12570
|
+
'layout-controller-get-root': VoidCall;
|
|
12571
|
+
'layout-controller-get-stack-by-view': VoidCall;
|
|
12572
|
+
'layout-controller-get-stack-views': VoidCall;
|
|
12573
|
+
'layout-controller-get-content': VoidCall;
|
|
12574
|
+
'layout-controller-get-parent': VoidCall;
|
|
12575
|
+
'layout-controller-is-root': VoidCall;
|
|
12576
|
+
'layout-controller-exists': VoidCall;
|
|
12577
|
+
'layout-controller-add-view-to-stack': VoidCall;
|
|
12578
|
+
'layout-controller-remove-view-from-stack': VoidCall;
|
|
12579
|
+
'layout-controller-create-adjacent-stack': VoidCall;
|
|
12580
|
+
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
12581
|
+
'layout-controller-set-stack-active-view': VoidCall;
|
|
12582
|
+
'snapshot-source-init': VoidCall;
|
|
12583
|
+
'snapshot-source-wrap-sync': VoidCall;
|
|
12584
|
+
'snapshot-source-wrap': VoidCall;
|
|
12585
|
+
'snapshot-source-ready': VoidCall;
|
|
12586
|
+
'snapshot-source-get-snapshot': VoidCall;
|
|
12587
|
+
'snapshot-source-apply-snapshot': VoidCall;
|
|
12588
|
+
'capture-page': IdentityCall<{
|
|
12589
|
+
options?: OpenFin_2.CapturePageOptions;
|
|
12590
|
+
}, string>;
|
|
12591
|
+
'execute-javascript-in-window': IdentityCall<{
|
|
12592
|
+
code: string;
|
|
12593
|
+
}, unknown>;
|
|
12594
|
+
'get-zoom-level': IdentityCall<{}, number>;
|
|
12595
|
+
'set-zoom-level': IdentityCall<{
|
|
12596
|
+
level: number;
|
|
12597
|
+
}, void>;
|
|
12598
|
+
'navigate-window': IdentityCall<{
|
|
12599
|
+
url: string;
|
|
12600
|
+
}, void>;
|
|
12601
|
+
'navigate-window-back': IdentityCall<{}, void>;
|
|
12602
|
+
'navigate-window-forward': IdentityCall<{}, void>;
|
|
12603
|
+
'stop-window-navigation': IdentityCall<{}, void>;
|
|
12604
|
+
'reload-window': IdentityCall<{
|
|
12605
|
+
ignoreCache: boolean;
|
|
12606
|
+
}, void>;
|
|
12607
|
+
'print': IdentityCall<{
|
|
12608
|
+
options: OpenFin_2.PrintOptions;
|
|
12609
|
+
}, void>;
|
|
12610
|
+
'find-in-page': IdentityCall<{
|
|
12611
|
+
searchTerm: string;
|
|
12612
|
+
options?: OpenFin_2.FindInPageOptions;
|
|
12613
|
+
}, void>;
|
|
12614
|
+
'stop-find-in-page': IdentityCall<{
|
|
12615
|
+
action: 'clearSelection' | 'keepSelection' | 'activateSelection';
|
|
12616
|
+
}, void>;
|
|
12617
|
+
'get-printers': IdentityCall<{}, OpenFin_2.PrinterInfo>;
|
|
12618
|
+
'focus-window': IdentityCall<{
|
|
12619
|
+
emitSynthFocused: boolean;
|
|
12620
|
+
}, void>;
|
|
12621
|
+
'get-process-info': IdentityCall<{}, OpenFin_2.EntityProcessDetails>;
|
|
12622
|
+
'get-shared-workers': IdentityCall<{}, OpenFin_2.SharedWorkerInfo[]>;
|
|
12623
|
+
'inspect-shared-worker': IdentityCall<{}, void>;
|
|
12624
|
+
'inspect-shared-worker-by-id': IdentityCall<{
|
|
12625
|
+
workerId: string;
|
|
12626
|
+
}, void>;
|
|
12627
|
+
'inspect-service-worker': IdentityCall<{}, void>;
|
|
12628
|
+
'view-show-popup-window': IdentityCall<{}, void>;
|
|
12629
|
+
'window-show-popup-window': IdentityCall<{}, void>;
|
|
12049
12630
|
'try-create-popup-window': {
|
|
12050
12631
|
request: OpenFin_2.Identity & {
|
|
12051
12632
|
options: OpenFin_2.PopupOptions;
|
|
@@ -12061,9 +12642,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12061
12642
|
};
|
|
12062
12643
|
response: OpenFin_2.PopupResult;
|
|
12063
12644
|
};
|
|
12064
|
-
'dispatch-popup-result': IdentityCall<{
|
|
12065
|
-
data: any;
|
|
12066
|
-
}>;
|
|
12067
12645
|
'render-overlay': {
|
|
12068
12646
|
request: {
|
|
12069
12647
|
bounds: OpenFin_2.Bounds;
|
|
@@ -12083,40 +12661,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12083
12661
|
};
|
|
12084
12662
|
response: void;
|
|
12085
12663
|
};
|
|
12086
|
-
'get-host-specs': GetterCall<OpenFin_2.HostSpecs>;
|
|
12087
|
-
'get-os-info': GetterCall<OpenFin_2.OSInfo>;
|
|
12088
|
-
'system-get-printers': GetterCall<OpenFin_2.PrinterInfo[]>;
|
|
12089
|
-
'system-register-shutdown-handler': VoidCall;
|
|
12090
|
-
'get-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.DefaultDomainSettings>;
|
|
12091
|
-
'set-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity & {
|
|
12092
|
-
domainSettings: OpenFin_2.DefaultDomainSettings;
|
|
12093
|
-
}, void>;
|
|
12094
|
-
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12095
|
-
deltaLeft: number;
|
|
12096
|
-
deltaTop: number;
|
|
12097
|
-
}>>;
|
|
12098
|
-
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12099
|
-
left: number;
|
|
12100
|
-
top: number;
|
|
12101
|
-
}>>;
|
|
12102
|
-
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12103
|
-
deltaWidth: number;
|
|
12104
|
-
deltaHeight: number;
|
|
12105
|
-
anchor: OpenFin_2.AnchorType;
|
|
12106
|
-
}>>;
|
|
12107
|
-
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12108
|
-
width: number;
|
|
12109
|
-
height: number;
|
|
12110
|
-
anchor: OpenFin_2.AnchorType;
|
|
12111
|
-
}>>;
|
|
12112
|
-
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
|
|
12113
|
-
'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void>;
|
|
12114
|
-
'unregister-custom-protocol': ApiCall<{
|
|
12115
|
-
protocolName: string;
|
|
12116
|
-
}, void>;
|
|
12117
|
-
'get-custom-protocol-state': ApiCall<{
|
|
12118
|
-
protocolName: string;
|
|
12119
|
-
}, OpenFin_2.CustomProtocolState>;
|
|
12120
12664
|
}
|
|
12121
12665
|
|
|
12122
12666
|
declare interface ProtocolMapBase {
|
|
@@ -12146,7 +12690,7 @@ declare type ProviderIdentity_3 = OpenFin_2.ProviderIdentity;
|
|
|
12146
12690
|
* Identity of a channel provider.
|
|
12147
12691
|
* @interface
|
|
12148
12692
|
*/
|
|
12149
|
-
declare type ProviderIdentity_4 =
|
|
12693
|
+
declare type ProviderIdentity_4 = Identity_4 & {
|
|
12150
12694
|
/**
|
|
12151
12695
|
* Identifier of the channel.
|
|
12152
12696
|
*/
|
|
@@ -12157,12 +12701,10 @@ declare type ProviderIdentity_4 = Identity_5 & {
|
|
|
12157
12701
|
channelName: string;
|
|
12158
12702
|
};
|
|
12159
12703
|
|
|
12160
|
-
declare type ProxyConfig = OpenFin_2.ProxyConfig;
|
|
12161
|
-
|
|
12162
12704
|
/**
|
|
12163
12705
|
* @interface
|
|
12164
12706
|
*/
|
|
12165
|
-
declare type
|
|
12707
|
+
declare type ProxyConfig = {
|
|
12166
12708
|
/**
|
|
12167
12709
|
* The configured proxy address.
|
|
12168
12710
|
*/
|
|
@@ -12174,13 +12716,11 @@ declare type ProxyConfig_2 = {
|
|
|
12174
12716
|
type: string;
|
|
12175
12717
|
};
|
|
12176
12718
|
|
|
12177
|
-
declare type ProxyInfo = OpenFin_2.ProxyInfo;
|
|
12178
|
-
|
|
12179
12719
|
/**
|
|
12180
12720
|
* @interface
|
|
12181
12721
|
*/
|
|
12182
|
-
declare type
|
|
12183
|
-
config:
|
|
12722
|
+
declare type ProxyInfo = {
|
|
12723
|
+
config: ProxyConfig;
|
|
12184
12724
|
system: ProxySystemInfo;
|
|
12185
12725
|
};
|
|
12186
12726
|
|
|
@@ -12286,12 +12826,10 @@ declare type RegisterUsageData = {
|
|
|
12286
12826
|
type: string;
|
|
12287
12827
|
};
|
|
12288
12828
|
|
|
12289
|
-
declare type RegistryInfo = OpenFin_2.RegistryInfo;
|
|
12290
|
-
|
|
12291
12829
|
/**
|
|
12292
12830
|
* @interface
|
|
12293
12831
|
*/
|
|
12294
|
-
declare type
|
|
12832
|
+
declare type RegistryInfo = {
|
|
12295
12833
|
data: any;
|
|
12296
12834
|
rootKey: string;
|
|
12297
12835
|
subkey: string;
|
|
@@ -12349,14 +12887,14 @@ declare type ReplaceLayoutPayload = {
|
|
|
12349
12887
|
/**
|
|
12350
12888
|
* Identity of the window whose layout will be replaced.
|
|
12351
12889
|
*/
|
|
12352
|
-
target:
|
|
12890
|
+
target: Identity_4 | LayoutIdentity;
|
|
12353
12891
|
};
|
|
12354
12892
|
|
|
12355
12893
|
/**
|
|
12356
12894
|
* @interface
|
|
12357
12895
|
*/
|
|
12358
12896
|
declare type ReplaceViewOptions = {
|
|
12359
|
-
viewToReplace:
|
|
12897
|
+
viewToReplace: Identity_4;
|
|
12360
12898
|
newView: ViewState;
|
|
12361
12899
|
};
|
|
12362
12900
|
|
|
@@ -12365,7 +12903,7 @@ declare type ReplaceViewOptions = {
|
|
|
12365
12903
|
*/
|
|
12366
12904
|
declare type ReplaceViewPayload = {
|
|
12367
12905
|
opts: {
|
|
12368
|
-
viewToReplace:
|
|
12906
|
+
viewToReplace: Identity_4;
|
|
12369
12907
|
newView: Partial<ViewOptions>;
|
|
12370
12908
|
};
|
|
12371
12909
|
target: LayoutIdentity;
|
|
@@ -12731,7 +13269,7 @@ declare type SetWindowContextPayload = {
|
|
|
12731
13269
|
/**
|
|
12732
13270
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
12733
13271
|
*/
|
|
12734
|
-
target:
|
|
13272
|
+
target: Identity_4;
|
|
12735
13273
|
};
|
|
12736
13274
|
|
|
12737
13275
|
/**
|
|
@@ -13181,7 +13719,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13181
13719
|
* fin.System.getAllWindows().then(wins => console.log(wins)).catch(err => console.log(err));
|
|
13182
13720
|
* ```
|
|
13183
13721
|
*/
|
|
13184
|
-
getAllWindows(): Promise<Array<ApplicationWindowInfo>>;
|
|
13722
|
+
getAllWindows(): Promise<Array<OpenFin_2.ApplicationWindowInfo>>;
|
|
13185
13723
|
/**
|
|
13186
13724
|
* Retrieves an array of data for all applications.
|
|
13187
13725
|
*
|
|
@@ -13190,7 +13728,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13190
13728
|
* fin.System.getAllApplications().then(apps => console.log(apps)).catch(err => console.log(err));
|
|
13191
13729
|
* ```
|
|
13192
13730
|
*/
|
|
13193
|
-
getAllApplications(): Promise<Array<ApplicationState>>;
|
|
13731
|
+
getAllApplications(): Promise<Array<OpenFin_2.ApplicationState>>;
|
|
13194
13732
|
/**
|
|
13195
13733
|
* Retrieves the command line argument string that started OpenFin Runtime.
|
|
13196
13734
|
*
|
|
@@ -13265,7 +13803,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13265
13803
|
* }
|
|
13266
13804
|
* ```
|
|
13267
13805
|
*/
|
|
13268
|
-
getEntityInfo(uuid: string, name: string): Promise<EntityInfo>;
|
|
13806
|
+
getEntityInfo(uuid: string, name: string): Promise<OpenFin_2.EntityInfo>;
|
|
13269
13807
|
/**
|
|
13270
13808
|
* Gets the value of a given environment variable on the computer on which the runtime is installed
|
|
13271
13809
|
*
|
|
@@ -13307,7 +13845,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13307
13845
|
* ```
|
|
13308
13846
|
*/
|
|
13309
13847
|
getInstalledRuntimes(): Promise<string[]>;
|
|
13310
|
-
getInstalledApps(): Promise<InstalledApps>;
|
|
13848
|
+
getInstalledApps(): Promise<OpenFin_2.InstalledApps>;
|
|
13311
13849
|
/**
|
|
13312
13850
|
* Retrieves the contents of the log with the specified filename.
|
|
13313
13851
|
* @param options A object that id defined by the GetLogRequestType interface
|
|
@@ -13322,7 +13860,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13322
13860
|
* getLog().then(log => console.log(log)).catch(err => console.log(err));
|
|
13323
13861
|
* ```
|
|
13324
13862
|
*/
|
|
13325
|
-
getLog(options: GetLogRequestType): Promise<string>;
|
|
13863
|
+
getLog(options: OpenFin_2.GetLogRequestType): Promise<string>;
|
|
13326
13864
|
/**
|
|
13327
13865
|
* Returns a unique identifier (UUID) provided by the machine.
|
|
13328
13866
|
*
|
|
@@ -13340,7 +13878,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13340
13878
|
* fin.System.getMinLogLevel().then(level => console.log(level)).catch(err => console.log(err));
|
|
13341
13879
|
* ```
|
|
13342
13880
|
*/
|
|
13343
|
-
getMinLogLevel(): Promise<LogLevel>;
|
|
13881
|
+
getMinLogLevel(): Promise<OpenFin_2.LogLevel>;
|
|
13344
13882
|
/**
|
|
13345
13883
|
* Retrieves an array containing information for each log file.
|
|
13346
13884
|
*
|
|
@@ -13349,7 +13887,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13349
13887
|
* fin.System.getLogList().then(logList => console.log(logList)).catch(err => console.log(err));
|
|
13350
13888
|
* ```
|
|
13351
13889
|
*/
|
|
13352
|
-
getLogList(): Promise<Array<LogInfo>>;
|
|
13890
|
+
getLogList(): Promise<Array<OpenFin_2.LogInfo>>;
|
|
13353
13891
|
/**
|
|
13354
13892
|
* Retrieves an object that contains data about the monitor setup of the
|
|
13355
13893
|
* computer that the runtime is running on.
|
|
@@ -13420,7 +13958,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13420
13958
|
* }
|
|
13421
13959
|
* ```
|
|
13422
13960
|
*/
|
|
13423
|
-
getProxySettings(): Promise<ProxyInfo>;
|
|
13961
|
+
getProxySettings(): Promise<OpenFin_2.ProxyInfo>;
|
|
13424
13962
|
/**
|
|
13425
13963
|
* Returns information about the running Runtime in an object.
|
|
13426
13964
|
*
|
|
@@ -13787,7 +14325,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13787
14325
|
* }
|
|
13788
14326
|
* ```
|
|
13789
14327
|
*/
|
|
13790
|
-
launchExternalProcess(options: OpenFin_2.ExternalProcessRequestType): Promise<
|
|
14328
|
+
launchExternalProcess(options: OpenFin_2.ExternalProcessRequestType): Promise<Identity>;
|
|
13791
14329
|
/**
|
|
13792
14330
|
* Monitors a running process. A pid for the process must be included in options.
|
|
13793
14331
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -13804,7 +14342,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13804
14342
|
* }).then(processIdentity => console.log(processIdentity)).catch(err => console.log(err));
|
|
13805
14343
|
* ```
|
|
13806
14344
|
*/
|
|
13807
|
-
monitorExternalProcess(options: OpenFin_2.ExternalProcessInfo): Promise<
|
|
14345
|
+
monitorExternalProcess(options: OpenFin_2.ExternalProcessInfo): Promise<Identity>;
|
|
13808
14346
|
/**
|
|
13809
14347
|
* Writes the passed message into both the log file and the console.
|
|
13810
14348
|
* @param level The log level for the entry. Can be either "info", "warning" or "error"
|
|
@@ -13938,7 +14476,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13938
14476
|
*
|
|
13939
14477
|
* @tutorial System.showDeveloperTools
|
|
13940
14478
|
*/
|
|
13941
|
-
showDeveloperTools(identity:
|
|
14479
|
+
showDeveloperTools(identity: Identity): Promise<void>;
|
|
13942
14480
|
/**
|
|
13943
14481
|
* Attempt to close an external process. The process will be terminated if it
|
|
13944
14482
|
* has not closed after the elapsed timeout in milliseconds.
|
|
@@ -13972,7 +14510,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13972
14510
|
* .catch(err => console.error(err));
|
|
13973
14511
|
* ```
|
|
13974
14512
|
*/
|
|
13975
|
-
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
14513
|
+
updateProxySettings(options: OpenFin_2.ProxyConfig): Promise<void>;
|
|
13976
14514
|
/**
|
|
13977
14515
|
* Downloads the given application asset.
|
|
13978
14516
|
*
|
|
@@ -14064,7 +14602,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14064
14602
|
* .catch(err => console.log(err));
|
|
14065
14603
|
* ```
|
|
14066
14604
|
*/
|
|
14067
|
-
getAllExternalApplications(): Promise<Array<
|
|
14605
|
+
getAllExternalApplications(): Promise<Array<Identity>>;
|
|
14068
14606
|
/**
|
|
14069
14607
|
* Retrieves app asset information.
|
|
14070
14608
|
* @param options
|
|
@@ -14093,7 +14631,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14093
14631
|
* fin.System.setMinLogLevel("verbose").then(() => console.log("log level is set to verbose")).catch(err => console.log(err));
|
|
14094
14632
|
* ```
|
|
14095
14633
|
*/
|
|
14096
|
-
setMinLogLevel(level: LogLevel): Promise<void>;
|
|
14634
|
+
setMinLogLevel(level: OpenFin_2.LogLevel): Promise<void>;
|
|
14097
14635
|
/**
|
|
14098
14636
|
* Retrieves the UUID of the computer on which the runtime is installed
|
|
14099
14637
|
* @param uuid The uuid of the running application
|
|
@@ -14103,7 +14641,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14103
14641
|
* fin.System.resolveUuid('OpenfinPOC').then(entity => console.log(entity)).catch(err => console.log(err));
|
|
14104
14642
|
* ```
|
|
14105
14643
|
*/
|
|
14106
|
-
resolveUuid(uuid: string): Promise<
|
|
14644
|
+
resolveUuid(uuid: string): Promise<OpenFin_2.ApplicationType>;
|
|
14107
14645
|
/**
|
|
14108
14646
|
* Retrieves an array of data for all external applications
|
|
14109
14647
|
* @param requestingIdentity This object is described in the Identity typedef
|
|
@@ -14111,7 +14649,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14111
14649
|
*
|
|
14112
14650
|
* @ignore
|
|
14113
14651
|
*/
|
|
14114
|
-
executeOnRemote(requestingIdentity:
|
|
14652
|
+
executeOnRemote(requestingIdentity: Identity, data: any): Promise<any>;
|
|
14115
14653
|
/**
|
|
14116
14654
|
* Reads the specifed value from the registry.
|
|
14117
14655
|
* @remarks This method is restricted by default and must be enabled via
|
|
@@ -14204,7 +14742,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14204
14742
|
* }
|
|
14205
14743
|
* ```
|
|
14206
14744
|
*/
|
|
14207
|
-
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<RegistryInfo>;
|
|
14745
|
+
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<OpenFin_2.RegistryInfo>;
|
|
14208
14746
|
/**
|
|
14209
14747
|
* This function call will register a unique id and produce a token.
|
|
14210
14748
|
* The token can be used to broker an external connection.
|
|
@@ -14419,7 +14957,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14419
14957
|
* });
|
|
14420
14958
|
* ```
|
|
14421
14959
|
*/
|
|
14422
|
-
getPrinters(): Promise<PrinterInfo[]>;
|
|
14960
|
+
getPrinters(): Promise<OpenFin_2.PrinterInfo[]>;
|
|
14423
14961
|
/**
|
|
14424
14962
|
* Updates Process Logging values: periodic interval and outlier detection entries and interval.
|
|
14425
14963
|
* @param options Process Logging updatable options.
|
|
@@ -15045,14 +15583,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
15045
15583
|
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
|
15046
15584
|
|
|
15047
15585
|
/**
|
|
15048
|
-
*
|
|
15586
|
+
* An event that fires when a window's bounds are changed directly by the user.
|
|
15587
|
+
*
|
|
15049
15588
|
* @interface
|
|
15050
15589
|
*/
|
|
15051
|
-
declare type UserBoundsChangeEvent =
|
|
15052
|
-
height: number;
|
|
15053
|
-
left: number;
|
|
15054
|
-
top: number;
|
|
15055
|
-
width: number;
|
|
15590
|
+
declare type UserBoundsChangeEvent = BoundsEvent & {
|
|
15056
15591
|
windowState: 'minimized' | 'normal' | 'maximized';
|
|
15057
15592
|
};
|
|
15058
15593
|
|
|
@@ -15384,7 +15919,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
15384
15919
|
*/
|
|
15385
15920
|
getInfo: () => Promise<OpenFin_2.ViewInfo>;
|
|
15386
15921
|
/**
|
|
15387
|
-
* Retrieves the
|
|
15922
|
+
* Retrieves the OpenFin.Layout instance for the Window the View is attached to.
|
|
15388
15923
|
*
|
|
15389
15924
|
* @example
|
|
15390
15925
|
* ```js
|
|
@@ -15582,6 +16117,24 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
15582
16117
|
options?: Partial<ViewOptions>;
|
|
15583
16118
|
};
|
|
15584
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
|
+
|
|
15585
16138
|
/**
|
|
15586
16139
|
* The options object required by {@link View.ViewModule.create View.create}.
|
|
15587
16140
|
*
|
|
@@ -15592,11 +16145,30 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
15592
16145
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
15593
16146
|
name: string;
|
|
15594
16147
|
url: string;
|
|
15595
|
-
target:
|
|
16148
|
+
target: Identity_4;
|
|
15596
16149
|
};
|
|
15597
16150
|
|
|
15598
16151
|
declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;
|
|
15599
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
|
+
|
|
15600
16172
|
/**
|
|
15601
16173
|
* Generated when a window has a view detached from it.
|
|
15602
16174
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
@@ -15778,15 +16350,15 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
15778
16350
|
/**
|
|
15779
16351
|
* Identity of the Window.
|
|
15780
16352
|
*/
|
|
15781
|
-
windowId:
|
|
16353
|
+
windowId: Identity_4;
|
|
15782
16354
|
/**
|
|
15783
16355
|
* Identities of the Views that are preventing an unload
|
|
15784
16356
|
*/
|
|
15785
|
-
viewsPreventingUnload:
|
|
16357
|
+
viewsPreventingUnload: Identity_4[];
|
|
15786
16358
|
/**
|
|
15787
16359
|
* Identities of the Views that are not preventing an unload
|
|
15788
16360
|
*/
|
|
15789
|
-
viewsNotPreventingUnload:
|
|
16361
|
+
viewsNotPreventingUnload: Identity_4[];
|
|
15790
16362
|
/**
|
|
15791
16363
|
* Source of the close action.
|
|
15792
16364
|
*/
|
|
@@ -15811,11 +16383,11 @@ declare interface ViewStatuses {
|
|
|
15811
16383
|
/**
|
|
15812
16384
|
* Identities of the Views that are preventing an unload.
|
|
15813
16385
|
*/
|
|
15814
|
-
viewsPreventingUnload:
|
|
16386
|
+
viewsPreventingUnload: Identity_4[];
|
|
15815
16387
|
/**
|
|
15816
16388
|
* Identities of the Views that are not preventing an unload.
|
|
15817
16389
|
*/
|
|
15818
|
-
viewsNotPreventingUnload:
|
|
16390
|
+
viewsNotPreventingUnload: Identity_4[];
|
|
15819
16391
|
}
|
|
15820
16392
|
|
|
15821
16393
|
/**
|
|
@@ -16320,7 +16892,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
16320
16892
|
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
16321
16893
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
16322
16894
|
*/
|
|
16323
|
-
stopFindInPage(action:
|
|
16895
|
+
stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): Promise<void>;
|
|
16324
16896
|
/**
|
|
16325
16897
|
* Returns an array with all system printers
|
|
16326
16898
|
* @deprecated use System.getPrinters instead
|
|
@@ -16913,11 +17485,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
16913
17485
|
* A general will-move or will-resize event without event type.
|
|
16914
17486
|
* @interface
|
|
16915
17487
|
*/
|
|
16916
|
-
declare type WillMoveOrResizeEvent =
|
|
16917
|
-
height: number;
|
|
16918
|
-
left: number;
|
|
16919
|
-
top: number;
|
|
16920
|
-
width: number;
|
|
17488
|
+
declare type WillMoveOrResizeEvent = BoundsEvent & {
|
|
16921
17489
|
monitorScaleFactor: number;
|
|
16922
17490
|
};
|
|
16923
17491
|
|
|
@@ -18112,16 +18680,21 @@ declare namespace WindowEvents {
|
|
|
18112
18680
|
PreloadScriptInfoRunning,
|
|
18113
18681
|
PreloadScriptInfo,
|
|
18114
18682
|
PreloadScriptsStateChangeEvent,
|
|
18115
|
-
|
|
18683
|
+
BoundsEvent,
|
|
18116
18684
|
BoundsChangeEvent,
|
|
18117
18685
|
WillMoveOrResizeEvent,
|
|
18686
|
+
BoundsDidChangeEvent,
|
|
18687
|
+
BoundsChangedEvent,
|
|
18688
|
+
BoundsChangingEvent,
|
|
18689
|
+
DisabledMovementBoundsChangedEvent,
|
|
18690
|
+
DisabledMovementBoundsChangingEvent,
|
|
18691
|
+
UserBoundsChangeEvent,
|
|
18692
|
+
BeginUserBoundsChangingEvent,
|
|
18693
|
+
EndUserBoundsChangingEvent,
|
|
18118
18694
|
PerformanceReportEvent,
|
|
18119
18695
|
InputEvent_2 as InputEvent,
|
|
18120
18696
|
LayoutInitializedEvent,
|
|
18121
18697
|
LayoutReadyEvent,
|
|
18122
|
-
BeginUserBoundsChangingEvent,
|
|
18123
|
-
BoundsChangedEvent,
|
|
18124
|
-
BoundsChangingEvent,
|
|
18125
18698
|
CloseRequestedEvent,
|
|
18126
18699
|
WindowCloseRequestedEvent,
|
|
18127
18700
|
ContextChangedEvent,
|
|
@@ -18129,10 +18702,7 @@ declare namespace WindowEvents {
|
|
|
18129
18702
|
WindowClosedEvent,
|
|
18130
18703
|
ClosingEvent,
|
|
18131
18704
|
WindowClosingEvent,
|
|
18132
|
-
DisabledMovementBoundsChangedEvent,
|
|
18133
|
-
DisabledMovementBoundsChangingEvent,
|
|
18134
18705
|
EmbeddedEvent,
|
|
18135
|
-
EndUserBoundsChangingEvent,
|
|
18136
18706
|
HotkeyEvent_2 as HotkeyEvent,
|
|
18137
18707
|
WindowHotkeyEvent,
|
|
18138
18708
|
InitializedEvent_2 as InitializedEvent,
|