@openfin/fdc3-api 38.83.89 → 39.81.3
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 +287 -1228
- package/out/fdc3-api-beta.d.ts +287 -1228
- package/out/fdc3-api-public.d.ts +287 -1228
- package/out/fdc3-api.d.ts +287 -1228
- package/out/fdc3-api.js +14 -43
- package/package.json +1 -1
package/out/fdc3-api.d.ts
CHANGED
|
@@ -42,15 +42,6 @@ declare type Accelerator = {
|
|
|
42
42
|
zoom: boolean;
|
|
43
43
|
};
|
|
44
44
|
|
|
45
|
-
/**
|
|
46
|
-
* Generated when a View is added to a layout.
|
|
47
|
-
* @interface
|
|
48
|
-
*/
|
|
49
|
-
declare type AddedToLayoutEvent = BaseEvent_4 & {
|
|
50
|
-
type: 'added-to-layout';
|
|
51
|
-
layoutIdentity: OpenFin.LayoutIdentity;
|
|
52
|
-
};
|
|
53
|
-
|
|
54
45
|
/**
|
|
55
46
|
* Options to use when adding a view to a {@link TabStack}.
|
|
56
47
|
*
|
|
@@ -58,7 +49,7 @@ declare type AddedToLayoutEvent = BaseEvent_4 & {
|
|
|
58
49
|
*/
|
|
59
50
|
declare type AddViewOptions = CreateViewTarget & {
|
|
60
51
|
options: ViewState;
|
|
61
|
-
targetView?:
|
|
52
|
+
targetView?: Identity_5;
|
|
62
53
|
};
|
|
63
54
|
|
|
64
55
|
/**
|
|
@@ -108,7 +99,7 @@ declare type ApiInjection = DomainApiSettings;
|
|
|
108
99
|
* Generated when a new Platform's API becomes responsive.
|
|
109
100
|
* @interface
|
|
110
101
|
*/
|
|
111
|
-
declare type ApiReadyEvent =
|
|
102
|
+
declare type ApiReadyEvent = BaseEvent & {
|
|
112
103
|
topic: 'application';
|
|
113
104
|
type: 'platform-api-ready';
|
|
114
105
|
};
|
|
@@ -926,7 +917,7 @@ declare namespace ApplicationEvents {
|
|
|
926
917
|
PropagatedApplicationEvent,
|
|
927
918
|
PropagatedEventType_3 as PropagatedEventType,
|
|
928
919
|
PropagatedApplicationEventType,
|
|
929
|
-
|
|
920
|
+
Payload_4 as Payload,
|
|
930
921
|
ByType_3 as ByType
|
|
931
922
|
}
|
|
932
923
|
}
|
|
@@ -936,15 +927,15 @@ declare namespace ApplicationEvents {
|
|
|
936
927
|
*/
|
|
937
928
|
declare type ApplicationEventType = EventType_3;
|
|
938
929
|
|
|
930
|
+
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
|
931
|
+
|
|
939
932
|
/**
|
|
940
933
|
* @interface
|
|
941
934
|
*/
|
|
942
|
-
declare type
|
|
935
|
+
declare type ApplicationIdentity_2 = {
|
|
943
936
|
uuid: string;
|
|
944
937
|
};
|
|
945
938
|
|
|
946
|
-
declare type ApplicationIdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.ApplicationIdentity, Response>;
|
|
947
|
-
|
|
948
939
|
/**
|
|
949
940
|
* @interface
|
|
950
941
|
*/
|
|
@@ -1179,9 +1170,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1179
1170
|
* The name of the application.
|
|
1180
1171
|
*
|
|
1181
1172
|
* @remarks
|
|
1182
|
-
* This property is used for naming the application logging folder, which will be sanitized to remove
|
|
1183
|
-
* any special characters, spaces or international characters.
|
|
1184
|
-
*
|
|
1173
|
+
* This property is only used for naming the application logging folder, which will be sanitized to remove
|
|
1174
|
+
* any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
|
|
1175
|
+
* during startup with the UUID of the application.
|
|
1185
1176
|
*
|
|
1186
1177
|
* This property will be deprecated in the future.
|
|
1187
1178
|
*/
|
|
@@ -1291,10 +1282,6 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1291
1282
|
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1292
1283
|
*/
|
|
1293
1284
|
enableBeforeUnload: boolean;
|
|
1294
|
-
/**
|
|
1295
|
-
* Set the timezone for the app logs. When setting this value the timestamp will be in ISO 8601 format. By default, if no value is set, it will show the local time in this format: 'y-MM-dd HH:mm:ss.SSS'
|
|
1296
|
-
*/
|
|
1297
|
-
appLogsTimezone: TimeZones;
|
|
1298
1285
|
};
|
|
1299
1286
|
|
|
1300
1287
|
/**
|
|
@@ -1317,10 +1304,12 @@ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedE
|
|
|
1317
1304
|
*/
|
|
1318
1305
|
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1319
1306
|
|
|
1307
|
+
declare type ApplicationState = OpenFin.ApplicationState;
|
|
1308
|
+
|
|
1320
1309
|
/**
|
|
1321
1310
|
* @interface
|
|
1322
1311
|
*/
|
|
1323
|
-
declare type
|
|
1312
|
+
declare type ApplicationState_2 = {
|
|
1324
1313
|
/**
|
|
1325
1314
|
* True when the application is a Platform controller
|
|
1326
1315
|
*/
|
|
@@ -1352,10 +1341,12 @@ declare type ApplicationType = {
|
|
|
1352
1341
|
*/
|
|
1353
1342
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
|
1354
1343
|
|
|
1344
|
+
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
|
1345
|
+
|
|
1355
1346
|
/**
|
|
1356
1347
|
* @interface
|
|
1357
1348
|
*/
|
|
1358
|
-
declare type
|
|
1349
|
+
declare type ApplicationWindowInfo_2 = {
|
|
1359
1350
|
childWindows: Array<WindowDetail>;
|
|
1360
1351
|
mainWindow: WindowDetail;
|
|
1361
1352
|
/**
|
|
@@ -1634,7 +1625,7 @@ declare class Base {
|
|
|
1634
1625
|
* Useful for debugging in the devtools console, where this will intelligently type itself based
|
|
1635
1626
|
* on the context in which the devtools panel was opened.
|
|
1636
1627
|
*/
|
|
1637
|
-
get me():
|
|
1628
|
+
get me(): Identity;
|
|
1638
1629
|
/**
|
|
1639
1630
|
* @internal
|
|
1640
1631
|
* @deprecated
|
|
@@ -1744,7 +1735,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
|
|
1744
1735
|
* A base Channel event.
|
|
1745
1736
|
* @interface
|
|
1746
1737
|
*/
|
|
1747
|
-
declare type BaseEvent_2 =
|
|
1738
|
+
declare type BaseEvent_2 = NamedEvent & {
|
|
1748
1739
|
channelName: string;
|
|
1749
1740
|
channelId: string;
|
|
1750
1741
|
};
|
|
@@ -1814,7 +1805,6 @@ declare namespace BaseEvents {
|
|
|
1814
1805
|
NotCloseRequested,
|
|
1815
1806
|
PropagatedEventType,
|
|
1816
1807
|
PropagatedEvent,
|
|
1817
|
-
Payload_2 as Payload,
|
|
1818
1808
|
EventHandler,
|
|
1819
1809
|
BaseEvent,
|
|
1820
1810
|
IdentityEvent,
|
|
@@ -1866,12 +1856,11 @@ declare type BeforeUnloadUserDecision = {
|
|
|
1866
1856
|
/**
|
|
1867
1857
|
* Array of views that will close.
|
|
1868
1858
|
*/
|
|
1869
|
-
viewsToClose:
|
|
1859
|
+
viewsToClose: Identity_5[];
|
|
1870
1860
|
};
|
|
1871
1861
|
|
|
1872
1862
|
/**
|
|
1873
1863
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
|
1874
|
-
*
|
|
1875
1864
|
* @interface
|
|
1876
1865
|
*/
|
|
1877
1866
|
declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
@@ -1912,33 +1901,31 @@ declare type Bounds = {
|
|
|
1912
1901
|
* Generated after changes in a window's size and/or position.
|
|
1913
1902
|
* @interface
|
|
1914
1903
|
*/
|
|
1915
|
-
declare type BoundsChangedEvent =
|
|
1904
|
+
declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1916
1905
|
type: 'bounds-changed';
|
|
1917
1906
|
};
|
|
1918
1907
|
|
|
1919
|
-
declare type BoundsChangeEvent = BoundsEvent & {
|
|
1920
|
-
changeType: 0 | 1 | 2;
|
|
1921
|
-
};
|
|
1922
|
-
|
|
1923
1908
|
/**
|
|
1924
|
-
*
|
|
1909
|
+
* A general bounds change event without event type.
|
|
1925
1910
|
* @interface
|
|
1926
1911
|
*/
|
|
1927
|
-
declare type
|
|
1928
|
-
|
|
1912
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1913
|
+
changeType: 0 | 1 | 2;
|
|
1914
|
+
deferred: boolean;
|
|
1915
|
+
height: number;
|
|
1916
|
+
left: number;
|
|
1917
|
+
top: number;
|
|
1918
|
+
width: number;
|
|
1929
1919
|
};
|
|
1930
1920
|
|
|
1931
1921
|
/**
|
|
1932
|
-
*
|
|
1933
|
-
*
|
|
1922
|
+
* Generated during changes to a window's size and/or position.
|
|
1934
1923
|
* @interface
|
|
1935
1924
|
*/
|
|
1936
|
-
declare type
|
|
1937
|
-
|
|
1925
|
+
declare type BoundsChangingEvent = BoundsChangeEvent & {
|
|
1926
|
+
type: 'bounds-changing';
|
|
1938
1927
|
};
|
|
1939
1928
|
|
|
1940
|
-
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1941
|
-
|
|
1942
1929
|
/**
|
|
1943
1930
|
* A rule prescribing content creation in the browser.
|
|
1944
1931
|
*
|
|
@@ -1958,7 +1945,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
|
1958
1945
|
*
|
|
1959
1946
|
* @typeParam Type String key specifying the event to extract
|
|
1960
1947
|
*/
|
|
1961
|
-
declare type ByType<Type extends EventType> =
|
|
1948
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
1962
1949
|
|
|
1963
1950
|
/**
|
|
1964
1951
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
@@ -1967,7 +1954,7 @@ declare type ByType<Type extends EventType> = Payload_3<Type>;
|
|
|
1967
1954
|
*
|
|
1968
1955
|
* @typeParam Type String key specifying the event to extract
|
|
1969
1956
|
*/
|
|
1970
|
-
declare type ByType_2<Type extends EventType_2> =
|
|
1957
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
1971
1958
|
|
|
1972
1959
|
/**
|
|
1973
1960
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
@@ -1976,7 +1963,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
|
|
|
1976
1963
|
*
|
|
1977
1964
|
* @typeParam Type String key specifying the event to extract
|
|
1978
1965
|
*/
|
|
1979
|
-
declare type ByType_3<Type extends EventType_3> =
|
|
1966
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
1980
1967
|
|
|
1981
1968
|
/**
|
|
1982
1969
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
@@ -1985,7 +1972,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
|
|
|
1985
1972
|
*
|
|
1986
1973
|
* @typeParam Type String key specifying the event to extract
|
|
1987
1974
|
*/
|
|
1988
|
-
declare type ByType_4<Type extends EventType_4> =
|
|
1975
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
1989
1976
|
|
|
1990
1977
|
/**
|
|
1991
1978
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
@@ -1994,7 +1981,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
|
|
|
1994
1981
|
*
|
|
1995
1982
|
* @typeParam Type String key specifying the event to extract
|
|
1996
1983
|
*/
|
|
1997
|
-
declare type ByType_5<Type extends EventType_5> =
|
|
1984
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
1998
1985
|
|
|
1999
1986
|
/**
|
|
2000
1987
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
@@ -2003,7 +1990,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
|
|
|
2003
1990
|
*
|
|
2004
1991
|
* @typeParam Type String key specifying the event to extract
|
|
2005
1992
|
*/
|
|
2006
|
-
declare type ByType_6<Type extends EventType_6> =
|
|
1993
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
2007
1994
|
|
|
2008
1995
|
/**
|
|
2009
1996
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
@@ -2012,7 +1999,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
|
|
|
2012
1999
|
*
|
|
2013
2000
|
* @typeParam Type String key specifying the event to extract
|
|
2014
2001
|
*/
|
|
2015
|
-
declare type ByType_7<Type extends EventType_7> =
|
|
2002
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2016
2003
|
|
|
2017
2004
|
/**
|
|
2018
2005
|
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
@@ -2021,7 +2008,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
|
|
|
2021
2008
|
*
|
|
2022
2009
|
* @typeParam Type String key specifying the event to extract
|
|
2023
2010
|
*/
|
|
2024
|
-
declare type ByType_8<Type extends EventType_8> =
|
|
2011
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
2025
2012
|
|
|
2026
2013
|
/**
|
|
2027
2014
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
|
@@ -2030,7 +2017,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
|
|
|
2030
2017
|
*
|
|
2031
2018
|
* @typeParam Type String key specifying the event to extract
|
|
2032
2019
|
*/
|
|
2033
|
-
declare type ByType_9<Type extends EventType_9> =
|
|
2020
|
+
declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
|
|
2034
2021
|
|
|
2035
2022
|
/**
|
|
2036
2023
|
* Configuration for page capture.
|
|
@@ -2996,18 +2983,6 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
2996
2983
|
childOptions: OpenFin.WindowOptions;
|
|
2997
2984
|
};
|
|
2998
2985
|
|
|
2999
|
-
/**
|
|
3000
|
-
* Control behavior for Chromium policies
|
|
3001
|
-
*
|
|
3002
|
-
* @interface
|
|
3003
|
-
*/
|
|
3004
|
-
declare type ChromiumPolicies = {
|
|
3005
|
-
/**
|
|
3006
|
-
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
3007
|
-
*/
|
|
3008
|
-
AutofillAddressEnabled?: PolicyOptions;
|
|
3009
|
-
};
|
|
3010
|
-
|
|
3011
2986
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
3012
2987
|
type: 'classic';
|
|
3013
2988
|
}
|
|
@@ -3056,7 +3031,7 @@ declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
|
3056
3031
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
3057
3032
|
* @interface
|
|
3058
3033
|
*/
|
|
3059
|
-
declare type ClientIdentity =
|
|
3034
|
+
declare type ClientIdentity = Identity_5 & {
|
|
3060
3035
|
/**
|
|
3061
3036
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
|
3062
3037
|
*/
|
|
@@ -3289,7 +3264,7 @@ declare type CloseViewOptions = {
|
|
|
3289
3264
|
/**
|
|
3290
3265
|
*View to be closed.
|
|
3291
3266
|
*/
|
|
3292
|
-
viewIdentity:
|
|
3267
|
+
viewIdentity: Identity_5;
|
|
3293
3268
|
};
|
|
3294
3269
|
|
|
3295
3270
|
/**
|
|
@@ -3299,7 +3274,7 @@ declare type CloseViewPayload = {
|
|
|
3299
3274
|
/**
|
|
3300
3275
|
*View to be closed.
|
|
3301
3276
|
*/
|
|
3302
|
-
view:
|
|
3277
|
+
view: Identity_5;
|
|
3303
3278
|
/**
|
|
3304
3279
|
* The target layout identity where this view should be closed. If not provided, will resolve to the
|
|
3305
3280
|
* visible layout.
|
|
@@ -3317,7 +3292,7 @@ declare interface CloseWindowPayload {
|
|
|
3317
3292
|
*
|
|
3318
3293
|
* Identity of the Window
|
|
3319
3294
|
*/
|
|
3320
|
-
windowId:
|
|
3295
|
+
windowId: Identity_5;
|
|
3321
3296
|
options: {
|
|
3322
3297
|
/**
|
|
3323
3298
|
* @defaultValue false
|
|
@@ -3438,7 +3413,7 @@ declare type ConstViewOptions = {
|
|
|
3438
3413
|
/**
|
|
3439
3414
|
* The identity of the window this view should be attached to.
|
|
3440
3415
|
*/
|
|
3441
|
-
target:
|
|
3416
|
+
target: Identity_5;
|
|
3442
3417
|
/**
|
|
3443
3418
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3444
3419
|
*/
|
|
@@ -3522,10 +3497,6 @@ declare type ConstViewOptions = {
|
|
|
3522
3497
|
*/
|
|
3523
3498
|
enabled: boolean;
|
|
3524
3499
|
};
|
|
3525
|
-
/**
|
|
3526
|
-
* Control which options to ignore when creating a Platform View.
|
|
3527
|
-
*/
|
|
3528
|
-
excludeOptions: ExcludeOptions;
|
|
3529
3500
|
};
|
|
3530
3501
|
|
|
3531
3502
|
/**
|
|
@@ -3565,16 +3536,6 @@ declare type ConstWindowOptions = {
|
|
|
3565
3536
|
* Default is white.
|
|
3566
3537
|
*/
|
|
3567
3538
|
backgroundColor: string;
|
|
3568
|
-
/**
|
|
3569
|
-
* @defaultValue false
|
|
3570
|
-
*
|
|
3571
|
-
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3572
|
-
* This also affects the Page Visibility API.
|
|
3573
|
-
*
|
|
3574
|
-
* When `true`, the page is throttled whether it is hidden or not.
|
|
3575
|
-
*
|
|
3576
|
-
*/
|
|
3577
|
-
backgroundThrottling: boolean;
|
|
3578
3539
|
/**
|
|
3579
3540
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3580
3541
|
*/
|
|
@@ -3667,7 +3628,7 @@ declare type ConstWindowOptions = {
|
|
|
3667
3628
|
/**
|
|
3668
3629
|
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
3669
3630
|
*/
|
|
3670
|
-
modalParentIdentity:
|
|
3631
|
+
modalParentIdentity: Identity_5;
|
|
3671
3632
|
/**
|
|
3672
3633
|
* The name of the window.
|
|
3673
3634
|
*/
|
|
@@ -3685,9 +3646,7 @@ declare type ConstWindowOptions = {
|
|
|
3685
3646
|
*/
|
|
3686
3647
|
preloadScripts: PreloadScript[];
|
|
3687
3648
|
/**
|
|
3688
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
3689
|
-
* 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.
|
|
3690
|
-
* @remarks Will only be used if pages are on the same origin.
|
|
3649
|
+
* String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
|
|
3691
3650
|
*/
|
|
3692
3651
|
processAffinity: string;
|
|
3693
3652
|
/**
|
|
@@ -3734,6 +3693,11 @@ declare type ConstWindowOptions = {
|
|
|
3734
3693
|
* @deprecated - use `icon` instead.
|
|
3735
3694
|
*/
|
|
3736
3695
|
taskbarIcon: string;
|
|
3696
|
+
/**
|
|
3697
|
+
* Specify a taskbar group for the window.
|
|
3698
|
+
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
3699
|
+
*/
|
|
3700
|
+
taskbarIconGroup: string;
|
|
3737
3701
|
/**
|
|
3738
3702
|
* @defaultValue "about:blank"
|
|
3739
3703
|
*
|
|
@@ -3770,10 +3734,6 @@ declare type ConstWindowOptions = {
|
|
|
3770
3734
|
* Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
|
|
3771
3735
|
*/
|
|
3772
3736
|
inheritance?: Partial<InheritableOptions>;
|
|
3773
|
-
/**
|
|
3774
|
-
* Control which options to ignore when creating a Platform Window.
|
|
3775
|
-
*/
|
|
3776
|
-
excludeOptions: ExcludeOptions;
|
|
3777
3737
|
};
|
|
3778
3738
|
|
|
3779
3739
|
/**
|
|
@@ -3786,7 +3746,6 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3786
3746
|
|
|
3787
3747
|
/**
|
|
3788
3748
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3789
|
-
* @interface
|
|
3790
3749
|
*/
|
|
3791
3750
|
declare type ContentBlockedEvent = NamedEvent & {
|
|
3792
3751
|
type: 'content-blocked';
|
|
@@ -4152,13 +4111,13 @@ declare type CreateViewPayload = {
|
|
|
4152
4111
|
* Window the view will be added to. If no target is provided, a new window will be created.
|
|
4153
4112
|
*/
|
|
4154
4113
|
target?: CreateViewTarget;
|
|
4155
|
-
targetView?:
|
|
4114
|
+
targetView?: Identity_5;
|
|
4156
4115
|
};
|
|
4157
4116
|
|
|
4158
4117
|
/**
|
|
4159
4118
|
* @interface
|
|
4160
4119
|
*/
|
|
4161
|
-
declare type CreateViewTarget = (
|
|
4120
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
|
4162
4121
|
/**
|
|
4163
4122
|
* If specified, view creation will not attach to a window and caller must
|
|
4164
4123
|
* insert the view into the layout explicitly
|
|
@@ -4443,10 +4402,6 @@ declare type DomainSettingsRule = {
|
|
|
4443
4402
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4444
4403
|
*/
|
|
4445
4404
|
options: PerDomainSettings;
|
|
4446
|
-
/**
|
|
4447
|
-
* Options to use when comparing URIs to the `match` patterns.
|
|
4448
|
-
*/
|
|
4449
|
-
matchOptions?: RuleMatchOptions;
|
|
4450
4405
|
};
|
|
4451
4406
|
|
|
4452
4407
|
/**
|
|
@@ -4604,7 +4559,7 @@ declare type EmitterAccessor = string[];
|
|
|
4604
4559
|
declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType extends EmitterEvent['type'] = EmitterEvent['type']> extends Base {
|
|
4605
4560
|
#private;
|
|
4606
4561
|
private topic;
|
|
4607
|
-
protected identity:
|
|
4562
|
+
protected identity: ApplicationIdentity;
|
|
4608
4563
|
constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
|
|
4609
4564
|
eventNames: () => (string | symbol)[];
|
|
4610
4565
|
/**
|
|
@@ -4684,17 +4639,20 @@ declare type EndLoadEvent = BaseEvent_5 & {
|
|
|
4684
4639
|
|
|
4685
4640
|
/**
|
|
4686
4641
|
* Generated at the end of a user-driven change to a window's size or position.
|
|
4687
|
-
*
|
|
4688
4642
|
* @interface
|
|
4689
4643
|
*/
|
|
4690
4644
|
declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
4691
4645
|
type: 'end-user-bounds-changing';
|
|
4692
4646
|
};
|
|
4693
4647
|
|
|
4648
|
+
declare type Entity = OpenFin.ApplicationType;
|
|
4649
|
+
|
|
4650
|
+
declare type EntityInfo = OpenFin.EntityInfo;
|
|
4651
|
+
|
|
4694
4652
|
/**
|
|
4695
4653
|
* @interface
|
|
4696
4654
|
*/
|
|
4697
|
-
declare type
|
|
4655
|
+
declare type EntityInfo_2 = {
|
|
4698
4656
|
uuid: string;
|
|
4699
4657
|
name: string;
|
|
4700
4658
|
entityType: EntityType_4;
|
|
@@ -4745,12 +4703,6 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
|
4745
4703
|
} : never;
|
|
4746
4704
|
|
|
4747
4705
|
declare interface Environment {
|
|
4748
|
-
/**
|
|
4749
|
-
* Returns the version of the adapter synchronously.
|
|
4750
|
-
* In OpenFin, this is the version of the runtime.
|
|
4751
|
-
* Elsewhere (e.g. Node.js), this is the version of the adapter, NOT the runtime.
|
|
4752
|
-
*/
|
|
4753
|
-
getAdapterVersionSync(): string;
|
|
4754
4706
|
layoutAllowedInContext(fin: OpenFin.Fin<OpenFin.EntityType>): boolean;
|
|
4755
4707
|
initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
|
|
4756
4708
|
applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
|
|
@@ -4812,7 +4764,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
|
4812
4764
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
4813
4765
|
* from which they propagate).
|
|
4814
4766
|
*/
|
|
4815
|
-
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent
|
|
4767
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
|
4816
4768
|
|
|
4817
4769
|
/**
|
|
4818
4770
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
|
|
@@ -4844,7 +4796,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
|
4844
4796
|
*/
|
|
4845
4797
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
4846
4798
|
target: OpenFin.Identity;
|
|
4847
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent
|
|
4799
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
4848
4800
|
|
|
4849
4801
|
/**
|
|
4850
4802
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
|
@@ -4893,7 +4845,9 @@ declare class EventAggregator extends EmitterMap {
|
|
|
4893
4845
|
* @remarks Selects the correct type for the event
|
|
4894
4846
|
* payload from the provided union based on the provided string literal type.
|
|
4895
4847
|
*/
|
|
4896
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
|
4848
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
|
|
4849
|
+
type: EventType;
|
|
4850
|
+
}>, ...args: any[]) => void;
|
|
4897
4851
|
|
|
4898
4852
|
declare namespace Events {
|
|
4899
4853
|
export {
|
|
@@ -4966,18 +4920,6 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
|
4966
4920
|
appVersionId: string;
|
|
4967
4921
|
} : never;
|
|
4968
4922
|
|
|
4969
|
-
/**
|
|
4970
|
-
* @interface
|
|
4971
|
-
*/
|
|
4972
|
-
declare type ExcludeOptions = {
|
|
4973
|
-
/**
|
|
4974
|
-
* @defaultValue false
|
|
4975
|
-
*
|
|
4976
|
-
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
4977
|
-
*/
|
|
4978
|
-
preloadScripts: boolean;
|
|
4979
|
-
};
|
|
4980
|
-
|
|
4981
4923
|
/**
|
|
4982
4924
|
* @internal
|
|
4983
4925
|
*
|
|
@@ -5002,105 +4944,6 @@ declare type ExitCode = {
|
|
|
5002
4944
|
exitCode: number;
|
|
5003
4945
|
};
|
|
5004
4946
|
|
|
5005
|
-
declare type ExtensionEvent = SecurityRealmEvent & {
|
|
5006
|
-
/**
|
|
5007
|
-
* Runtime extension whose status has been (possibly) modified
|
|
5008
|
-
*/
|
|
5009
|
-
extension: string;
|
|
5010
|
-
};
|
|
5011
|
-
|
|
5012
|
-
/**
|
|
5013
|
-
* @interface
|
|
5014
|
-
*/
|
|
5015
|
-
declare type ExtensionInfo = {
|
|
5016
|
-
extensionId: string;
|
|
5017
|
-
name: string;
|
|
5018
|
-
enabled: boolean;
|
|
5019
|
-
};
|
|
5020
|
-
|
|
5021
|
-
/**
|
|
5022
|
-
* An event that fires when an extension is installed in the security realm.
|
|
5023
|
-
*
|
|
5024
|
-
* @interface
|
|
5025
|
-
*/
|
|
5026
|
-
declare type ExtensionInstalledEvent = ExtensionEvent & {
|
|
5027
|
-
type: 'extension-installed';
|
|
5028
|
-
};
|
|
5029
|
-
|
|
5030
|
-
/**
|
|
5031
|
-
* An event that fires when an extension fails to install in the security realm.
|
|
5032
|
-
*
|
|
5033
|
-
* @interface
|
|
5034
|
-
*/
|
|
5035
|
-
declare type ExtensionInstallFailedEvent = ExtensionEvent & {
|
|
5036
|
-
type: 'extension-install-failed';
|
|
5037
|
-
};
|
|
5038
|
-
|
|
5039
|
-
/**
|
|
5040
|
-
* An event that fires when extensions are disabled in the security realm.
|
|
5041
|
-
*
|
|
5042
|
-
* @interface
|
|
5043
|
-
*/
|
|
5044
|
-
declare type ExtensionsDisabledEvent = ExtensionsEvent & {
|
|
5045
|
-
type: 'extensions-disabled';
|
|
5046
|
-
};
|
|
5047
|
-
|
|
5048
|
-
/**
|
|
5049
|
-
* An event that fires when extensions are enabled in the security realm.
|
|
5050
|
-
*
|
|
5051
|
-
* @interface
|
|
5052
|
-
*/
|
|
5053
|
-
declare type ExtensionsEnabledEvent = ExtensionsEvent & {
|
|
5054
|
-
type: 'extensions-enabled';
|
|
5055
|
-
};
|
|
5056
|
-
|
|
5057
|
-
declare type ExtensionsEvent = SecurityRealmEvent & {
|
|
5058
|
-
/**
|
|
5059
|
-
* Runtime extensions whose status has been (possibly) modified
|
|
5060
|
-
*/
|
|
5061
|
-
extensions: string[];
|
|
5062
|
-
};
|
|
5063
|
-
|
|
5064
|
-
/**
|
|
5065
|
-
* An event that fires when requested extensions are not allowed to be installed in the security realm.
|
|
5066
|
-
*
|
|
5067
|
-
* @interface
|
|
5068
|
-
*/
|
|
5069
|
-
declare type ExtensionsExcludedEvent = ExtensionsEvent & {
|
|
5070
|
-
type: 'extensions-excluded';
|
|
5071
|
-
};
|
|
5072
|
-
|
|
5073
|
-
/**
|
|
5074
|
-
* An event that fires when extension initialization fails on initial app launch. Users may attempt to
|
|
5075
|
-
* re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
|
|
5076
|
-
* to manual extension refreshes (users should catch the error normally).
|
|
5077
|
-
*/
|
|
5078
|
-
declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
|
|
5079
|
-
type: 'extensions-initialization-failed';
|
|
5080
|
-
/**
|
|
5081
|
-
* The error that caused the extension initialization failure
|
|
5082
|
-
*/
|
|
5083
|
-
error: Error;
|
|
5084
|
-
};
|
|
5085
|
-
|
|
5086
|
-
/**
|
|
5087
|
-
* An event that fires when extensions are installed in the security realm.
|
|
5088
|
-
*
|
|
5089
|
-
* @interface
|
|
5090
|
-
*/
|
|
5091
|
-
declare type ExtensionsInstalledEvent = ExtensionsEvent & {
|
|
5092
|
-
type: 'extensions-installed';
|
|
5093
|
-
};
|
|
5094
|
-
|
|
5095
|
-
/**
|
|
5096
|
-
* An event that fires when extensions fail to install in the security realm.
|
|
5097
|
-
*
|
|
5098
|
-
* @interface
|
|
5099
|
-
*/
|
|
5100
|
-
declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
5101
|
-
type: 'extensions-install-failed';
|
|
5102
|
-
};
|
|
5103
|
-
|
|
5104
4947
|
/**
|
|
5105
4948
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
5106
4949
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
@@ -5161,7 +5004,7 @@ declare namespace ExternalApplicationEvents {
|
|
|
5161
5004
|
ExternalApplicationEvent,
|
|
5162
5005
|
EventType_4 as EventType,
|
|
5163
5006
|
ExternalApplicationEventType,
|
|
5164
|
-
|
|
5007
|
+
Payload_5 as Payload,
|
|
5165
5008
|
ByType_4 as ByType
|
|
5166
5009
|
}
|
|
5167
5010
|
}
|
|
@@ -5175,7 +5018,7 @@ declare type ExternalApplicationEventType = EventType_4;
|
|
|
5175
5018
|
* @interface
|
|
5176
5019
|
*/
|
|
5177
5020
|
declare type ExternalApplicationInfo = {
|
|
5178
|
-
parent:
|
|
5021
|
+
parent: Identity_5;
|
|
5179
5022
|
};
|
|
5180
5023
|
|
|
5181
5024
|
/**
|
|
@@ -5718,10 +5561,6 @@ declare type FileDownloadEvent = {
|
|
|
5718
5561
|
* The number of bytes of the item that have already been downloaded.
|
|
5719
5562
|
*/
|
|
5720
5563
|
downloadedBytes: number;
|
|
5721
|
-
/**
|
|
5722
|
-
* Unique identifier for the downloaded file.
|
|
5723
|
-
*/
|
|
5724
|
-
fileUuid: string;
|
|
5725
5564
|
} & NamedEvent;
|
|
5726
5565
|
|
|
5727
5566
|
/**
|
|
@@ -5958,7 +5797,7 @@ declare namespace FrameEvents {
|
|
|
5958
5797
|
FrameEvent,
|
|
5959
5798
|
EventType_5 as EventType,
|
|
5960
5799
|
FrameEventType,
|
|
5961
|
-
|
|
5800
|
+
Payload_6 as Payload,
|
|
5962
5801
|
ByType_5 as ByType
|
|
5963
5802
|
}
|
|
5964
5803
|
}
|
|
@@ -5976,7 +5815,7 @@ declare type FrameInfo = {
|
|
|
5976
5815
|
uuid: string;
|
|
5977
5816
|
url: string;
|
|
5978
5817
|
entityType: EntityType_4;
|
|
5979
|
-
parent:
|
|
5818
|
+
parent: Identity_5;
|
|
5980
5819
|
};
|
|
5981
5820
|
|
|
5982
5821
|
/**
|
|
@@ -6051,10 +5890,12 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
6051
5890
|
entityType: string;
|
|
6052
5891
|
};
|
|
6053
5892
|
|
|
5893
|
+
declare type GetLogRequestType = OpenFin.GetLogRequestType;
|
|
5894
|
+
|
|
6054
5895
|
/**
|
|
6055
5896
|
* @interface
|
|
6056
5897
|
*/
|
|
6057
|
-
declare type
|
|
5898
|
+
declare type GetLogRequestType_2 = {
|
|
6058
5899
|
/**
|
|
6059
5900
|
* The name of the running application
|
|
6060
5901
|
*/
|
|
@@ -6074,7 +5915,7 @@ declare type GetWindowContextPayload = {
|
|
|
6074
5915
|
/**
|
|
6075
5916
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
6076
5917
|
*/
|
|
6077
|
-
target:
|
|
5918
|
+
target: Identity_5;
|
|
6078
5919
|
};
|
|
6079
5920
|
|
|
6080
5921
|
/**
|
|
@@ -6199,7 +6040,7 @@ declare namespace GlobalHotkeyEvents {
|
|
|
6199
6040
|
GlobalHotkeyEvent,
|
|
6200
6041
|
EventType_6 as EventType,
|
|
6201
6042
|
GlobalHotkeyEventType,
|
|
6202
|
-
|
|
6043
|
+
Payload_7 as Payload,
|
|
6203
6044
|
ByType_6 as ByType
|
|
6204
6045
|
}
|
|
6205
6046
|
}
|
|
@@ -6343,6 +6184,8 @@ declare type Identity_2 = OpenFin.Identity;
|
|
|
6343
6184
|
|
|
6344
6185
|
declare type Identity_3 = OpenFin.Identity;
|
|
6345
6186
|
|
|
6187
|
+
declare type Identity_4 = OpenFin.Identity;
|
|
6188
|
+
|
|
6346
6189
|
/**
|
|
6347
6190
|
* Unique identifier for a window, view or iframe.
|
|
6348
6191
|
*
|
|
@@ -6351,7 +6194,7 @@ declare type Identity_3 = OpenFin.Identity;
|
|
|
6351
6194
|
*
|
|
6352
6195
|
* @interface
|
|
6353
6196
|
*/
|
|
6354
|
-
declare type
|
|
6197
|
+
declare type Identity_5 = {
|
|
6355
6198
|
/**
|
|
6356
6199
|
* Universally unique identifier of the application that owns the component.
|
|
6357
6200
|
*/
|
|
@@ -6513,10 +6356,12 @@ declare type InstallationInfo = {
|
|
|
6513
6356
|
cachedManifest: any;
|
|
6514
6357
|
};
|
|
6515
6358
|
|
|
6359
|
+
declare type InstalledApps = OpenFin.InstalledApps;
|
|
6360
|
+
|
|
6516
6361
|
/**
|
|
6517
6362
|
* @interface
|
|
6518
6363
|
*/
|
|
6519
|
-
declare type
|
|
6364
|
+
declare type InstalledApps_2 = {
|
|
6520
6365
|
[key: string]: InstallationInfo;
|
|
6521
6366
|
};
|
|
6522
6367
|
|
|
@@ -7302,7 +7147,7 @@ declare class InteropBroker extends Base {
|
|
|
7302
7147
|
* @param _id the identity tryinc to connect
|
|
7303
7148
|
* @param _connectionPayload optional payload to use in custom implementations, will be undefined by default
|
|
7304
7149
|
*/
|
|
7305
|
-
isConnectionAuthorized(_id:
|
|
7150
|
+
isConnectionAuthorized(_id: Identity_3, _connectionPayload?: any): Promise<boolean> | boolean;
|
|
7306
7151
|
/**
|
|
7307
7152
|
* Called before every action to check if this entity should be allowed to take the action.
|
|
7308
7153
|
* Return false to prevent the action
|
|
@@ -8234,7 +8079,7 @@ declare class Layout extends Base {
|
|
|
8234
8079
|
* await layout.replaceView(viewToReplace.identity, newViewConfig);
|
|
8235
8080
|
* ```
|
|
8236
8081
|
*/
|
|
8237
|
-
replaceView: (viewToReplace:
|
|
8082
|
+
replaceView: (viewToReplace: Identity_4, newView: OpenFin.PlatformViewCreationOptions) => Promise<void>;
|
|
8238
8083
|
/**
|
|
8239
8084
|
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
8240
8085
|
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
@@ -8289,7 +8134,7 @@ declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn |
|
|
|
8289
8134
|
/**
|
|
8290
8135
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
|
8291
8136
|
*/
|
|
8292
|
-
declare type LayoutDOMEvent =
|
|
8137
|
+
declare type LayoutDOMEvent = Identity_5 & {
|
|
8293
8138
|
type: string;
|
|
8294
8139
|
topic: 'openfin-DOM-event';
|
|
8295
8140
|
tabSelector: string;
|
|
@@ -8307,7 +8152,7 @@ declare namespace LayoutDOMEvents {
|
|
|
8307
8152
|
LayoutStateChangedEvent,
|
|
8308
8153
|
Event_12 as Event,
|
|
8309
8154
|
EventType_9 as EventType,
|
|
8310
|
-
|
|
8155
|
+
Payload_10 as Payload,
|
|
8311
8156
|
ByType_9 as ByType
|
|
8312
8157
|
}
|
|
8313
8158
|
}
|
|
@@ -8350,7 +8195,7 @@ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
|
|
|
8350
8195
|
/**
|
|
8351
8196
|
* @interface
|
|
8352
8197
|
*/
|
|
8353
|
-
declare type LayoutIdentity =
|
|
8198
|
+
declare type LayoutIdentity = Identity_5 & {
|
|
8354
8199
|
/**
|
|
8355
8200
|
* The name of the layout in a given window.
|
|
8356
8201
|
*/
|
|
@@ -8365,7 +8210,10 @@ declare type LayoutIdentity = Identity_4 & {
|
|
|
8365
8210
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8366
8211
|
type: 'layout-initialized';
|
|
8367
8212
|
layoutIdentity: OpenFin.LayoutIdentity;
|
|
8368
|
-
ofViews:
|
|
8213
|
+
ofViews: {
|
|
8214
|
+
identity: OpenFin.Identity;
|
|
8215
|
+
entityType: 'view';
|
|
8216
|
+
}[];
|
|
8369
8217
|
};
|
|
8370
8218
|
|
|
8371
8219
|
/**
|
|
@@ -8456,7 +8304,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8456
8304
|
* @param identity
|
|
8457
8305
|
* @returns LayoutIdentity | undefined
|
|
8458
8306
|
*/
|
|
8459
|
-
resolveLayoutIdentity(identity?:
|
|
8307
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
|
8460
8308
|
/**
|
|
8461
8309
|
* @experimental
|
|
8462
8310
|
*
|
|
@@ -8473,7 +8321,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8473
8321
|
/**
|
|
8474
8322
|
* @experimental
|
|
8475
8323
|
*/
|
|
8476
|
-
getLayoutIdentityForView(viewIdentity:
|
|
8324
|
+
getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
|
|
8477
8325
|
/**
|
|
8478
8326
|
* @experimental
|
|
8479
8327
|
*/
|
|
@@ -8947,10 +8795,12 @@ declare type Listener<T extends {
|
|
|
8947
8795
|
type: string;
|
|
8948
8796
|
}> = (payload: T) => void;
|
|
8949
8797
|
|
|
8798
|
+
declare type LogInfo = OpenFin.LogInfo;
|
|
8799
|
+
|
|
8950
8800
|
/**
|
|
8951
8801
|
* @interface
|
|
8952
8802
|
*/
|
|
8953
|
-
declare type
|
|
8803
|
+
declare type LogInfo_2 = {
|
|
8954
8804
|
/**
|
|
8955
8805
|
* The filename of the log
|
|
8956
8806
|
*/
|
|
@@ -8965,6 +8815,8 @@ declare type LogInfo = {
|
|
|
8965
8815
|
date: string;
|
|
8966
8816
|
};
|
|
8967
8817
|
|
|
8818
|
+
declare type LogLevel = OpenFin.LogLevel;
|
|
8819
|
+
|
|
8968
8820
|
/**
|
|
8969
8821
|
* Describes the minimum level (inclusive) above which logs will be written.
|
|
8970
8822
|
*
|
|
@@ -8974,7 +8826,7 @@ declare type LogInfo = {
|
|
|
8974
8826
|
* `error` and above<br>
|
|
8975
8827
|
* `fatal`: fatal only, indicates a crash is imminent
|
|
8976
8828
|
*/
|
|
8977
|
-
declare type
|
|
8829
|
+
declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
8978
8830
|
|
|
8979
8831
|
/**
|
|
8980
8832
|
* @interface
|
|
@@ -9363,16 +9215,6 @@ declare type MutableViewOptions = {
|
|
|
9363
9215
|
* Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
|
|
9364
9216
|
*/
|
|
9365
9217
|
_internalWorkspaceData: any;
|
|
9366
|
-
/**
|
|
9367
|
-
* {@inheritDoc ViewThrottling}
|
|
9368
|
-
*
|
|
9369
|
-
* @defaultValue 'enabled'
|
|
9370
|
-
*/
|
|
9371
|
-
throttling: ViewThrottling;
|
|
9372
|
-
/**
|
|
9373
|
-
* {@inheritDoc ChromiumPolicies}
|
|
9374
|
-
*/
|
|
9375
|
-
chromiumPolicies: ChromiumPolicies;
|
|
9376
9218
|
};
|
|
9377
9219
|
|
|
9378
9220
|
/**
|
|
@@ -9613,12 +9455,6 @@ declare type MutableWindowOptions = {
|
|
|
9613
9455
|
* Shows the window's icon in the taskbar.
|
|
9614
9456
|
*/
|
|
9615
9457
|
showTaskbarIcon: boolean;
|
|
9616
|
-
/**
|
|
9617
|
-
* Specify a taskbar group for the window.
|
|
9618
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
9619
|
-
* @remarks It's only updatable when `enableJumpList` is set to false.
|
|
9620
|
-
*/
|
|
9621
|
-
taskbarIconGroup: string;
|
|
9622
9458
|
interop: InteropConfig;
|
|
9623
9459
|
/**
|
|
9624
9460
|
* @internal
|
|
@@ -9630,18 +9466,6 @@ declare type MutableWindowOptions = {
|
|
|
9630
9466
|
* Used by workspace to stork platform specific options. Overwriting or modifying this field may impact the functionality of Workspace
|
|
9631
9467
|
*/
|
|
9632
9468
|
workspacePlatform: WorkspacePlatformOptions;
|
|
9633
|
-
/**
|
|
9634
|
-
* {@inheritDoc WindowThrottling}
|
|
9635
|
-
*
|
|
9636
|
-
* @defaultValue 'enabled'
|
|
9637
|
-
*
|
|
9638
|
-
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9639
|
-
*/
|
|
9640
|
-
throttling: WindowThrottling;
|
|
9641
|
-
/**
|
|
9642
|
-
* {@inheritDoc ChromiumPolicies}
|
|
9643
|
-
*/
|
|
9644
|
-
chromiumPolicies: ChromiumPolicies;
|
|
9645
9469
|
};
|
|
9646
9470
|
|
|
9647
9471
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
|
@@ -9683,42 +9507,10 @@ declare type NavigationRules = {
|
|
|
9683
9507
|
allowlist?: string[];
|
|
9684
9508
|
/** Forbidden URLs for navigation. */
|
|
9685
9509
|
denylist?: string[];
|
|
9686
|
-
/**
|
|
9687
|
-
* Options to use when comparing URIs to the `allowlist` and `denylist` patterns.
|
|
9688
|
-
*/
|
|
9689
|
-
matchOptions?: RuleMatchOptions;
|
|
9690
9510
|
};
|
|
9691
9511
|
|
|
9692
9512
|
declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
|
|
9693
9513
|
|
|
9694
|
-
declare interface NodeNetworkInterfaceBase {
|
|
9695
|
-
address: string;
|
|
9696
|
-
netmask: string;
|
|
9697
|
-
mac: string;
|
|
9698
|
-
internal: boolean;
|
|
9699
|
-
cidr: string | null;
|
|
9700
|
-
}
|
|
9701
|
-
|
|
9702
|
-
declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
|
|
9703
|
-
|
|
9704
|
-
declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
|
|
9705
|
-
family: 'IPv4';
|
|
9706
|
-
scopeid?: undefined;
|
|
9707
|
-
}
|
|
9708
|
-
|
|
9709
|
-
declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
|
|
9710
|
-
family: 'IPv6';
|
|
9711
|
-
scopeid: number;
|
|
9712
|
-
}
|
|
9713
|
-
|
|
9714
|
-
declare interface NodeUserInfo {
|
|
9715
|
-
username: string;
|
|
9716
|
-
uid: number;
|
|
9717
|
-
gid: number;
|
|
9718
|
-
shell: string | null;
|
|
9719
|
-
homedir: string;
|
|
9720
|
-
}
|
|
9721
|
-
|
|
9722
9514
|
/**
|
|
9723
9515
|
* @interface
|
|
9724
9516
|
*/
|
|
@@ -9820,19 +9612,18 @@ declare namespace OpenFin {
|
|
|
9820
9612
|
LayoutPosition,
|
|
9821
9613
|
WebContent,
|
|
9822
9614
|
PlatformProvider,
|
|
9823
|
-
ApplicationIdentity,
|
|
9824
|
-
|
|
9615
|
+
ApplicationIdentity_2 as ApplicationIdentity,
|
|
9616
|
+
Identity_5 as Identity,
|
|
9825
9617
|
ClientIdentity,
|
|
9826
9618
|
ClientInfo,
|
|
9827
9619
|
ClientIdentityMultiRuntime,
|
|
9828
9620
|
ClientConnectionPayload,
|
|
9829
|
-
EntityInfo,
|
|
9621
|
+
EntityInfo_2 as EntityInfo,
|
|
9830
9622
|
EntityType_4 as EntityType,
|
|
9831
9623
|
Bounds,
|
|
9832
9624
|
WindowBounds,
|
|
9833
9625
|
Rectangle,
|
|
9834
9626
|
ApplicationCreationOptions,
|
|
9835
|
-
TimeZones,
|
|
9836
9627
|
ApplicationOptions,
|
|
9837
9628
|
CustomProtocolMissingState,
|
|
9838
9629
|
CustomProtocolMalformedState,
|
|
@@ -9862,11 +9653,8 @@ declare namespace OpenFin {
|
|
|
9862
9653
|
ViewVisibilityOptions,
|
|
9863
9654
|
WindowState,
|
|
9864
9655
|
AutoplayPolicyOptions,
|
|
9865
|
-
ExcludeOptions,
|
|
9866
9656
|
ConstWindowOptions,
|
|
9867
9657
|
InheritableOptions,
|
|
9868
|
-
PolicyOptions,
|
|
9869
|
-
ChromiumPolicies,
|
|
9870
9658
|
MutableWindowOptions,
|
|
9871
9659
|
WorkspacePlatformOptions,
|
|
9872
9660
|
WebRequestHeader,
|
|
@@ -9877,7 +9665,6 @@ declare namespace OpenFin {
|
|
|
9877
9665
|
Api,
|
|
9878
9666
|
ApiSettings,
|
|
9879
9667
|
InjectionType,
|
|
9880
|
-
RuleMatchOptions,
|
|
9881
9668
|
NavigationRules,
|
|
9882
9669
|
ContentNavigation,
|
|
9883
9670
|
ContentRedirect,
|
|
@@ -9892,17 +9679,12 @@ declare namespace OpenFin {
|
|
|
9892
9679
|
AutoResizeOptions,
|
|
9893
9680
|
InteropConfig,
|
|
9894
9681
|
ViewInfo,
|
|
9895
|
-
WindowThrottling,
|
|
9896
|
-
ViewThrottling,
|
|
9897
9682
|
UpdatableViewOptions,
|
|
9898
9683
|
ViewCreationOptions,
|
|
9899
9684
|
MutableViewOptions,
|
|
9900
9685
|
ViewOptions,
|
|
9901
9686
|
ConstViewOptions,
|
|
9902
9687
|
ViewState,
|
|
9903
|
-
ViewCreationSuccess,
|
|
9904
|
-
ViewCreationFailure,
|
|
9905
|
-
ViewCreationResult,
|
|
9906
9688
|
Certificate,
|
|
9907
9689
|
HostContextChangedPayload,
|
|
9908
9690
|
ApplySnapshotOptions,
|
|
@@ -9964,9 +9746,8 @@ declare namespace OpenFin {
|
|
|
9964
9746
|
Time,
|
|
9965
9747
|
CpuInfo,
|
|
9966
9748
|
GpuInfo,
|
|
9967
|
-
OSInfo,
|
|
9968
9749
|
HostSpecs,
|
|
9969
|
-
PrinterInfo,
|
|
9750
|
+
PrinterInfo_2 as PrinterInfo,
|
|
9970
9751
|
Dpi,
|
|
9971
9752
|
Margins,
|
|
9972
9753
|
PrintOptions,
|
|
@@ -10074,24 +9855,24 @@ declare namespace OpenFin {
|
|
|
10074
9855
|
BeforeUnloadUserDecision,
|
|
10075
9856
|
ViewStatuses,
|
|
10076
9857
|
CloseWindowPayload,
|
|
10077
|
-
ProxyInfo,
|
|
10078
|
-
ProxyConfig,
|
|
9858
|
+
ProxyInfo_2 as ProxyInfo,
|
|
9859
|
+
ProxyConfig_2 as ProxyConfig,
|
|
10079
9860
|
ProxySystemInfo,
|
|
10080
9861
|
ChannelAction_2 as ChannelAction,
|
|
10081
9862
|
ChannelMiddleware_2 as ChannelMiddleware,
|
|
10082
9863
|
ErrorMiddleware_2 as ErrorMiddleware,
|
|
10083
|
-
ApplicationState,
|
|
10084
|
-
InstalledApps,
|
|
9864
|
+
ApplicationState_2 as ApplicationState,
|
|
9865
|
+
InstalledApps_2 as InstalledApps,
|
|
10085
9866
|
InstallationInfo,
|
|
10086
|
-
GetLogRequestType,
|
|
10087
|
-
LogInfo,
|
|
9867
|
+
GetLogRequestType_2 as GetLogRequestType,
|
|
9868
|
+
LogInfo_2 as LogInfo,
|
|
10088
9869
|
SendApplicationLogResponse,
|
|
10089
|
-
LogLevel,
|
|
9870
|
+
LogLevel_2 as LogLevel,
|
|
10090
9871
|
PermissionState_2 as PermissionState,
|
|
10091
|
-
RegistryInfo,
|
|
9872
|
+
RegistryInfo_2 as RegistryInfo,
|
|
10092
9873
|
ApplicationType,
|
|
10093
9874
|
WindowInfo,
|
|
10094
|
-
ApplicationWindowInfo,
|
|
9875
|
+
ApplicationWindowInfo_2 as ApplicationWindowInfo,
|
|
10095
9876
|
WindowDetail,
|
|
10096
9877
|
LayoutPresetType,
|
|
10097
9878
|
LayoutIdentity,
|
|
@@ -10145,8 +9926,6 @@ declare namespace OpenFin {
|
|
|
10145
9926
|
ChannelProviderDisconnectionListener,
|
|
10146
9927
|
RoutingInfo,
|
|
10147
9928
|
DownloadShelfOptions,
|
|
10148
|
-
ViewShowAtOptions,
|
|
10149
|
-
ExtensionInfo,
|
|
10150
9929
|
ApplicationEvents,
|
|
10151
9930
|
BaseEvents,
|
|
10152
9931
|
ExternalApplicationEvents,
|
|
@@ -10173,25 +9952,6 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
|
|
|
10173
9952
|
diff: OpenFin.WindowOptionDiff;
|
|
10174
9953
|
};
|
|
10175
9954
|
|
|
10176
|
-
/**
|
|
10177
|
-
* @interface
|
|
10178
|
-
* The keys represent the output from calling individual Node `os` APIs.
|
|
10179
|
-
* For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
|
|
10180
|
-
* see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
|
|
10181
|
-
*/
|
|
10182
|
-
declare type OSInfo = {
|
|
10183
|
-
platform: string;
|
|
10184
|
-
release: string;
|
|
10185
|
-
version: string;
|
|
10186
|
-
/**
|
|
10187
|
-
* Throws if a user has no username or homedir.
|
|
10188
|
-
* See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
|
|
10189
|
-
*/
|
|
10190
|
-
userInfo: NodeUserInfo;
|
|
10191
|
-
hostname: string;
|
|
10192
|
-
networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
|
|
10193
|
-
};
|
|
10194
|
-
|
|
10195
9955
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
10196
9956
|
|
|
10197
9957
|
/**
|
|
@@ -10220,110 +9980,86 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
10220
9980
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
|
10221
9981
|
};
|
|
10222
9982
|
|
|
10223
|
-
/**
|
|
10224
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10225
|
-
*
|
|
10226
|
-
* @see {@link ByType}
|
|
10227
|
-
*
|
|
10228
|
-
* @typeParam Type String key specifying the event to extract
|
|
10229
|
-
*/
|
|
10230
|
-
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
|
10231
|
-
|
|
10232
9983
|
/**
|
|
10233
9984
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
|
10234
9985
|
*
|
|
10235
9986
|
* @typeParam Type String key specifying the event to extract
|
|
10236
9987
|
*/
|
|
10237
|
-
declare type
|
|
9988
|
+
declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
|
|
10238
9989
|
type: Type;
|
|
10239
9990
|
}>;
|
|
10240
9991
|
|
|
10241
|
-
/**
|
|
10242
|
-
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
|
10243
|
-
*
|
|
10244
|
-
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
|
10245
|
-
* the appropriate payload union for that namespace.
|
|
10246
|
-
*
|
|
10247
|
-
* @typeParam Event Union of payloads for events on the given emitter
|
|
10248
|
-
* @see {@link ByType}
|
|
10249
|
-
*
|
|
10250
|
-
* @typeParam Type String key specifying the event to extract from the union
|
|
10251
|
-
*
|
|
10252
|
-
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
|
10253
|
-
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
|
10254
|
-
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
|
10255
|
-
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
|
10256
|
-
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
|
10257
|
-
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
|
10258
|
-
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
|
10259
|
-
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
|
10260
|
-
*/
|
|
10261
|
-
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
|
10262
|
-
type: EventType;
|
|
10263
|
-
}>;
|
|
10264
|
-
|
|
10265
9992
|
/**
|
|
10266
9993
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
10267
9994
|
*
|
|
10268
|
-
* @see {@link ByType}
|
|
10269
|
-
*
|
|
10270
9995
|
* @typeParam Type String key specifying the event to extract
|
|
10271
9996
|
*/
|
|
10272
|
-
declare type
|
|
9997
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
|
9998
|
+
type: Type;
|
|
9999
|
+
}>;
|
|
10273
10000
|
|
|
10274
10001
|
/**
|
|
10275
10002
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
10276
10003
|
*
|
|
10277
|
-
* @see {@link ByType}
|
|
10278
|
-
*
|
|
10279
10004
|
* @typeParam Type String key specifying the event to extract
|
|
10280
10005
|
*/
|
|
10281
|
-
declare type
|
|
10006
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
|
10007
|
+
type: Type;
|
|
10008
|
+
}>;
|
|
10282
10009
|
|
|
10283
10010
|
/**
|
|
10284
10011
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
10285
10012
|
*
|
|
10286
|
-
* @see {@link ByType}
|
|
10287
|
-
*
|
|
10288
10013
|
* @typeParam Type String key specifying the event to extract
|
|
10289
10014
|
*/
|
|
10290
|
-
declare type
|
|
10015
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
|
10016
|
+
type: Type;
|
|
10017
|
+
}>;
|
|
10291
10018
|
|
|
10292
10019
|
/**
|
|
10293
10020
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
10294
10021
|
*
|
|
10295
|
-
* @see {@link ByType}
|
|
10296
|
-
*
|
|
10297
10022
|
* @typeParam Type String key specifying the event to extract
|
|
10298
10023
|
*/
|
|
10299
|
-
declare type
|
|
10024
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
|
10025
|
+
type: Type;
|
|
10026
|
+
}>;
|
|
10300
10027
|
|
|
10301
10028
|
/**
|
|
10302
10029
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
10303
10030
|
*
|
|
10304
|
-
* @see {@link ByType}
|
|
10305
|
-
*
|
|
10306
10031
|
* @typeParam Type String key specifying the event to extract
|
|
10307
10032
|
*/
|
|
10308
|
-
declare type
|
|
10033
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
|
10034
|
+
type: Type;
|
|
10035
|
+
}>;
|
|
10309
10036
|
|
|
10310
10037
|
/**
|
|
10311
10038
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
10312
10039
|
*
|
|
10313
|
-
* @see {@link ByType}
|
|
10314
|
-
*
|
|
10315
10040
|
* @typeParam Type String key specifying the event to extract
|
|
10316
10041
|
*/
|
|
10317
|
-
declare type
|
|
10042
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
|
10043
|
+
type: Type;
|
|
10044
|
+
}>;
|
|
10318
10045
|
|
|
10319
10046
|
/**
|
|
10320
10047
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
10321
10048
|
*
|
|
10322
|
-
* @
|
|
10049
|
+
* @typeParam Type String key specifying the event to extract
|
|
10050
|
+
*/
|
|
10051
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
10052
|
+
type: Type;
|
|
10053
|
+
}>;
|
|
10054
|
+
|
|
10055
|
+
/**
|
|
10056
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10323
10057
|
*
|
|
10324
10058
|
* @typeParam Type String key specifying the event to extract
|
|
10325
10059
|
*/
|
|
10326
|
-
declare type Payload_9<Type extends
|
|
10060
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
|
10061
|
+
type: Type;
|
|
10062
|
+
}>;
|
|
10327
10063
|
|
|
10328
10064
|
/**
|
|
10329
10065
|
* @interface
|
|
@@ -10348,10 +10084,6 @@ declare type PerDomainSettings = {
|
|
|
10348
10084
|
* {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
|
|
10349
10085
|
*/
|
|
10350
10086
|
content?: ContentPermission;
|
|
10351
|
-
/**
|
|
10352
|
-
* {@inheritdoc ChromiumPolicies}
|
|
10353
|
-
*/
|
|
10354
|
-
chromiumPolicies?: ChromiumPolicies;
|
|
10355
10087
|
};
|
|
10356
10088
|
|
|
10357
10089
|
/**
|
|
@@ -11052,7 +10784,7 @@ declare namespace PlatformEvents {
|
|
|
11052
10784
|
PlatformEvent,
|
|
11053
10785
|
EventType_7 as EventType,
|
|
11054
10786
|
PlatformEventType,
|
|
11055
|
-
|
|
10787
|
+
Payload_8 as Payload,
|
|
11056
10788
|
ByType_7 as ByType
|
|
11057
10789
|
}
|
|
11058
10790
|
}
|
|
@@ -11784,45 +11516,6 @@ declare interface PlatformProvider {
|
|
|
11784
11516
|
* @returns {Promise<void>}
|
|
11785
11517
|
*/
|
|
11786
11518
|
handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
|
|
11787
|
-
/**
|
|
11788
|
-
* @experimental
|
|
11789
|
-
*
|
|
11790
|
-
* This method is called to handle errors with view creation and initial navigation during layout creation.
|
|
11791
|
-
* Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
|
|
11792
|
-
* * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
|
|
11793
|
-
* * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
|
|
11794
|
-
* * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
|
|
11795
|
-
*
|
|
11796
|
-
* @param viewIdentity Identity of the view
|
|
11797
|
-
* @param error error thrown during a view creation
|
|
11798
|
-
* @returns {Promise<OpenFin.ViewCreationSuccess | void>}
|
|
11799
|
-
*
|
|
11800
|
-
* @example
|
|
11801
|
-
*
|
|
11802
|
-
* ```js
|
|
11803
|
-
* const overrideCallback = (PlatformProvider) => {
|
|
11804
|
-
* class Override extends PlatformProvider {
|
|
11805
|
-
* async handleFailedViewCreation(viewIdentity, error) {
|
|
11806
|
-
* const view = fin.View.wrapSync(viewId);
|
|
11807
|
-
* try {
|
|
11808
|
-
* // navigate to an error page
|
|
11809
|
-
* await view.navigate('http://localhost:3000/errorPage.html');
|
|
11810
|
-
* // resolve a success result after redirecting to a error page
|
|
11811
|
-
* return {identity: viewIdentity, success: true};
|
|
11812
|
-
* } catch(e) {
|
|
11813
|
-
* // layout-initialized event will include this view with the error
|
|
11814
|
-
* throw error;
|
|
11815
|
-
* }
|
|
11816
|
-
* }
|
|
11817
|
-
* }
|
|
11818
|
-
* return new Override();
|
|
11819
|
-
* }
|
|
11820
|
-
*
|
|
11821
|
-
* fin.Platform.init({ overrideCallback });
|
|
11822
|
-
*
|
|
11823
|
-
* ```
|
|
11824
|
-
*/
|
|
11825
|
-
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
11826
11519
|
}
|
|
11827
11520
|
|
|
11828
11521
|
/**
|
|
@@ -11887,12 +11580,6 @@ declare type PointTopLeft = {
|
|
|
11887
11580
|
left: number;
|
|
11888
11581
|
};
|
|
11889
11582
|
|
|
11890
|
-
/**
|
|
11891
|
-
* When set to `disable`, disables the policy
|
|
11892
|
-
* When set to `defer-to-group-policy`, respects Group Policy settings
|
|
11893
|
-
*/
|
|
11894
|
-
declare type PolicyOptions = 'disable' | 'defer-to-group-policy';
|
|
11895
|
-
|
|
11896
11583
|
declare type PopupBaseBehavior = 'close' | 'hide';
|
|
11897
11584
|
|
|
11898
11585
|
declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
|
|
@@ -12128,10 +11815,12 @@ declare type PresetLayoutOptions_2 = {
|
|
|
12128
11815
|
presetType: LayoutPresetType;
|
|
12129
11816
|
};
|
|
12130
11817
|
|
|
11818
|
+
declare type PrinterInfo = OpenFin.PrinterInfo;
|
|
11819
|
+
|
|
12131
11820
|
/**
|
|
12132
11821
|
* @interface
|
|
12133
11822
|
*/
|
|
12134
|
-
declare type
|
|
11823
|
+
declare type PrinterInfo_2 = {
|
|
12135
11824
|
/**
|
|
12136
11825
|
* Printer Name
|
|
12137
11826
|
*/
|
|
@@ -12393,100 +12082,20 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
12393
12082
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12394
12083
|
|
|
12395
12084
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
12396
|
-
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12397
|
-
'destroy-application': ApplicationIdentityCall<{
|
|
12398
|
-
force: boolean;
|
|
12399
|
-
}, void>;
|
|
12400
|
-
'close-application': ApplicationIdentityCall<{
|
|
12401
|
-
force: boolean;
|
|
12402
|
-
}, void>;
|
|
12403
|
-
'application-close': ApplicationIdentityCall<{}, void>;
|
|
12404
|
-
'get-child-windows': ApplicationIdentityCall<{}, Array<unknown>>;
|
|
12405
|
-
'get-application-manifest': {
|
|
12406
|
-
request: {
|
|
12407
|
-
manifestUrl?: string;
|
|
12408
|
-
uuid?: string;
|
|
12409
|
-
};
|
|
12410
|
-
response: OpenFin.Manifest;
|
|
12411
|
-
};
|
|
12412
|
-
'get-parent-application': ApplicationIdentityCall<{}, string>;
|
|
12413
|
-
'get-shortcuts': ApplicationIdentityCall<{}, OpenFin.ShortCutConfig>;
|
|
12414
|
-
'application-get-views': ApplicationIdentityCall<{}, OpenFin.Identity[]>;
|
|
12415
|
-
'get-application-zoom-level': ApplicationIdentityCall<{}, number>;
|
|
12416
|
-
'application-get-window': ApplicationIdentityCall<{}, void>;
|
|
12417
|
-
'register-user': ApplicationIdentityCall<{
|
|
12418
|
-
userName: string;
|
|
12419
|
-
appName: string;
|
|
12420
|
-
}, void>;
|
|
12421
|
-
'remove-tray-icon': ApplicationIdentityCall<{}, void>;
|
|
12422
|
-
'restart-application': ApplicationIdentityCall<{}, void>;
|
|
12423
|
-
'application-run': ApplicationIdentityCall<{}, void>;
|
|
12424
|
-
'run-application': ApplicationIdentityCall<{
|
|
12425
|
-
manifestUrl?: string | undefined;
|
|
12426
|
-
opts?: OpenFin.RvmLaunchOptions;
|
|
12427
|
-
}, void>;
|
|
12428
|
-
'relaunch-on-close': ApplicationIdentityCall<{}, void>;
|
|
12429
|
-
'send-application-log': ApplicationIdentityCall<{}, OpenFin.SendApplicationLogResponse>;
|
|
12430
|
-
'set-jump-list': ApplicationIdentityCall<{
|
|
12431
|
-
config: OpenFin.JumpListCategory[] | null;
|
|
12432
|
-
}, void>;
|
|
12433
|
-
'set-tray-icon': ApplicationIdentityCall<{
|
|
12434
|
-
enabledIcon: string;
|
|
12435
|
-
}, void>;
|
|
12436
|
-
'set-shortcuts': ApplicationIdentityCall<{
|
|
12437
|
-
data: OpenFin.ShortCutConfig;
|
|
12438
|
-
}, void>;
|
|
12439
|
-
'set-shortcut-query-args': ApplicationIdentityCall<{
|
|
12440
|
-
data: string;
|
|
12441
|
-
}, void>;
|
|
12442
|
-
'set-application-zoom-level': ApplicationIdentityCall<{
|
|
12443
|
-
level: number;
|
|
12444
|
-
}, void>;
|
|
12445
|
-
'set-app-log-username': ApplicationIdentityCall<{
|
|
12446
|
-
data: string;
|
|
12447
|
-
}, void>;
|
|
12448
|
-
'get-tray-icon-info': ApplicationIdentityCall<{}, OpenFin.TrayInfo>;
|
|
12449
|
-
'has-tray-icon': ApplicationIdentityCall<{}, boolean>;
|
|
12450
|
-
'terminate-application': ApplicationIdentityCall<{}, void>;
|
|
12451
|
-
'wait-for-hung-application': ApplicationIdentityCall<{}, void>;
|
|
12452
|
-
'get-info': ApplicationIdentityCall<{}, OpenFin.ApplicationInfo>;
|
|
12453
|
-
'application-get-process-info': ApplicationIdentityCall<{}, OpenFin.AppProcessInfo>;
|
|
12454
|
-
'set-file-download-location': {
|
|
12455
|
-
request: OpenFin.Identity & {
|
|
12456
|
-
downloadLocation: string;
|
|
12457
|
-
};
|
|
12458
|
-
response: void;
|
|
12459
|
-
};
|
|
12460
|
-
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12461
|
-
'show-tray-icon-popup-menu': {
|
|
12462
|
-
request: OpenFin.Identity & {
|
|
12463
|
-
options: OpenFin.ShowTrayIconPopupMenuOptions;
|
|
12464
|
-
};
|
|
12465
|
-
response: OpenFin.MenuResult;
|
|
12466
|
-
};
|
|
12467
|
-
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12468
|
-
'wrap-application': VoidCall;
|
|
12469
|
-
'wrap-application-sync': VoidCall;
|
|
12470
|
-
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
12471
|
-
'application-create': VoidCall;
|
|
12472
|
-
'start-application': VoidCall;
|
|
12473
|
-
'run-applications': ApiCall<{
|
|
12474
|
-
applications: Array<OpenFin.ManifestInfo>;
|
|
12475
|
-
opts?: OpenFin.RvmLaunchOptions;
|
|
12476
|
-
}, void>;
|
|
12477
|
-
'get-current-application': VoidCall;
|
|
12478
|
-
'get-current-application-sync': VoidCall;
|
|
12479
|
-
'application-start-from-manifest': VoidCall;
|
|
12480
|
-
'application-create-from-manifest': VoidCall;
|
|
12481
12085
|
'request-external-authorization': {
|
|
12482
12086
|
request: any;
|
|
12483
12087
|
response: void;
|
|
12484
12088
|
specialResponse: AuthorizationPayload;
|
|
12485
12089
|
};
|
|
12486
|
-
'
|
|
12487
|
-
request:
|
|
12090
|
+
'application-get-views': {
|
|
12091
|
+
request: OpenFin.ApplicationIdentity;
|
|
12092
|
+
response: OpenFin.Identity[];
|
|
12093
|
+
};
|
|
12094
|
+
'set-jump-list': {
|
|
12095
|
+
request: {
|
|
12096
|
+
config: OpenFin.JumpListCategory[] | null;
|
|
12097
|
+
} & OpenFin.ApplicationIdentity;
|
|
12488
12098
|
response: void;
|
|
12489
|
-
specialResponse: Payload;
|
|
12490
12099
|
};
|
|
12491
12100
|
'clipboard-read-formats': {
|
|
12492
12101
|
request: {
|
|
@@ -12498,24 +12107,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12498
12107
|
request: OpenFin.ReadImageClipboardRequest;
|
|
12499
12108
|
response: string;
|
|
12500
12109
|
};
|
|
12501
|
-
'clipboard-read-text': {
|
|
12502
|
-
request: {
|
|
12503
|
-
type?: OpenFin.ClipboardSelectionType;
|
|
12504
|
-
};
|
|
12505
|
-
response: string;
|
|
12506
|
-
};
|
|
12507
|
-
'clipboard-read-html': {
|
|
12508
|
-
request: {
|
|
12509
|
-
type?: OpenFin.ClipboardSelectionType;
|
|
12510
|
-
};
|
|
12511
|
-
response: string;
|
|
12512
|
-
};
|
|
12513
|
-
'clipboard-read-rtf': {
|
|
12514
|
-
request: {
|
|
12515
|
-
type?: OpenFin.ClipboardSelectionType;
|
|
12516
|
-
};
|
|
12517
|
-
response: string;
|
|
12518
|
-
};
|
|
12519
12110
|
'clipboard-write-image': {
|
|
12520
12111
|
request: OpenFin.WriteImageClipboardRequest;
|
|
12521
12112
|
response: void;
|
|
@@ -12524,18 +12115,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12524
12115
|
request: OpenFin.WriteAnyRequestType;
|
|
12525
12116
|
response: void;
|
|
12526
12117
|
};
|
|
12527
|
-
'clipboard-write-text': {
|
|
12528
|
-
request: OpenFin.WriteClipboardRequest;
|
|
12529
|
-
response: void;
|
|
12530
|
-
};
|
|
12531
|
-
'clipboard-write-html': {
|
|
12532
|
-
request: OpenFin.WriteClipboardRequest;
|
|
12533
|
-
response: void;
|
|
12534
|
-
};
|
|
12535
|
-
'clipboard-write-rtf': {
|
|
12536
|
-
request: OpenFin.WriteClipboardRequest;
|
|
12537
|
-
response: void;
|
|
12538
|
-
};
|
|
12539
12118
|
'get-view-window': IdentityCall<{}, OpenFin.Identity>;
|
|
12540
12119
|
'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
|
|
12541
12120
|
uuid: string;
|
|
@@ -12552,94 +12131,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12552
12131
|
'get-view-options': IdentityCall<{}, OpenFin.ViewOptions>;
|
|
12553
12132
|
'hide-view': IdentityCall;
|
|
12554
12133
|
'show-view': IdentityCall;
|
|
12555
|
-
'show-view-at': IdentityCall<{
|
|
12556
|
-
bounds: OpenFin.Bounds;
|
|
12557
|
-
options?: OpenFin.ViewShowAtOptions;
|
|
12558
|
-
}>;
|
|
12559
|
-
'bring-view-to-front': IdentityCall;
|
|
12560
12134
|
'update-view-options': IdentityCall<{
|
|
12561
12135
|
options: OpenFin.UpdatableViewOptions;
|
|
12562
12136
|
}>;
|
|
12563
12137
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12564
|
-
'view-wrap-sync': VoidCall;
|
|
12565
|
-
'view-wrap': VoidCall;
|
|
12566
|
-
'view-get-current': VoidCall;
|
|
12567
|
-
'view-get-current-sync': VoidCall;
|
|
12568
|
-
'animate-window': IdentityCall<{
|
|
12569
|
-
transitions: OpenFin.Transition;
|
|
12570
|
-
options: OpenFin.TransitionOptions;
|
|
12571
|
-
}>;
|
|
12572
|
-
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12573
|
-
'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
|
|
12574
|
-
'center-window': IdentityCall;
|
|
12575
|
-
'blur-window': IdentityCall;
|
|
12576
|
-
'bring-window-to-front': IdentityCall;
|
|
12577
|
-
'hide-window': IdentityCall;
|
|
12578
|
-
'close-window': IdentityCall<{
|
|
12579
|
-
force: boolean;
|
|
12580
|
-
}>;
|
|
12581
|
-
'focused-webview-changed': IdentityCall;
|
|
12582
|
-
'get-window-native-id': IdentityCall<{}, string>;
|
|
12583
12138
|
'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
|
|
12584
|
-
'
|
|
12585
|
-
'enable-window-frame': IdentityCall;
|
|
12586
|
-
'flash-window': IdentityCall;
|
|
12587
|
-
'stop-flash-window': IdentityCall;
|
|
12588
|
-
'get-window-info': IdentityCall<{}, OpenFin.WindowInfo>;
|
|
12589
|
-
'get-window-options': IdentityCall<{}, OpenFin.WindowOptions>;
|
|
12590
|
-
'get-window-snapshot': IdentityCall<{
|
|
12591
|
-
area?: OpenFin.Rectangle;
|
|
12592
|
-
}, string>;
|
|
12593
|
-
'get-window-state': IdentityCall<{}, 'minimized' | 'maximized' | 'normal'>;
|
|
12594
|
-
'is-window-showing': IdentityCall<{}, boolean>;
|
|
12595
|
-
'maximize-window': IdentityCall;
|
|
12596
|
-
'minimize-window': IdentityCall;
|
|
12597
|
-
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12598
|
-
deltaLeft: number;
|
|
12599
|
-
deltaTop: number;
|
|
12600
|
-
}>>;
|
|
12601
|
-
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12602
|
-
left: number;
|
|
12603
|
-
top: number;
|
|
12604
|
-
}>>;
|
|
12605
|
-
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12606
|
-
deltaWidth: number;
|
|
12607
|
-
deltaHeight: number;
|
|
12608
|
-
anchor: OpenFin.AnchorType;
|
|
12609
|
-
}>>;
|
|
12610
|
-
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12611
|
-
width: number;
|
|
12612
|
-
height: number;
|
|
12613
|
-
anchor: OpenFin.AnchorType;
|
|
12614
|
-
}>>;
|
|
12615
|
-
'restore-window': IdentityCall;
|
|
12616
|
-
'set-foreground-window': IdentityCall;
|
|
12617
|
-
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12618
|
-
'show-window': IdentityCall<{
|
|
12619
|
-
force: boolean;
|
|
12620
|
-
}>;
|
|
12621
|
-
'show-at-window': IdentityCall<{
|
|
12622
|
-
left: number;
|
|
12623
|
-
top: number;
|
|
12624
|
-
force: boolean;
|
|
12625
|
-
}>;
|
|
12626
|
-
'update-window-options': IdentityCall<{
|
|
12627
|
-
options: OpenFin.UpdatableWindowOptions;
|
|
12628
|
-
}>;
|
|
12629
|
-
'window-authenticate': IdentityCall<{
|
|
12630
|
-
userName: string;
|
|
12631
|
-
password: string;
|
|
12632
|
-
}>;
|
|
12633
|
-
'show-popup-menu': {
|
|
12139
|
+
'print': {
|
|
12634
12140
|
request: OpenFin.Identity & {
|
|
12635
|
-
options: OpenFin.
|
|
12141
|
+
options: OpenFin.PrintOptions;
|
|
12636
12142
|
};
|
|
12637
|
-
response:
|
|
12143
|
+
response: void;
|
|
12638
12144
|
};
|
|
12639
|
-
'close-popup-menu': IdentityCall;
|
|
12640
|
-
'dispatch-popup-result': IdentityCall<{
|
|
12641
|
-
data: any;
|
|
12642
|
-
}>;
|
|
12643
12145
|
'print-screenshot': {
|
|
12644
12146
|
request: OpenFin.Identity;
|
|
12645
12147
|
response: void;
|
|
@@ -12650,232 +12152,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12650
12152
|
};
|
|
12651
12153
|
response: void;
|
|
12652
12154
|
};
|
|
12653
|
-
'window-wrap': VoidCall;
|
|
12654
|
-
'window-wrap-sync': VoidCall;
|
|
12655
|
-
'create-window': VoidCall;
|
|
12656
|
-
'get-current-window': VoidCall;
|
|
12657
|
-
'get-current-window-sync': VoidCall;
|
|
12658
|
-
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
12659
|
-
'external-application-wrap': VoidCall;
|
|
12660
|
-
'external-application-wrap-sync': VoidCall;
|
|
12661
|
-
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12662
|
-
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12663
|
-
'frame-wrap': VoidCall;
|
|
12664
|
-
'frame-wrap-sync': VoidCall;
|
|
12665
|
-
'frame-get-current': VoidCall;
|
|
12666
|
-
'frame-get-current-sync': VoidCall;
|
|
12667
|
-
'global-hotkey-register': {
|
|
12668
|
-
request: {
|
|
12669
|
-
hotkey: string;
|
|
12670
|
-
};
|
|
12671
|
-
response: void;
|
|
12672
|
-
};
|
|
12673
|
-
'global-hotkey-unregister': {
|
|
12674
|
-
request: {
|
|
12675
|
-
hotkey: string;
|
|
12676
|
-
};
|
|
12677
|
-
response: void;
|
|
12678
|
-
};
|
|
12679
|
-
'global-hotkey-unregister-all': {
|
|
12680
|
-
request: {};
|
|
12681
|
-
response: void;
|
|
12682
|
-
};
|
|
12683
|
-
'global-hotkey-is-registered': {
|
|
12684
|
-
request: {
|
|
12685
|
-
hotkey: string;
|
|
12686
|
-
};
|
|
12687
|
-
response: boolean;
|
|
12688
|
-
};
|
|
12689
|
-
'publish-message': {
|
|
12690
|
-
request: {
|
|
12691
|
-
topic: string;
|
|
12692
|
-
message: any;
|
|
12693
|
-
sourceWindowName: string;
|
|
12694
|
-
};
|
|
12695
|
-
response: void;
|
|
12696
|
-
};
|
|
12697
|
-
'send-message': {
|
|
12698
|
-
request: {
|
|
12699
|
-
destinationUuid: string;
|
|
12700
|
-
destinationWindowName: string | undefined;
|
|
12701
|
-
topic: string;
|
|
12702
|
-
message: any;
|
|
12703
|
-
sourceWindowName: string;
|
|
12704
|
-
};
|
|
12705
|
-
response: void;
|
|
12706
|
-
};
|
|
12707
|
-
'subscribe': {
|
|
12708
|
-
request: {
|
|
12709
|
-
sourceUuid: string;
|
|
12710
|
-
sourceWindowName: string;
|
|
12711
|
-
topic: string;
|
|
12712
|
-
destinationWindowName: string;
|
|
12713
|
-
messageKey?: any;
|
|
12714
|
-
};
|
|
12715
|
-
response: void;
|
|
12716
|
-
};
|
|
12717
|
-
'unsubscribe': {
|
|
12718
|
-
request: {
|
|
12719
|
-
sourceUuid: string;
|
|
12720
|
-
sourceWindowName: string;
|
|
12721
|
-
topic: string;
|
|
12722
|
-
destinationWindowName: string;
|
|
12723
|
-
};
|
|
12724
|
-
response: void;
|
|
12725
|
-
};
|
|
12726
|
-
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
12727
|
-
'connect-to-channel': {
|
|
12728
|
-
request: any;
|
|
12729
|
-
response: OpenFin.RoutingInfo;
|
|
12730
|
-
};
|
|
12731
|
-
'create-channel': ApiCall<{
|
|
12732
|
-
channelName: string;
|
|
12733
|
-
}, OpenFin.ProviderIdentity>;
|
|
12734
|
-
'destroy-channel': ApiCall<{
|
|
12735
|
-
channelName: string;
|
|
12736
|
-
}, void>;
|
|
12737
|
-
'disconnect-from-channel': {
|
|
12738
|
-
request: {
|
|
12739
|
-
channelName: string;
|
|
12740
|
-
uuid: string;
|
|
12741
|
-
name: string;
|
|
12742
|
-
endpointId: string;
|
|
12743
|
-
};
|
|
12744
|
-
response: void;
|
|
12745
|
-
};
|
|
12746
|
-
'send-channel-message': {
|
|
12747
|
-
request: any;
|
|
12748
|
-
response: any;
|
|
12749
|
-
};
|
|
12750
|
-
'get-version': GetterCall<string>;
|
|
12751
|
-
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
12752
|
-
'delete-cache-request': VoidCall;
|
|
12753
|
-
'exit-desktop': VoidCall;
|
|
12754
|
-
'fetch-manifest': ApiCall<{
|
|
12755
|
-
manifestUrl: string;
|
|
12756
|
-
}, any>;
|
|
12757
|
-
'flush-cookie-store': VoidCall;
|
|
12758
|
-
'get-all-windows': GetterCall<OpenFin.ApplicationWindowInfo[]>;
|
|
12759
|
-
'get-all-applications': GetterCall<OpenFin.ApplicationState[]>;
|
|
12760
|
-
'get-command-line-arguments': GetterCall<string>;
|
|
12761
|
-
'get-crash-reporter-state': GetterCall<OpenFin.CrashReporterState>;
|
|
12762
|
-
'start-crash-reporter': {
|
|
12763
|
-
request: OpenFin.CrashReporterOptions | {
|
|
12764
|
-
diagnosticMode: boolean;
|
|
12765
|
-
};
|
|
12766
|
-
response: OpenFin.CrashReporterState;
|
|
12767
|
-
};
|
|
12768
|
-
'get-unique-user-id': GetterCall<string>;
|
|
12769
|
-
'get-entity-info': {
|
|
12770
|
-
request: {
|
|
12771
|
-
uuid: string;
|
|
12772
|
-
name: string;
|
|
12773
|
-
};
|
|
12774
|
-
response: OpenFin.EntityInfo;
|
|
12775
|
-
};
|
|
12776
|
-
'get-environment-variable': {
|
|
12777
|
-
request: {
|
|
12778
|
-
environmentVariables: string;
|
|
12779
|
-
};
|
|
12780
|
-
response: string;
|
|
12781
|
-
};
|
|
12782
|
-
'get-focused-window': GetterCall<OpenFin.Identity | null>;
|
|
12783
|
-
'get-focused-content': GetterCall<(OpenFin.Identity & {
|
|
12784
|
-
entityType: 'window' | 'view';
|
|
12785
|
-
}) | null>;
|
|
12786
|
-
'is-app-certified': {
|
|
12787
|
-
request: {
|
|
12788
|
-
manifestUrl: string;
|
|
12789
|
-
};
|
|
12790
|
-
response: {
|
|
12791
|
-
action: string;
|
|
12792
|
-
certifiedInfo: OpenFin.CertifiedAppInfo;
|
|
12793
|
-
};
|
|
12794
|
-
};
|
|
12795
|
-
'get-installed-runtimes': GetterCall<{
|
|
12796
|
-
action: string;
|
|
12797
|
-
runtimes: string[];
|
|
12798
|
-
}>;
|
|
12799
|
-
'get-installed-apps': GetterCall<OpenFin.InstalledApps>;
|
|
12800
|
-
'view-log': ApiCall<OpenFin.GetLogRequestType, string>;
|
|
12801
|
-
'get-machine-id': GetterCall<string>;
|
|
12802
|
-
'get-min-log-level': GetterCall<OpenFin.LogLevel>;
|
|
12803
|
-
'list-logs': GetterCall<OpenFin.LogInfo[]>;
|
|
12804
|
-
'get-monitor-info': GetterCall<OpenFin.MonitorInfo>;
|
|
12805
|
-
'get-mouse-position': GetterCall<OpenFin.PointTopLeft>;
|
|
12806
|
-
'process-snapshot': GetterCall<Array<any>>;
|
|
12807
|
-
'get-all-process-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.SystemProcessInfo>;
|
|
12808
|
-
'get-proxy-settings': GetterCall<OpenFin.ProxyInfo>;
|
|
12809
|
-
'get-runtime-info': GetterCall<OpenFin.RuntimeInfo>;
|
|
12810
|
-
'get-rvm-info': GetterCall<OpenFin.RVMInfo>;
|
|
12811
|
-
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12812
|
-
'get-os-info': GetterCall<OpenFin.OSInfo>;
|
|
12813
|
-
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity>;
|
|
12814
|
-
'monitor-external-process': ApiCall<OpenFin.ExternalProcessInfo, OpenFin.Identity>;
|
|
12815
|
-
'write-to-log': ApiCall<{
|
|
12816
|
-
level: string;
|
|
12817
|
-
message: string;
|
|
12818
|
-
}, void>;
|
|
12819
|
-
'open-url-with-browser': ApiCall<{
|
|
12820
|
-
url: string;
|
|
12821
|
-
}, void>;
|
|
12822
|
-
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12823
|
-
'unregister-custom-protocol': ApiCall<{
|
|
12824
|
-
protocolName: string;
|
|
12825
|
-
}, void>;
|
|
12826
|
-
'get-custom-protocol-state': ApiCall<{
|
|
12827
|
-
protocolName: string;
|
|
12828
|
-
}, OpenFin.CustomProtocolState>;
|
|
12829
|
-
'release-external-process': ApiCall<{
|
|
12830
|
-
uuid: string;
|
|
12831
|
-
}, void>;
|
|
12832
|
-
'show-developer-tools': ApiCall<OpenFin.Identity, void>;
|
|
12833
|
-
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void>;
|
|
12834
|
-
'update-proxy': ApiCall<OpenFin.ProxyConfig, void>;
|
|
12835
|
-
'download-asset': {
|
|
12836
|
-
request: OpenFin.AppAssetInfo & {
|
|
12837
|
-
downloadId: string;
|
|
12838
|
-
};
|
|
12839
|
-
response: void;
|
|
12840
|
-
};
|
|
12841
|
-
'download-runtime': {
|
|
12842
|
-
request: OpenFin.RuntimeDownloadOptions & {
|
|
12843
|
-
downloadId: string;
|
|
12844
|
-
};
|
|
12845
|
-
response: void;
|
|
12846
|
-
};
|
|
12847
|
-
'download-preload-scripts': ApiCall<{
|
|
12848
|
-
scripts: Array<OpenFin.DownloadPreloadOption>;
|
|
12849
|
-
}, Array<OpenFin.DownloadPreloadInfo>>;
|
|
12850
|
-
'get-all-external-applications': ApiCall<void, Array<OpenFin.Identity>>;
|
|
12851
|
-
'get-app-asset-info': ApiCall<OpenFin.AppAssetRequest, OpenFin.AppAssetInfo>;
|
|
12852
|
-
'get-cookies': {
|
|
12853
|
-
request: OpenFin.CookieOption & {
|
|
12854
|
-
url: string;
|
|
12855
|
-
};
|
|
12856
|
-
response: Array<OpenFin.CookieInfo>;
|
|
12857
|
-
};
|
|
12858
|
-
'set-min-log-level': ApiCall<{
|
|
12859
|
-
level: OpenFin.LogLevel;
|
|
12860
|
-
}, void>;
|
|
12861
|
-
'resolve-uuid': ApiCall<{
|
|
12862
|
-
entityKey: string;
|
|
12863
|
-
}, OpenFin.ApplicationType>;
|
|
12864
|
-
'read-registry-value': ApiCall<{
|
|
12865
|
-
rootKey: string;
|
|
12866
|
-
subkey: string;
|
|
12867
|
-
value: string;
|
|
12868
|
-
}, OpenFin.RegistryInfo>;
|
|
12869
|
-
'register-external-connection': ApiCall<{
|
|
12870
|
-
uuid: string;
|
|
12871
|
-
}, OpenFin.ExternalConnection>;
|
|
12872
|
-
'get-service-configuration': ApiCall<{
|
|
12873
|
-
name: string;
|
|
12874
|
-
}, OpenFin.ServiceConfiguration>;
|
|
12875
|
-
'get-system-app-configuration': ApiCall<{
|
|
12876
|
-
name: string;
|
|
12877
|
-
}, any>;
|
|
12878
|
-
'run-rvm-health-check': ApiCall<void, string[]>;
|
|
12879
12155
|
'launch-manifest': {
|
|
12880
12156
|
request: {
|
|
12881
12157
|
manifestUrl: string;
|
|
@@ -12887,12 +12163,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12887
12163
|
manifest: OpenFin.Manifest;
|
|
12888
12164
|
};
|
|
12889
12165
|
};
|
|
12890
|
-
'
|
|
12166
|
+
'get-system-app-configuration': {
|
|
12891
12167
|
request: {
|
|
12892
|
-
|
|
12893
|
-
identity: OpenFin.Identity;
|
|
12168
|
+
name: string;
|
|
12894
12169
|
};
|
|
12895
|
-
response:
|
|
12170
|
+
response: any;
|
|
12171
|
+
};
|
|
12172
|
+
'show-popup-menu': {
|
|
12173
|
+
request: OpenFin.Identity & {
|
|
12174
|
+
options: OpenFin.ShowPopupMenuOptions;
|
|
12175
|
+
};
|
|
12176
|
+
response: OpenFin.MenuResult;
|
|
12896
12177
|
};
|
|
12897
12178
|
'enable-native-window-integration-provider': {
|
|
12898
12179
|
request: {
|
|
@@ -12900,42 +12181,24 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12900
12181
|
};
|
|
12901
12182
|
response: OpenFin.NativeWindowIntegrationProviderAuthorization;
|
|
12902
12183
|
};
|
|
12903
|
-
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
12904
|
-
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12905
|
-
'system-update-process-logging-options': ApiCall<{
|
|
12906
|
-
options: OpenFin.ProcessLoggingOptions;
|
|
12907
|
-
}, void>;
|
|
12908
|
-
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12909
|
-
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12910
|
-
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12911
|
-
}, void>;
|
|
12912
|
-
'system-register-shutdown-handler': VoidCall;
|
|
12913
12184
|
'get-permissions': GetterCall<any>;
|
|
12914
|
-
'
|
|
12915
|
-
|
|
12916
|
-
|
|
12185
|
+
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
12186
|
+
'set-file-download-location': {
|
|
12187
|
+
request: OpenFin.Identity & {
|
|
12188
|
+
downloadLocation: string;
|
|
12189
|
+
};
|
|
12190
|
+
response: void;
|
|
12917
12191
|
};
|
|
12918
|
-
'get-
|
|
12919
|
-
request:
|
|
12920
|
-
response:
|
|
12192
|
+
'get-file-download-location': {
|
|
12193
|
+
request: OpenFin.ApplicationIdentity;
|
|
12194
|
+
response: string;
|
|
12921
12195
|
};
|
|
12196
|
+
'close-popup-menu': IdentityCall;
|
|
12922
12197
|
'fdc3-add-context-listener': VoidCall;
|
|
12923
|
-
'fdc3-add-intent-listener': VoidCall;
|
|
12924
|
-
'fdc3-raise-intent': VoidCall;
|
|
12925
|
-
'fdc3-find-intent': VoidCall;
|
|
12926
|
-
'fdc3-find-intents-by-context': VoidCall;
|
|
12927
|
-
'fdc3-raise-intent-for-context': VoidCall;
|
|
12928
|
-
'fdc3-get-info': VoidCall;
|
|
12929
|
-
'fdc3-find-instances': VoidCall;
|
|
12930
|
-
'fdc3-get-app-metadata': VoidCall;
|
|
12931
12198
|
'fdc3-broadcast': VoidCall;
|
|
12932
|
-
'fdc3-open': VoidCall;
|
|
12933
|
-
'fdc3-get-or-create-channel': VoidCall;
|
|
12934
12199
|
'fdc3-get-system-channels': VoidCall;
|
|
12935
12200
|
'fdc3-join-channel': VoidCall;
|
|
12936
|
-
'fdc3-get-current-channel': VoidCall;
|
|
12937
12201
|
'fdc3-leave-current-channel': VoidCall;
|
|
12938
|
-
'interop-init': VoidCall;
|
|
12939
12202
|
'interop-connect-sync': VoidCall;
|
|
12940
12203
|
'interop-client-set-context': VoidCall;
|
|
12941
12204
|
'interop-client-add-context-handler': VoidCall;
|
|
@@ -12944,13 +12207,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12944
12207
|
'interop-client-remove-from-context-group': VoidCall;
|
|
12945
12208
|
'interop-client-get-all-clients-in-context-group': VoidCall;
|
|
12946
12209
|
'interop-client-get-info-for-context-group': VoidCall;
|
|
12947
|
-
'interop-client-fire-intent': VoidCall;
|
|
12948
|
-
'interop-client-register-intent-handler': VoidCall;
|
|
12949
|
-
'interop-client-get-current-context': VoidCall;
|
|
12950
|
-
'interop-client-get-info-for-intent': VoidCall;
|
|
12951
|
-
'interop-client-get-info-for-intents-by-context': VoidCall;
|
|
12952
|
-
'interop-client-fire-intent-for-context': VoidCall;
|
|
12953
|
-
'interop-client-add-ondisconnection-listener': VoidCall;
|
|
12954
12210
|
'interop-broker-add-client-to-context-group': VoidCall;
|
|
12955
12211
|
'interop-broker-get-all-clients-in-context-group': VoidCall;
|
|
12956
12212
|
'interop-broker-get-context-groups': VoidCall;
|
|
@@ -12962,100 +12218,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12962
12218
|
'interop-broker-remove-from-context-group': VoidCall;
|
|
12963
12219
|
'interop-broker-set-context': VoidCall;
|
|
12964
12220
|
'interop-broker-set-context-for-group': VoidCall;
|
|
12965
|
-
'
|
|
12966
|
-
|
|
12967
|
-
|
|
12968
|
-
|
|
12969
|
-
|
|
12970
|
-
|
|
12971
|
-
|
|
12972
|
-
'platform-get-current': VoidCall;
|
|
12973
|
-
'platform-get-current-sync': VoidCall;
|
|
12974
|
-
'platform-start': VoidCall;
|
|
12975
|
-
'platform-start-from-manifest': VoidCall;
|
|
12976
|
-
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
12977
|
-
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
12978
|
-
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
12979
|
-
'platform-quit': ApplicationIdentityCall<{}, void>;
|
|
12980
|
-
'platform-close-view': ApplicationIdentityCall<{}, void>;
|
|
12981
|
-
'platform-reparent-view': ApplicationIdentityCall<{}, void>;
|
|
12982
|
-
'platform-get-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12983
|
-
'platform-apply-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12984
|
-
'platform-launch-content-manifest': ApplicationIdentityCall<{}, void>;
|
|
12985
|
-
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
12986
|
-
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
12987
|
-
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
12988
|
-
'layout-wrap': VoidCall;
|
|
12989
|
-
'layout-wrap-sync': VoidCall;
|
|
12990
|
-
'layout-get-current': VoidCall;
|
|
12991
|
-
'layout-get-current-sync': VoidCall;
|
|
12992
|
-
'layout-init': VoidCall;
|
|
12993
|
-
'layout-get-config': VoidCall;
|
|
12994
|
-
'layout-get-views': VoidCall;
|
|
12995
|
-
'layout-replace': VoidCall;
|
|
12996
|
-
'layout-get-root-item': VoidCall;
|
|
12997
|
-
'layout-replace-view': VoidCall;
|
|
12998
|
-
'layout-apply-preset': VoidCall;
|
|
12999
|
-
'layout-controller-get-root': VoidCall;
|
|
13000
|
-
'layout-controller-get-stack-by-view': VoidCall;
|
|
13001
|
-
'layout-controller-get-stack-views': VoidCall;
|
|
13002
|
-
'layout-controller-get-content': VoidCall;
|
|
13003
|
-
'layout-controller-get-parent': VoidCall;
|
|
13004
|
-
'layout-controller-is-root': VoidCall;
|
|
13005
|
-
'layout-controller-exists': VoidCall;
|
|
13006
|
-
'layout-controller-add-view-to-stack': VoidCall;
|
|
13007
|
-
'layout-controller-remove-view-from-stack': VoidCall;
|
|
13008
|
-
'layout-controller-create-adjacent-stack': VoidCall;
|
|
13009
|
-
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
13010
|
-
'layout-controller-set-stack-active-view': VoidCall;
|
|
13011
|
-
'snapshot-source-init': VoidCall;
|
|
13012
|
-
'snapshot-source-wrap-sync': VoidCall;
|
|
13013
|
-
'snapshot-source-wrap': VoidCall;
|
|
13014
|
-
'snapshot-source-ready': VoidCall;
|
|
13015
|
-
'snapshot-source-get-snapshot': VoidCall;
|
|
13016
|
-
'snapshot-source-apply-snapshot': VoidCall;
|
|
13017
|
-
'capture-page': IdentityCall<{
|
|
13018
|
-
options?: OpenFin.CapturePageOptions;
|
|
13019
|
-
}, string>;
|
|
13020
|
-
'execute-javascript-in-window': IdentityCall<{
|
|
13021
|
-
code: string;
|
|
13022
|
-
}, unknown>;
|
|
13023
|
-
'get-zoom-level': IdentityCall<{}, number>;
|
|
13024
|
-
'set-zoom-level': IdentityCall<{
|
|
13025
|
-
level: number;
|
|
13026
|
-
}, void>;
|
|
13027
|
-
'navigate-window': IdentityCall<{
|
|
13028
|
-
url: string;
|
|
13029
|
-
}, void>;
|
|
13030
|
-
'navigate-window-back': IdentityCall<{}, void>;
|
|
13031
|
-
'navigate-window-forward': IdentityCall<{}, void>;
|
|
13032
|
-
'stop-window-navigation': IdentityCall<{}, void>;
|
|
13033
|
-
'reload-window': IdentityCall<{
|
|
13034
|
-
ignoreCache: boolean;
|
|
13035
|
-
}, void>;
|
|
13036
|
-
'print': IdentityCall<{
|
|
13037
|
-
options: OpenFin.PrintOptions;
|
|
13038
|
-
}, void>;
|
|
13039
|
-
'find-in-page': IdentityCall<{
|
|
13040
|
-
searchTerm: string;
|
|
13041
|
-
options?: OpenFin.FindInPageOptions;
|
|
13042
|
-
}, void>;
|
|
13043
|
-
'stop-find-in-page': IdentityCall<{
|
|
13044
|
-
action: 'clearSelection' | 'keepSelection' | 'activateSelection';
|
|
13045
|
-
}, void>;
|
|
13046
|
-
'get-printers': IdentityCall<{}, OpenFin.PrinterInfo>;
|
|
13047
|
-
'focus-window': IdentityCall<{
|
|
13048
|
-
emitSynthFocused: boolean;
|
|
13049
|
-
}, void>;
|
|
13050
|
-
'get-process-info': IdentityCall<{}, OpenFin.EntityProcessDetails>;
|
|
13051
|
-
'get-shared-workers': IdentityCall<{}, OpenFin.SharedWorkerInfo[]>;
|
|
13052
|
-
'inspect-shared-worker': IdentityCall<{}, void>;
|
|
13053
|
-
'inspect-shared-worker-by-id': IdentityCall<{
|
|
13054
|
-
workerId: string;
|
|
13055
|
-
}, void>;
|
|
13056
|
-
'inspect-service-worker': IdentityCall<{}, void>;
|
|
13057
|
-
'view-show-popup-window': IdentityCall<{}, void>;
|
|
13058
|
-
'window-show-popup-window': IdentityCall<{}, void>;
|
|
12221
|
+
'query-permission-for-current-context': {
|
|
12222
|
+
request: {
|
|
12223
|
+
apiName: string;
|
|
12224
|
+
identity: OpenFin.Identity;
|
|
12225
|
+
};
|
|
12226
|
+
response: OpenFin.QueryPermissionResult;
|
|
12227
|
+
};
|
|
13059
12228
|
'try-create-popup-window': {
|
|
13060
12229
|
request: OpenFin.Identity & {
|
|
13061
12230
|
options: OpenFin.PopupOptions;
|
|
@@ -13071,6 +12240,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13071
12240
|
};
|
|
13072
12241
|
response: OpenFin.PopupResult;
|
|
13073
12242
|
};
|
|
12243
|
+
'dispatch-popup-result': IdentityCall<{
|
|
12244
|
+
data: any;
|
|
12245
|
+
}>;
|
|
13074
12246
|
'render-overlay': {
|
|
13075
12247
|
request: {
|
|
13076
12248
|
bounds: OpenFin.Bounds;
|
|
@@ -13090,6 +12262,38 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13090
12262
|
};
|
|
13091
12263
|
response: void;
|
|
13092
12264
|
};
|
|
12265
|
+
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12266
|
+
'system-register-shutdown-handler': VoidCall;
|
|
12267
|
+
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12268
|
+
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12269
|
+
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12270
|
+
}, void>;
|
|
12271
|
+
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12272
|
+
deltaLeft: number;
|
|
12273
|
+
deltaTop: number;
|
|
12274
|
+
}>>;
|
|
12275
|
+
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12276
|
+
left: number;
|
|
12277
|
+
top: number;
|
|
12278
|
+
}>>;
|
|
12279
|
+
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12280
|
+
deltaWidth: number;
|
|
12281
|
+
deltaHeight: number;
|
|
12282
|
+
anchor: OpenFin.AnchorType;
|
|
12283
|
+
}>>;
|
|
12284
|
+
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12285
|
+
width: number;
|
|
12286
|
+
height: number;
|
|
12287
|
+
anchor: OpenFin.AnchorType;
|
|
12288
|
+
}>>;
|
|
12289
|
+
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12290
|
+
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12291
|
+
'unregister-custom-protocol': ApiCall<{
|
|
12292
|
+
protocolName: string;
|
|
12293
|
+
}, void>;
|
|
12294
|
+
'get-custom-protocol-state': ApiCall<{
|
|
12295
|
+
protocolName: string;
|
|
12296
|
+
}, OpenFin.CustomProtocolState>;
|
|
13093
12297
|
}
|
|
13094
12298
|
|
|
13095
12299
|
declare interface ProtocolMapBase {
|
|
@@ -13119,7 +12323,7 @@ declare type ProviderIdentity_3 = OpenFin.ProviderIdentity;
|
|
|
13119
12323
|
* Identity of a channel provider.
|
|
13120
12324
|
* @interface
|
|
13121
12325
|
*/
|
|
13122
|
-
declare type ProviderIdentity_4 =
|
|
12326
|
+
declare type ProviderIdentity_4 = Identity_5 & {
|
|
13123
12327
|
/**
|
|
13124
12328
|
* Identifier of the channel.
|
|
13125
12329
|
*/
|
|
@@ -13130,10 +12334,12 @@ declare type ProviderIdentity_4 = Identity_4 & {
|
|
|
13130
12334
|
channelName: string;
|
|
13131
12335
|
};
|
|
13132
12336
|
|
|
12337
|
+
declare type ProxyConfig = OpenFin.ProxyConfig;
|
|
12338
|
+
|
|
13133
12339
|
/**
|
|
13134
12340
|
* @interface
|
|
13135
12341
|
*/
|
|
13136
|
-
declare type
|
|
12342
|
+
declare type ProxyConfig_2 = {
|
|
13137
12343
|
/**
|
|
13138
12344
|
* The configured proxy address.
|
|
13139
12345
|
*/
|
|
@@ -13145,11 +12351,13 @@ declare type ProxyConfig = {
|
|
|
13145
12351
|
type: string;
|
|
13146
12352
|
};
|
|
13147
12353
|
|
|
12354
|
+
declare type ProxyInfo = OpenFin.ProxyInfo;
|
|
12355
|
+
|
|
13148
12356
|
/**
|
|
13149
12357
|
* @interface
|
|
13150
12358
|
*/
|
|
13151
|
-
declare type
|
|
13152
|
-
config:
|
|
12359
|
+
declare type ProxyInfo_2 = {
|
|
12360
|
+
config: ProxyConfig_2;
|
|
13153
12361
|
system: ProxySystemInfo;
|
|
13154
12362
|
};
|
|
13155
12363
|
|
|
@@ -13255,10 +12463,12 @@ declare type RegisterUsageData = {
|
|
|
13255
12463
|
type: string;
|
|
13256
12464
|
};
|
|
13257
12465
|
|
|
12466
|
+
declare type RegistryInfo = OpenFin.RegistryInfo;
|
|
12467
|
+
|
|
13258
12468
|
/**
|
|
13259
12469
|
* @interface
|
|
13260
12470
|
*/
|
|
13261
|
-
declare type
|
|
12471
|
+
declare type RegistryInfo_2 = {
|
|
13262
12472
|
data: any;
|
|
13263
12473
|
rootKey: string;
|
|
13264
12474
|
subkey: string;
|
|
@@ -13279,15 +12489,6 @@ declare interface RemoteConfig extends ExistingConnectConfig {
|
|
|
13279
12489
|
token: string;
|
|
13280
12490
|
}
|
|
13281
12491
|
|
|
13282
|
-
/**
|
|
13283
|
-
* Generated when a View is removed from a layout.
|
|
13284
|
-
* @interface
|
|
13285
|
-
*/
|
|
13286
|
-
declare type RemovedFromLayoutEvent = BaseEvent_4 & {
|
|
13287
|
-
type: 'removed-from-layout';
|
|
13288
|
-
layoutIdentity: OpenFin.LayoutIdentity;
|
|
13289
|
-
};
|
|
13290
|
-
|
|
13291
12492
|
/**
|
|
13292
12493
|
* @interface
|
|
13293
12494
|
*/
|
|
@@ -13316,14 +12517,14 @@ declare type ReplaceLayoutPayload = {
|
|
|
13316
12517
|
/**
|
|
13317
12518
|
* Identity of the window whose layout will be replaced.
|
|
13318
12519
|
*/
|
|
13319
|
-
target:
|
|
12520
|
+
target: Identity_5 | LayoutIdentity;
|
|
13320
12521
|
};
|
|
13321
12522
|
|
|
13322
12523
|
/**
|
|
13323
12524
|
* @interface
|
|
13324
12525
|
*/
|
|
13325
12526
|
declare type ReplaceViewOptions = {
|
|
13326
|
-
viewToReplace:
|
|
12527
|
+
viewToReplace: Identity_5;
|
|
13327
12528
|
newView: ViewState;
|
|
13328
12529
|
};
|
|
13329
12530
|
|
|
@@ -13332,7 +12533,7 @@ declare type ReplaceViewOptions = {
|
|
|
13332
12533
|
*/
|
|
13333
12534
|
declare type ReplaceViewPayload = {
|
|
13334
12535
|
opts: {
|
|
13335
|
-
viewToReplace:
|
|
12536
|
+
viewToReplace: Identity_5;
|
|
13336
12537
|
newView: Partial<ViewOptions>;
|
|
13337
12538
|
};
|
|
13338
12539
|
target: LayoutIdentity;
|
|
@@ -13454,17 +12655,6 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
|
|
|
13454
12655
|
};
|
|
13455
12656
|
}
|
|
13456
12657
|
|
|
13457
|
-
/**
|
|
13458
|
-
* Controls the behavior of the navigation URI pattern matching algorithm.
|
|
13459
|
-
*/
|
|
13460
|
-
declare type RuleMatchOptions = {
|
|
13461
|
-
/**
|
|
13462
|
-
* Matches all schemes rather than just http and https when a wild card is specified. For example, `'*://*.site.com'` will
|
|
13463
|
-
* only match urls which begin with `'http:'` or `'https:'` unless this setting is `true`.
|
|
13464
|
-
*/
|
|
13465
|
-
matchAllSchemes?: boolean;
|
|
13466
|
-
};
|
|
13467
|
-
|
|
13468
12658
|
declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
13469
12659
|
|
|
13470
12660
|
/**
|
|
@@ -13607,21 +12797,6 @@ declare type ScreenshotPrintOptions = {
|
|
|
13607
12797
|
content: 'screenshot';
|
|
13608
12798
|
};
|
|
13609
12799
|
|
|
13610
|
-
/**
|
|
13611
|
-
* An event generated when an application modifies the runtime in a way that affects all other applications in the
|
|
13612
|
-
* application runtime/security realm.
|
|
13613
|
-
*/
|
|
13614
|
-
declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
13615
|
-
/**
|
|
13616
|
-
* Config URL of the application that modified the security realm's extensions
|
|
13617
|
-
*/
|
|
13618
|
-
configUrl: string;
|
|
13619
|
-
/**
|
|
13620
|
-
* Identity of the application that modified the security realm's extensions
|
|
13621
|
-
*/
|
|
13622
|
-
applicationIdentity: OpenFin.ApplicationIdentity;
|
|
13623
|
-
};
|
|
13624
|
-
|
|
13625
12800
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
13626
12801
|
data: ProtocolMap[T]['response'];
|
|
13627
12802
|
} & ProtocolMap[T]['specialResponse']>;
|
|
@@ -13713,7 +12888,7 @@ declare type SetWindowContextPayload = {
|
|
|
13713
12888
|
/**
|
|
13714
12889
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
13715
12890
|
*/
|
|
13716
|
-
target:
|
|
12891
|
+
target: Identity_5;
|
|
13717
12892
|
};
|
|
13718
12893
|
|
|
13719
12894
|
/**
|
|
@@ -13932,7 +13107,7 @@ declare type Snapshot = {
|
|
|
13932
13107
|
* _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
|
|
13933
13108
|
* @interface
|
|
13934
13109
|
*/
|
|
13935
|
-
declare type SnapshotAppliedEvent =
|
|
13110
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
13936
13111
|
topic: 'application';
|
|
13937
13112
|
type: 'platform-snapshot-applied';
|
|
13938
13113
|
};
|
|
@@ -14163,7 +13338,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14163
13338
|
* fin.System.getAllWindows().then(wins => console.log(wins)).catch(err => console.log(err));
|
|
14164
13339
|
* ```
|
|
14165
13340
|
*/
|
|
14166
|
-
getAllWindows(): Promise<Array<
|
|
13341
|
+
getAllWindows(): Promise<Array<ApplicationWindowInfo>>;
|
|
14167
13342
|
/**
|
|
14168
13343
|
* Retrieves an array of data for all applications.
|
|
14169
13344
|
*
|
|
@@ -14172,7 +13347,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14172
13347
|
* fin.System.getAllApplications().then(apps => console.log(apps)).catch(err => console.log(err));
|
|
14173
13348
|
* ```
|
|
14174
13349
|
*/
|
|
14175
|
-
getAllApplications(): Promise<Array<
|
|
13350
|
+
getAllApplications(): Promise<Array<ApplicationState>>;
|
|
14176
13351
|
/**
|
|
14177
13352
|
* Retrieves the command line argument string that started OpenFin Runtime.
|
|
14178
13353
|
*
|
|
@@ -14247,7 +13422,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14247
13422
|
* }
|
|
14248
13423
|
* ```
|
|
14249
13424
|
*/
|
|
14250
|
-
getEntityInfo(uuid: string, name: string): Promise<
|
|
13425
|
+
getEntityInfo(uuid: string, name: string): Promise<EntityInfo>;
|
|
14251
13426
|
/**
|
|
14252
13427
|
* Gets the value of a given environment variable on the computer on which the runtime is installed
|
|
14253
13428
|
*
|
|
@@ -14258,9 +13433,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14258
13433
|
*/
|
|
14259
13434
|
getEnvironmentVariable(envName: string): Promise<string>;
|
|
14260
13435
|
/**
|
|
14261
|
-
* Get
|
|
14262
|
-
* If a View currently has focus, returns the identity of View's parent Window.
|
|
14263
|
-
* Use {@link Window._Window#getFocusedContent Window.getFocusedContent} to directly access currently focused Window or View.
|
|
13436
|
+
* Get current focused window.
|
|
14264
13437
|
*
|
|
14265
13438
|
* @example
|
|
14266
13439
|
* ```js
|
|
@@ -14268,17 +13441,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14268
13441
|
* ```
|
|
14269
13442
|
*/
|
|
14270
13443
|
getFocusedWindow(): Promise<OpenFin.Identity | null>;
|
|
14271
|
-
/**
|
|
14272
|
-
* Get currently focused content. Returns identity of entity with `entityType`.
|
|
14273
|
-
*
|
|
14274
|
-
* @example
|
|
14275
|
-
* ```js
|
|
14276
|
-
* fin.System.getFocusedContent().then(contentIdentity => console.log(contentIdentity)).catch(err => console.log(err));
|
|
14277
|
-
* ```
|
|
14278
|
-
*/
|
|
14279
|
-
getFocusedContent(): Promise<(OpenFin.Identity & {
|
|
14280
|
-
entityType: 'window' | 'view';
|
|
14281
|
-
}) | null>;
|
|
14282
13444
|
/**
|
|
14283
13445
|
* Returns information about the given app's certification status
|
|
14284
13446
|
*
|
|
@@ -14302,7 +13464,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14302
13464
|
* ```
|
|
14303
13465
|
*/
|
|
14304
13466
|
getInstalledRuntimes(): Promise<string[]>;
|
|
14305
|
-
getInstalledApps(): Promise<
|
|
13467
|
+
getInstalledApps(): Promise<InstalledApps>;
|
|
14306
13468
|
/**
|
|
14307
13469
|
* Retrieves the contents of the log with the specified filename.
|
|
14308
13470
|
* @param options A object that id defined by the GetLogRequestType interface
|
|
@@ -14317,7 +13479,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14317
13479
|
* getLog().then(log => console.log(log)).catch(err => console.log(err));
|
|
14318
13480
|
* ```
|
|
14319
13481
|
*/
|
|
14320
|
-
getLog(options:
|
|
13482
|
+
getLog(options: GetLogRequestType): Promise<string>;
|
|
14321
13483
|
/**
|
|
14322
13484
|
* Returns a unique identifier (UUID) provided by the machine.
|
|
14323
13485
|
*
|
|
@@ -14335,7 +13497,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14335
13497
|
* fin.System.getMinLogLevel().then(level => console.log(level)).catch(err => console.log(err));
|
|
14336
13498
|
* ```
|
|
14337
13499
|
*/
|
|
14338
|
-
getMinLogLevel(): Promise<
|
|
13500
|
+
getMinLogLevel(): Promise<LogLevel>;
|
|
14339
13501
|
/**
|
|
14340
13502
|
* Retrieves an array containing information for each log file.
|
|
14341
13503
|
*
|
|
@@ -14344,7 +13506,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14344
13506
|
* fin.System.getLogList().then(logList => console.log(logList)).catch(err => console.log(err));
|
|
14345
13507
|
* ```
|
|
14346
13508
|
*/
|
|
14347
|
-
getLogList(): Promise<Array<
|
|
13509
|
+
getLogList(): Promise<Array<LogInfo>>;
|
|
14348
13510
|
/**
|
|
14349
13511
|
* Retrieves an object that contains data about the monitor setup of the
|
|
14350
13512
|
* computer that the runtime is running on.
|
|
@@ -14415,7 +13577,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14415
13577
|
* }
|
|
14416
13578
|
* ```
|
|
14417
13579
|
*/
|
|
14418
|
-
getProxySettings(): Promise<
|
|
13580
|
+
getProxySettings(): Promise<ProxyInfo>;
|
|
14419
13581
|
/**
|
|
14420
13582
|
* Returns information about the running Runtime in an object.
|
|
14421
13583
|
*
|
|
@@ -14435,8 +13597,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14435
13597
|
*/
|
|
14436
13598
|
getRvmInfo(): Promise<OpenFin.RVMInfo>;
|
|
14437
13599
|
/**
|
|
14438
|
-
* Retrieves
|
|
14439
|
-
* OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
|
|
13600
|
+
* Retrieves system information.
|
|
14440
13601
|
*
|
|
14441
13602
|
* @example
|
|
14442
13603
|
* ```js
|
|
@@ -14444,15 +13605,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14444
13605
|
* ```
|
|
14445
13606
|
*/
|
|
14446
13607
|
getHostSpecs(): Promise<OpenFin.HostSpecs>;
|
|
14447
|
-
/**
|
|
14448
|
-
* Retrieves information about the OS and the currently logged in user.
|
|
14449
|
-
*
|
|
14450
|
-
* @example
|
|
14451
|
-
* ```js
|
|
14452
|
-
* fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
|
|
14453
|
-
* ```
|
|
14454
|
-
*/
|
|
14455
|
-
getOSInfo(): Promise<OpenFin.OSInfo>;
|
|
14456
13608
|
/**
|
|
14457
13609
|
* Runs an executable or batch file. A path to the file must be included in options.
|
|
14458
13610
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -14782,7 +13934,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14782
13934
|
* }
|
|
14783
13935
|
* ```
|
|
14784
13936
|
*/
|
|
14785
|
-
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<
|
|
13937
|
+
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<Identity_2>;
|
|
14786
13938
|
/**
|
|
14787
13939
|
* Monitors a running process. A pid for the process must be included in options.
|
|
14788
13940
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -14799,7 +13951,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14799
13951
|
* }).then(processIdentity => console.log(processIdentity)).catch(err => console.log(err));
|
|
14800
13952
|
* ```
|
|
14801
13953
|
*/
|
|
14802
|
-
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<
|
|
13954
|
+
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<Identity_2>;
|
|
14803
13955
|
/**
|
|
14804
13956
|
* Writes the passed message into both the log file and the console.
|
|
14805
13957
|
* @param level The log level for the entry. Can be either "info", "warning" or "error"
|
|
@@ -14933,7 +14085,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14933
14085
|
*
|
|
14934
14086
|
* @tutorial System.showDeveloperTools
|
|
14935
14087
|
*/
|
|
14936
|
-
showDeveloperTools(identity:
|
|
14088
|
+
showDeveloperTools(identity: Identity_2): Promise<void>;
|
|
14937
14089
|
/**
|
|
14938
14090
|
* Attempt to close an external process. The process will be terminated if it
|
|
14939
14091
|
* has not closed after the elapsed timeout in milliseconds.
|
|
@@ -14967,7 +14119,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14967
14119
|
* .catch(err => console.error(err));
|
|
14968
14120
|
* ```
|
|
14969
14121
|
*/
|
|
14970
|
-
updateProxySettings(options:
|
|
14122
|
+
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
14971
14123
|
/**
|
|
14972
14124
|
* Downloads the given application asset.
|
|
14973
14125
|
*
|
|
@@ -15059,7 +14211,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15059
14211
|
* .catch(err => console.log(err));
|
|
15060
14212
|
* ```
|
|
15061
14213
|
*/
|
|
15062
|
-
getAllExternalApplications(): Promise<Array<
|
|
14214
|
+
getAllExternalApplications(): Promise<Array<Identity_2>>;
|
|
15063
14215
|
/**
|
|
15064
14216
|
* Retrieves app asset information.
|
|
15065
14217
|
* @param options
|
|
@@ -15088,7 +14240,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15088
14240
|
* fin.System.setMinLogLevel("verbose").then(() => console.log("log level is set to verbose")).catch(err => console.log(err));
|
|
15089
14241
|
* ```
|
|
15090
14242
|
*/
|
|
15091
|
-
setMinLogLevel(level:
|
|
14243
|
+
setMinLogLevel(level: LogLevel): Promise<void>;
|
|
15092
14244
|
/**
|
|
15093
14245
|
* Retrieves the UUID of the computer on which the runtime is installed
|
|
15094
14246
|
* @param uuid The uuid of the running application
|
|
@@ -15098,7 +14250,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15098
14250
|
* fin.System.resolveUuid('OpenfinPOC').then(entity => console.log(entity)).catch(err => console.log(err));
|
|
15099
14251
|
* ```
|
|
15100
14252
|
*/
|
|
15101
|
-
resolveUuid(uuid: string): Promise<
|
|
14253
|
+
resolveUuid(uuid: string): Promise<Entity>;
|
|
15102
14254
|
/**
|
|
15103
14255
|
* Retrieves an array of data for all external applications
|
|
15104
14256
|
* @param requestingIdentity This object is described in the Identity typedef
|
|
@@ -15106,7 +14258,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15106
14258
|
*
|
|
15107
14259
|
* @ignore
|
|
15108
14260
|
*/
|
|
15109
|
-
executeOnRemote(requestingIdentity:
|
|
14261
|
+
executeOnRemote(requestingIdentity: Identity_2, data: any): Promise<any>;
|
|
15110
14262
|
/**
|
|
15111
14263
|
* Reads the specifed value from the registry.
|
|
15112
14264
|
* @remarks This method is restricted by default and must be enabled via
|
|
@@ -15199,7 +14351,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15199
14351
|
* }
|
|
15200
14352
|
* ```
|
|
15201
14353
|
*/
|
|
15202
|
-
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<
|
|
14354
|
+
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<RegistryInfo>;
|
|
15203
14355
|
/**
|
|
15204
14356
|
* This function call will register a unique id and produce a token.
|
|
15205
14357
|
* The token can be used to broker an external connection.
|
|
@@ -15414,7 +14566,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15414
14566
|
* });
|
|
15415
14567
|
* ```
|
|
15416
14568
|
*/
|
|
15417
|
-
getPrinters(): Promise<
|
|
14569
|
+
getPrinters(): Promise<PrinterInfo[]>;
|
|
15418
14570
|
/**
|
|
15419
14571
|
* Updates Process Logging values: periodic interval and outlier detection entries and interval.
|
|
15420
14572
|
* @param options Process Logging updatable options.
|
|
@@ -15532,16 +14684,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15532
14684
|
* ```
|
|
15533
14685
|
*/
|
|
15534
14686
|
setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
|
|
15535
|
-
/**
|
|
15536
|
-
* Attempts to install and enable extensions for the security realm. Users may want to call this function in response
|
|
15537
|
-
* to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
|
|
15538
|
-
* will be installed/enabled.
|
|
15539
|
-
*/
|
|
15540
|
-
refreshExtensions(): Promise<string[] | undefined>;
|
|
15541
|
-
/**
|
|
15542
|
-
* Gets the currently-installed
|
|
15543
|
-
*/
|
|
15544
|
-
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
15545
14687
|
}
|
|
15546
14688
|
|
|
15547
14689
|
/**
|
|
@@ -15572,19 +14714,11 @@ declare namespace SystemEvents {
|
|
|
15572
14714
|
ApplicationCreatedEvent,
|
|
15573
14715
|
DesktopIconClickedEvent,
|
|
15574
14716
|
SystemShutdownEvent,
|
|
15575
|
-
ExtensionsEnabledEvent,
|
|
15576
|
-
ExtensionsDisabledEvent,
|
|
15577
|
-
ExtensionsExcludedEvent,
|
|
15578
|
-
ExtensionsInstalledEvent,
|
|
15579
|
-
ExtensionInstalledEvent,
|
|
15580
|
-
ExtensionsInstallFailedEvent,
|
|
15581
|
-
ExtensionInstallFailedEvent,
|
|
15582
|
-
ExtensionsInitializationFailedEvent,
|
|
15583
14717
|
Event_11 as Event,
|
|
15584
14718
|
SystemEvent,
|
|
15585
14719
|
EventType_8 as EventType,
|
|
15586
14720
|
SystemEventType,
|
|
15587
|
-
|
|
14721
|
+
Payload_9 as Payload,
|
|
15588
14722
|
ByType_8 as ByType
|
|
15589
14723
|
}
|
|
15590
14724
|
}
|
|
@@ -15598,7 +14732,6 @@ declare type SystemEventType = EventType_8;
|
|
|
15598
14732
|
* @interface
|
|
15599
14733
|
*/
|
|
15600
14734
|
declare type SystemPermissions = {
|
|
15601
|
-
getOSInfo: boolean;
|
|
15602
14735
|
getAllExternalWindows: boolean;
|
|
15603
14736
|
launchExternalProcess: boolean | {
|
|
15604
14737
|
enabled: boolean;
|
|
@@ -15873,8 +15006,6 @@ declare type Time = {
|
|
|
15873
15006
|
irq: number;
|
|
15874
15007
|
};
|
|
15875
15008
|
|
|
15876
|
-
declare type TimeZones = 'utc' | 'local';
|
|
15877
|
-
|
|
15878
15009
|
/**
|
|
15879
15010
|
* @interface
|
|
15880
15011
|
*/
|
|
@@ -16058,11 +15189,14 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
16058
15189
|
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
|
16059
15190
|
|
|
16060
15191
|
/**
|
|
16061
|
-
*
|
|
16062
|
-
*
|
|
15192
|
+
* A general user bounds change event without event type.
|
|
16063
15193
|
* @interface
|
|
16064
15194
|
*/
|
|
16065
|
-
declare type UserBoundsChangeEvent =
|
|
15195
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
|
15196
|
+
height: number;
|
|
15197
|
+
left: number;
|
|
15198
|
+
top: number;
|
|
15199
|
+
width: number;
|
|
16066
15200
|
windowState: 'minimized' | 'normal' | 'maximized';
|
|
16067
15201
|
};
|
|
16068
15202
|
|
|
@@ -16347,8 +15481,6 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
16347
15481
|
* left: 100,
|
|
16348
15482
|
* width: 300,
|
|
16349
15483
|
* height: 300
|
|
16350
|
-
* }, {
|
|
16351
|
-
* bringToFront : true
|
|
16352
15484
|
* });
|
|
16353
15485
|
* }
|
|
16354
15486
|
*
|
|
@@ -16358,15 +15490,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
16358
15490
|
* ```
|
|
16359
15491
|
* @experimental
|
|
16360
15492
|
*/
|
|
16361
|
-
showAt: (bounds: OpenFin.Bounds
|
|
16362
|
-
/**
|
|
16363
|
-
* Brings the specified view to the front of its current window. This ensures the view will be visible on top of any other views
|
|
16364
|
-
* which have overlapping bounds with it.
|
|
16365
|
-
*
|
|
16366
|
-
* Please note, this is not a permanent action - when a new view is created or attached to the window, it will display on top of all other views
|
|
16367
|
-
* in the window that share bounds with it.
|
|
16368
|
-
*/
|
|
16369
|
-
bringToFront: () => Promise<void>;
|
|
15493
|
+
showAt: (bounds: OpenFin.Bounds) => Promise<void>;
|
|
16370
15494
|
/**
|
|
16371
15495
|
* Hides the current view if it is currently visible.
|
|
16372
15496
|
*
|
|
@@ -16698,24 +15822,6 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
16698
15822
|
options?: Partial<ViewOptions>;
|
|
16699
15823
|
};
|
|
16700
15824
|
|
|
16701
|
-
/**
|
|
16702
|
-
* @interface
|
|
16703
|
-
*/
|
|
16704
|
-
declare type ViewCreationFailure = {
|
|
16705
|
-
/**
|
|
16706
|
-
* The identity of the created view
|
|
16707
|
-
*/
|
|
16708
|
-
identity: Identity_4;
|
|
16709
|
-
/**
|
|
16710
|
-
* Whether the view was created with errors
|
|
16711
|
-
*/
|
|
16712
|
-
success: false;
|
|
16713
|
-
/**
|
|
16714
|
-
* Error thrown during view creation
|
|
16715
|
-
*/
|
|
16716
|
-
error: Error;
|
|
16717
|
-
};
|
|
16718
|
-
|
|
16719
15825
|
/**
|
|
16720
15826
|
* The options object required by {@link View.ViewModule.create View.create}.
|
|
16721
15827
|
*
|
|
@@ -16726,30 +15832,11 @@ declare type ViewCreationFailure = {
|
|
|
16726
15832
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
16727
15833
|
name: string;
|
|
16728
15834
|
url: string;
|
|
16729
|
-
target:
|
|
15835
|
+
target: Identity_5;
|
|
16730
15836
|
};
|
|
16731
15837
|
|
|
16732
15838
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
|
16733
15839
|
|
|
16734
|
-
/**
|
|
16735
|
-
* A view creation state
|
|
16736
|
-
*/
|
|
16737
|
-
declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
|
|
16738
|
-
|
|
16739
|
-
/**
|
|
16740
|
-
* @interface
|
|
16741
|
-
*/
|
|
16742
|
-
declare type ViewCreationSuccess = {
|
|
16743
|
-
/**
|
|
16744
|
-
* The identity of the created view
|
|
16745
|
-
*/
|
|
16746
|
-
identity: Identity_4;
|
|
16747
|
-
/**
|
|
16748
|
-
* Whether the view was created without errors
|
|
16749
|
-
*/
|
|
16750
|
-
success: true;
|
|
16751
|
-
};
|
|
16752
|
-
|
|
16753
15840
|
/**
|
|
16754
15841
|
* Generated when a window has a view detached from it.
|
|
16755
15842
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
@@ -16774,8 +15861,6 @@ declare namespace ViewEvents {
|
|
|
16774
15861
|
BaseEvent_4 as BaseEvent,
|
|
16775
15862
|
BaseViewEvent,
|
|
16776
15863
|
TargetChangedEvent,
|
|
16777
|
-
AddedToLayoutEvent,
|
|
16778
|
-
RemovedFromLayoutEvent,
|
|
16779
15864
|
NonPropagatedViewEvent,
|
|
16780
15865
|
CreatedEvent,
|
|
16781
15866
|
DestroyedEvent,
|
|
@@ -16792,7 +15877,7 @@ declare namespace ViewEvents {
|
|
|
16792
15877
|
PropagatedViewEvent,
|
|
16793
15878
|
PropagatedEventType_2 as PropagatedEventType,
|
|
16794
15879
|
PropagatedViewEventType,
|
|
16795
|
-
|
|
15880
|
+
Payload_2 as Payload,
|
|
16796
15881
|
ByType
|
|
16797
15882
|
}
|
|
16798
15883
|
}
|
|
@@ -16911,17 +15996,6 @@ declare class ViewModule extends Base {
|
|
|
16911
15996
|
*/
|
|
16912
15997
|
declare type ViewOptions = ConstViewOptions & MutableViewOptions;
|
|
16913
15998
|
|
|
16914
|
-
/**
|
|
16915
|
-
* @interface
|
|
16916
|
-
*/
|
|
16917
|
-
declare type ViewShowAtOptions = {
|
|
16918
|
-
/**
|
|
16919
|
-
* Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
|
|
16920
|
-
* @default false
|
|
16921
|
-
*/
|
|
16922
|
-
bringToFront?: true;
|
|
16923
|
-
};
|
|
16924
|
-
|
|
16925
15999
|
/**
|
|
16926
16000
|
* Represents the payload shape for Views that are trying to prevent an unload.
|
|
16927
16001
|
* @interface
|
|
@@ -16934,15 +16008,15 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
16934
16008
|
/**
|
|
16935
16009
|
* Identity of the Window.
|
|
16936
16010
|
*/
|
|
16937
|
-
windowId:
|
|
16011
|
+
windowId: Identity_5;
|
|
16938
16012
|
/**
|
|
16939
16013
|
* Identities of the Views that are preventing an unload
|
|
16940
16014
|
*/
|
|
16941
|
-
viewsPreventingUnload:
|
|
16015
|
+
viewsPreventingUnload: Identity_5[];
|
|
16942
16016
|
/**
|
|
16943
16017
|
* Identities of the Views that are not preventing an unload
|
|
16944
16018
|
*/
|
|
16945
|
-
viewsNotPreventingUnload:
|
|
16019
|
+
viewsNotPreventingUnload: Identity_5[];
|
|
16946
16020
|
/**
|
|
16947
16021
|
* Source of the close action.
|
|
16948
16022
|
*/
|
|
@@ -16953,6 +16027,7 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
16953
16027
|
* @interface
|
|
16954
16028
|
*/
|
|
16955
16029
|
declare type ViewState = ViewCreationOptions & {
|
|
16030
|
+
backgroundThrottling: boolean;
|
|
16956
16031
|
componentName: 'view';
|
|
16957
16032
|
initialUrl: string;
|
|
16958
16033
|
minWidth?: number;
|
|
@@ -16967,21 +16042,13 @@ declare interface ViewStatuses {
|
|
|
16967
16042
|
/**
|
|
16968
16043
|
* Identities of the Views that are preventing an unload.
|
|
16969
16044
|
*/
|
|
16970
|
-
viewsPreventingUnload:
|
|
16045
|
+
viewsPreventingUnload: Identity_5[];
|
|
16971
16046
|
/**
|
|
16972
16047
|
* Identities of the Views that are not preventing an unload.
|
|
16973
16048
|
*/
|
|
16974
|
-
viewsNotPreventingUnload:
|
|
16049
|
+
viewsNotPreventingUnload: Identity_5[];
|
|
16975
16050
|
}
|
|
16976
16051
|
|
|
16977
|
-
/**
|
|
16978
|
-
* View throttling state.
|
|
16979
|
-
*
|
|
16980
|
-
* * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
|
|
16981
|
-
* * `scheduler-disabled`: background throttling is true, but scheduler throttling is disabled.
|
|
16982
|
-
*/
|
|
16983
|
-
declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
16984
|
-
|
|
16985
16052
|
/**
|
|
16986
16053
|
* Configuration for view visibility settings
|
|
16987
16054
|
*
|
|
@@ -17476,7 +16543,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17476
16543
|
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
17477
16544
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
17478
16545
|
*/
|
|
17479
|
-
stopFindInPage(action:
|
|
16546
|
+
stopFindInPage(action: string): Promise<void>;
|
|
17480
16547
|
/**
|
|
17481
16548
|
* Returns an array with all system printers
|
|
17482
16549
|
* @deprecated use System.getPrinters instead
|
|
@@ -17615,7 +16682,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17615
16682
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17616
16683
|
* });
|
|
17617
16684
|
*
|
|
17618
|
-
* await view.navigate('
|
|
16685
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17619
16686
|
*
|
|
17620
16687
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17621
16688
|
* ```
|
|
@@ -17626,7 +16693,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17626
16693
|
* name:'child',
|
|
17627
16694
|
* defaultWidth: 300,
|
|
17628
16695
|
* defaultHeight: 300,
|
|
17629
|
-
* url: '
|
|
16696
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17630
16697
|
* frame: true,
|
|
17631
16698
|
* autoShow: true
|
|
17632
16699
|
* };
|
|
@@ -17651,7 +16718,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17651
16718
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17652
16719
|
* });
|
|
17653
16720
|
*
|
|
17654
|
-
* await view.navigate('
|
|
16721
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17655
16722
|
*
|
|
17656
16723
|
* await view.inspectSharedWorker();
|
|
17657
16724
|
* ```
|
|
@@ -17662,7 +16729,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17662
16729
|
* name:'child',
|
|
17663
16730
|
* defaultWidth: 300,
|
|
17664
16731
|
* defaultHeight: 300,
|
|
17665
|
-
* url: '
|
|
16732
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17666
16733
|
* frame: true,
|
|
17667
16734
|
* autoShow: true
|
|
17668
16735
|
* };
|
|
@@ -17688,7 +16755,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17688
16755
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17689
16756
|
* });
|
|
17690
16757
|
*
|
|
17691
|
-
* await view.navigate('
|
|
16758
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17692
16759
|
*
|
|
17693
16760
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17694
16761
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -17700,7 +16767,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17700
16767
|
* name:'child',
|
|
17701
16768
|
* defaultWidth: 300,
|
|
17702
16769
|
* defaultHeight: 300,
|
|
17703
|
-
* url: '
|
|
16770
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17704
16771
|
* frame: true,
|
|
17705
16772
|
* autoShow: true
|
|
17706
16773
|
* };
|
|
@@ -18069,7 +17136,11 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
18069
17136
|
* A general will-move or will-resize event without event type.
|
|
18070
17137
|
* @interface
|
|
18071
17138
|
*/
|
|
18072
|
-
declare type WillMoveOrResizeEvent =
|
|
17139
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
|
17140
|
+
height: number;
|
|
17141
|
+
left: number;
|
|
17142
|
+
top: number;
|
|
17143
|
+
width: number;
|
|
18073
17144
|
monitorScaleFactor: number;
|
|
18074
17145
|
};
|
|
18075
17146
|
|
|
@@ -19264,21 +18335,16 @@ declare namespace WindowEvents {
|
|
|
19264
18335
|
PreloadScriptInfoRunning,
|
|
19265
18336
|
PreloadScriptInfo,
|
|
19266
18337
|
PreloadScriptsStateChangeEvent,
|
|
19267
|
-
|
|
18338
|
+
UserBoundsChangeEvent,
|
|
19268
18339
|
BoundsChangeEvent,
|
|
19269
18340
|
WillMoveOrResizeEvent,
|
|
19270
|
-
BoundsDidChangeEvent,
|
|
19271
|
-
BoundsChangedEvent,
|
|
19272
|
-
BoundsChangingEvent,
|
|
19273
|
-
DisabledMovementBoundsChangedEvent,
|
|
19274
|
-
DisabledMovementBoundsChangingEvent,
|
|
19275
|
-
UserBoundsChangeEvent,
|
|
19276
|
-
BeginUserBoundsChangingEvent,
|
|
19277
|
-
EndUserBoundsChangingEvent,
|
|
19278
18341
|
PerformanceReportEvent,
|
|
19279
18342
|
InputEvent_2 as InputEvent,
|
|
19280
18343
|
LayoutInitializedEvent,
|
|
19281
18344
|
LayoutReadyEvent,
|
|
18345
|
+
BeginUserBoundsChangingEvent,
|
|
18346
|
+
BoundsChangedEvent,
|
|
18347
|
+
BoundsChangingEvent,
|
|
19282
18348
|
CloseRequestedEvent,
|
|
19283
18349
|
WindowCloseRequestedEvent,
|
|
19284
18350
|
ContextChangedEvent,
|
|
@@ -19286,7 +18352,10 @@ declare namespace WindowEvents {
|
|
|
19286
18352
|
WindowClosedEvent,
|
|
19287
18353
|
ClosingEvent,
|
|
19288
18354
|
WindowClosingEvent,
|
|
18355
|
+
DisabledMovementBoundsChangedEvent,
|
|
18356
|
+
DisabledMovementBoundsChangingEvent,
|
|
19289
18357
|
EmbeddedEvent,
|
|
18358
|
+
EndUserBoundsChangingEvent,
|
|
19290
18359
|
HotkeyEvent_2 as HotkeyEvent,
|
|
19291
18360
|
WindowHotkeyEvent,
|
|
19292
18361
|
InitializedEvent_2 as InitializedEvent,
|
|
@@ -19317,7 +18386,7 @@ declare namespace WindowEvents {
|
|
|
19317
18386
|
PropagatedEvent_3 as PropagatedEvent,
|
|
19318
18387
|
PropagatedWindowEvent,
|
|
19319
18388
|
PropagatedWindowEventType,
|
|
19320
|
-
|
|
18389
|
+
Payload_3 as Payload,
|
|
19321
18390
|
ByType_2 as ByType
|
|
19322
18391
|
}
|
|
19323
18392
|
}
|
|
@@ -19526,16 +18595,6 @@ declare type WindowStartLoadEvent = BaseEvent_3 & {
|
|
|
19526
18595
|
*/
|
|
19527
18596
|
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
|
19528
18597
|
|
|
19529
|
-
/**
|
|
19530
|
-
*
|
|
19531
|
-
* Window throttling state.
|
|
19532
|
-
*
|
|
19533
|
-
* * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
|
|
19534
|
-
* * `scheduler-disabled`: The background throttling is true, but scheduler throttling is disabled.
|
|
19535
|
-
* * `disabled`: The background throttling is false. The throttling is fully disabled.
|
|
19536
|
-
*/
|
|
19537
|
-
declare type WindowThrottling = 'enabled' | 'scheduler-disabled' | 'disabled';
|
|
19538
|
-
|
|
19539
18598
|
/**
|
|
19540
18599
|
* A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
|
|
19541
18600
|
* to the `Application` level, with the name pattern `window-view-eventname`.
|