@openfin/fdc3-api 38.83.90 → 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-beta.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
|
};
|
|
@@ -920,7 +911,7 @@ declare namespace ApplicationEvents {
|
|
|
920
911
|
PropagatedApplicationEvent,
|
|
921
912
|
PropagatedEventType_3 as PropagatedEventType,
|
|
922
913
|
PropagatedApplicationEventType,
|
|
923
|
-
|
|
914
|
+
Payload_4 as Payload,
|
|
924
915
|
ByType_3 as ByType
|
|
925
916
|
}
|
|
926
917
|
}
|
|
@@ -930,15 +921,15 @@ declare namespace ApplicationEvents {
|
|
|
930
921
|
*/
|
|
931
922
|
declare type ApplicationEventType = EventType_3;
|
|
932
923
|
|
|
924
|
+
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
|
925
|
+
|
|
933
926
|
/**
|
|
934
927
|
* @interface
|
|
935
928
|
*/
|
|
936
|
-
declare type
|
|
929
|
+
declare type ApplicationIdentity_2 = {
|
|
937
930
|
uuid: string;
|
|
938
931
|
};
|
|
939
932
|
|
|
940
|
-
declare type ApplicationIdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.ApplicationIdentity, Response>;
|
|
941
|
-
|
|
942
933
|
/**
|
|
943
934
|
* @interface
|
|
944
935
|
*/
|
|
@@ -1173,9 +1164,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1173
1164
|
* The name of the application.
|
|
1174
1165
|
*
|
|
1175
1166
|
* @remarks
|
|
1176
|
-
* This property is used for naming the application logging folder, which will be sanitized to remove
|
|
1177
|
-
* any special characters, spaces or international characters.
|
|
1178
|
-
*
|
|
1167
|
+
* This property is only used for naming the application logging folder, which will be sanitized to remove
|
|
1168
|
+
* any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
|
|
1169
|
+
* during startup with the UUID of the application.
|
|
1179
1170
|
*
|
|
1180
1171
|
* This property will be deprecated in the future.
|
|
1181
1172
|
*/
|
|
@@ -1285,10 +1276,6 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1285
1276
|
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1286
1277
|
*/
|
|
1287
1278
|
enableBeforeUnload: boolean;
|
|
1288
|
-
/**
|
|
1289
|
-
* 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'
|
|
1290
|
-
*/
|
|
1291
|
-
appLogsTimezone: TimeZones;
|
|
1292
1279
|
};
|
|
1293
1280
|
|
|
1294
1281
|
/**
|
|
@@ -1311,10 +1298,12 @@ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedE
|
|
|
1311
1298
|
*/
|
|
1312
1299
|
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1313
1300
|
|
|
1301
|
+
declare type ApplicationState = OpenFin.ApplicationState;
|
|
1302
|
+
|
|
1314
1303
|
/**
|
|
1315
1304
|
* @interface
|
|
1316
1305
|
*/
|
|
1317
|
-
declare type
|
|
1306
|
+
declare type ApplicationState_2 = {
|
|
1318
1307
|
/**
|
|
1319
1308
|
* True when the application is a Platform controller
|
|
1320
1309
|
*/
|
|
@@ -1346,10 +1335,12 @@ declare type ApplicationType = {
|
|
|
1346
1335
|
*/
|
|
1347
1336
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
|
1348
1337
|
|
|
1338
|
+
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
|
1339
|
+
|
|
1349
1340
|
/**
|
|
1350
1341
|
* @interface
|
|
1351
1342
|
*/
|
|
1352
|
-
declare type
|
|
1343
|
+
declare type ApplicationWindowInfo_2 = {
|
|
1353
1344
|
childWindows: Array<WindowDetail>;
|
|
1354
1345
|
mainWindow: WindowDetail;
|
|
1355
1346
|
/**
|
|
@@ -1614,7 +1605,7 @@ declare class Base {
|
|
|
1614
1605
|
* Useful for debugging in the devtools console, where this will intelligently type itself based
|
|
1615
1606
|
* on the context in which the devtools panel was opened.
|
|
1616
1607
|
*/
|
|
1617
|
-
get me():
|
|
1608
|
+
get me(): Identity;
|
|
1618
1609
|
/* Excluded from this release type: isNodeEnvironment */
|
|
1619
1610
|
/* Excluded from this release type: isOpenFinEnvironment */
|
|
1620
1611
|
/* Excluded from this release type: isBrowserEnvironment */
|
|
@@ -1712,7 +1703,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
|
|
1712
1703
|
* A base Channel event.
|
|
1713
1704
|
* @interface
|
|
1714
1705
|
*/
|
|
1715
|
-
declare type BaseEvent_2 =
|
|
1706
|
+
declare type BaseEvent_2 = NamedEvent & {
|
|
1716
1707
|
channelName: string;
|
|
1717
1708
|
channelId: string;
|
|
1718
1709
|
};
|
|
@@ -1782,7 +1773,6 @@ declare namespace BaseEvents {
|
|
|
1782
1773
|
NotCloseRequested,
|
|
1783
1774
|
PropagatedEventType,
|
|
1784
1775
|
PropagatedEvent,
|
|
1785
|
-
Payload_2 as Payload,
|
|
1786
1776
|
EventHandler,
|
|
1787
1777
|
BaseEvent,
|
|
1788
1778
|
IdentityEvent,
|
|
@@ -1834,12 +1824,11 @@ declare type BeforeUnloadUserDecision = {
|
|
|
1834
1824
|
/**
|
|
1835
1825
|
* Array of views that will close.
|
|
1836
1826
|
*/
|
|
1837
|
-
viewsToClose:
|
|
1827
|
+
viewsToClose: Identity_5[];
|
|
1838
1828
|
};
|
|
1839
1829
|
|
|
1840
1830
|
/**
|
|
1841
1831
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
|
1842
|
-
*
|
|
1843
1832
|
* @interface
|
|
1844
1833
|
*/
|
|
1845
1834
|
declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
@@ -1880,33 +1869,31 @@ declare type Bounds = {
|
|
|
1880
1869
|
* Generated after changes in a window's size and/or position.
|
|
1881
1870
|
* @interface
|
|
1882
1871
|
*/
|
|
1883
|
-
declare type BoundsChangedEvent =
|
|
1872
|
+
declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1884
1873
|
type: 'bounds-changed';
|
|
1885
1874
|
};
|
|
1886
1875
|
|
|
1887
|
-
declare type BoundsChangeEvent = BoundsEvent & {
|
|
1888
|
-
changeType: 0 | 1 | 2;
|
|
1889
|
-
};
|
|
1890
|
-
|
|
1891
1876
|
/**
|
|
1892
|
-
*
|
|
1877
|
+
* A general bounds change event without event type.
|
|
1893
1878
|
* @interface
|
|
1894
1879
|
*/
|
|
1895
|
-
declare type
|
|
1896
|
-
|
|
1880
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1881
|
+
changeType: 0 | 1 | 2;
|
|
1882
|
+
deferred: boolean;
|
|
1883
|
+
height: number;
|
|
1884
|
+
left: number;
|
|
1885
|
+
top: number;
|
|
1886
|
+
width: number;
|
|
1897
1887
|
};
|
|
1898
1888
|
|
|
1899
1889
|
/**
|
|
1900
|
-
*
|
|
1901
|
-
*
|
|
1890
|
+
* Generated during changes to a window's size and/or position.
|
|
1902
1891
|
* @interface
|
|
1903
1892
|
*/
|
|
1904
|
-
declare type
|
|
1905
|
-
|
|
1893
|
+
declare type BoundsChangingEvent = BoundsChangeEvent & {
|
|
1894
|
+
type: 'bounds-changing';
|
|
1906
1895
|
};
|
|
1907
1896
|
|
|
1908
|
-
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1909
|
-
|
|
1910
1897
|
/**
|
|
1911
1898
|
* A rule prescribing content creation in the browser.
|
|
1912
1899
|
*
|
|
@@ -1926,7 +1913,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
|
1926
1913
|
*
|
|
1927
1914
|
* @typeParam Type String key specifying the event to extract
|
|
1928
1915
|
*/
|
|
1929
|
-
declare type ByType<Type extends EventType> =
|
|
1916
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
1930
1917
|
|
|
1931
1918
|
/**
|
|
1932
1919
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
@@ -1935,7 +1922,7 @@ declare type ByType<Type extends EventType> = Payload_3<Type>;
|
|
|
1935
1922
|
*
|
|
1936
1923
|
* @typeParam Type String key specifying the event to extract
|
|
1937
1924
|
*/
|
|
1938
|
-
declare type ByType_2<Type extends EventType_2> =
|
|
1925
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
1939
1926
|
|
|
1940
1927
|
/**
|
|
1941
1928
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
@@ -1944,7 +1931,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
|
|
|
1944
1931
|
*
|
|
1945
1932
|
* @typeParam Type String key specifying the event to extract
|
|
1946
1933
|
*/
|
|
1947
|
-
declare type ByType_3<Type extends EventType_3> =
|
|
1934
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
1948
1935
|
|
|
1949
1936
|
/**
|
|
1950
1937
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
@@ -1953,7 +1940,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
|
|
|
1953
1940
|
*
|
|
1954
1941
|
* @typeParam Type String key specifying the event to extract
|
|
1955
1942
|
*/
|
|
1956
|
-
declare type ByType_4<Type extends EventType_4> =
|
|
1943
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
1957
1944
|
|
|
1958
1945
|
/**
|
|
1959
1946
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
@@ -1962,7 +1949,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
|
|
|
1962
1949
|
*
|
|
1963
1950
|
* @typeParam Type String key specifying the event to extract
|
|
1964
1951
|
*/
|
|
1965
|
-
declare type ByType_5<Type extends EventType_5> =
|
|
1952
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
1966
1953
|
|
|
1967
1954
|
/**
|
|
1968
1955
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
@@ -1971,7 +1958,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
|
|
|
1971
1958
|
*
|
|
1972
1959
|
* @typeParam Type String key specifying the event to extract
|
|
1973
1960
|
*/
|
|
1974
|
-
declare type ByType_6<Type extends EventType_6> =
|
|
1961
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
1975
1962
|
|
|
1976
1963
|
/**
|
|
1977
1964
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
@@ -1980,7 +1967,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
|
|
|
1980
1967
|
*
|
|
1981
1968
|
* @typeParam Type String key specifying the event to extract
|
|
1982
1969
|
*/
|
|
1983
|
-
declare type ByType_7<Type extends EventType_7> =
|
|
1970
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
1984
1971
|
|
|
1985
1972
|
/**
|
|
1986
1973
|
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
@@ -1989,7 +1976,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
|
|
|
1989
1976
|
*
|
|
1990
1977
|
* @typeParam Type String key specifying the event to extract
|
|
1991
1978
|
*/
|
|
1992
|
-
declare type ByType_8<Type extends EventType_8> =
|
|
1979
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
1993
1980
|
|
|
1994
1981
|
/**
|
|
1995
1982
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
|
@@ -1998,7 +1985,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
|
|
|
1998
1985
|
*
|
|
1999
1986
|
* @typeParam Type String key specifying the event to extract
|
|
2000
1987
|
*/
|
|
2001
|
-
declare type ByType_9<Type extends EventType_9> =
|
|
1988
|
+
declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
|
|
2002
1989
|
|
|
2003
1990
|
/**
|
|
2004
1991
|
* Configuration for page capture.
|
|
@@ -2940,18 +2927,6 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
2940
2927
|
childOptions: OpenFin.WindowOptions;
|
|
2941
2928
|
};
|
|
2942
2929
|
|
|
2943
|
-
/**
|
|
2944
|
-
* Control behavior for Chromium policies
|
|
2945
|
-
*
|
|
2946
|
-
* @interface
|
|
2947
|
-
*/
|
|
2948
|
-
declare type ChromiumPolicies = {
|
|
2949
|
-
/**
|
|
2950
|
-
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
2951
|
-
*/
|
|
2952
|
-
AutofillAddressEnabled?: PolicyOptions;
|
|
2953
|
-
};
|
|
2954
|
-
|
|
2955
2930
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
2956
2931
|
type: 'classic';
|
|
2957
2932
|
}
|
|
@@ -3000,7 +2975,7 @@ declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
|
3000
2975
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
3001
2976
|
* @interface
|
|
3002
2977
|
*/
|
|
3003
|
-
declare type ClientIdentity =
|
|
2978
|
+
declare type ClientIdentity = Identity_5 & {
|
|
3004
2979
|
/**
|
|
3005
2980
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
|
3006
2981
|
*/
|
|
@@ -3233,7 +3208,7 @@ declare type CloseViewOptions = {
|
|
|
3233
3208
|
/**
|
|
3234
3209
|
*View to be closed.
|
|
3235
3210
|
*/
|
|
3236
|
-
viewIdentity:
|
|
3211
|
+
viewIdentity: Identity_5;
|
|
3237
3212
|
};
|
|
3238
3213
|
|
|
3239
3214
|
/**
|
|
@@ -3243,7 +3218,7 @@ declare type CloseViewPayload = {
|
|
|
3243
3218
|
/**
|
|
3244
3219
|
*View to be closed.
|
|
3245
3220
|
*/
|
|
3246
|
-
view:
|
|
3221
|
+
view: Identity_5;
|
|
3247
3222
|
/**
|
|
3248
3223
|
* The target layout identity where this view should be closed. If not provided, will resolve to the
|
|
3249
3224
|
* visible layout.
|
|
@@ -3261,7 +3236,7 @@ declare interface CloseWindowPayload {
|
|
|
3261
3236
|
*
|
|
3262
3237
|
* Identity of the Window
|
|
3263
3238
|
*/
|
|
3264
|
-
windowId:
|
|
3239
|
+
windowId: Identity_5;
|
|
3265
3240
|
options: {
|
|
3266
3241
|
/**
|
|
3267
3242
|
* @defaultValue false
|
|
@@ -3379,7 +3354,7 @@ declare type ConstViewOptions = {
|
|
|
3379
3354
|
/**
|
|
3380
3355
|
* The identity of the window this view should be attached to.
|
|
3381
3356
|
*/
|
|
3382
|
-
target:
|
|
3357
|
+
target: Identity_5;
|
|
3383
3358
|
/**
|
|
3384
3359
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3385
3360
|
*/
|
|
@@ -3463,10 +3438,6 @@ declare type ConstViewOptions = {
|
|
|
3463
3438
|
*/
|
|
3464
3439
|
enabled: boolean;
|
|
3465
3440
|
};
|
|
3466
|
-
/**
|
|
3467
|
-
* Control which options to ignore when creating a Platform View.
|
|
3468
|
-
*/
|
|
3469
|
-
excludeOptions: ExcludeOptions;
|
|
3470
3441
|
};
|
|
3471
3442
|
|
|
3472
3443
|
/**
|
|
@@ -3506,16 +3477,6 @@ declare type ConstWindowOptions = {
|
|
|
3506
3477
|
* Default is white.
|
|
3507
3478
|
*/
|
|
3508
3479
|
backgroundColor: string;
|
|
3509
|
-
/**
|
|
3510
|
-
* @defaultValue false
|
|
3511
|
-
*
|
|
3512
|
-
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3513
|
-
* This also affects the Page Visibility API.
|
|
3514
|
-
*
|
|
3515
|
-
* When `true`, the page is throttled whether it is hidden or not.
|
|
3516
|
-
*
|
|
3517
|
-
*/
|
|
3518
|
-
backgroundThrottling: boolean;
|
|
3519
3480
|
/**
|
|
3520
3481
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3521
3482
|
*/
|
|
@@ -3608,7 +3569,7 @@ declare type ConstWindowOptions = {
|
|
|
3608
3569
|
/**
|
|
3609
3570
|
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
3610
3571
|
*/
|
|
3611
|
-
modalParentIdentity:
|
|
3572
|
+
modalParentIdentity: Identity_5;
|
|
3612
3573
|
/**
|
|
3613
3574
|
* The name of the window.
|
|
3614
3575
|
*/
|
|
@@ -3626,9 +3587,7 @@ declare type ConstWindowOptions = {
|
|
|
3626
3587
|
*/
|
|
3627
3588
|
preloadScripts: PreloadScript[];
|
|
3628
3589
|
/**
|
|
3629
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
3630
|
-
* 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.
|
|
3631
|
-
* @remarks Will only be used if pages are on the same origin.
|
|
3590
|
+
* String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
|
|
3632
3591
|
*/
|
|
3633
3592
|
processAffinity: string;
|
|
3634
3593
|
/**
|
|
@@ -3675,6 +3634,11 @@ declare type ConstWindowOptions = {
|
|
|
3675
3634
|
* @deprecated - use `icon` instead.
|
|
3676
3635
|
*/
|
|
3677
3636
|
taskbarIcon: string;
|
|
3637
|
+
/**
|
|
3638
|
+
* Specify a taskbar group for the window.
|
|
3639
|
+
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
3640
|
+
*/
|
|
3641
|
+
taskbarIconGroup: string;
|
|
3678
3642
|
/**
|
|
3679
3643
|
* @defaultValue "about:blank"
|
|
3680
3644
|
*
|
|
@@ -3711,10 +3675,6 @@ declare type ConstWindowOptions = {
|
|
|
3711
3675
|
* 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.
|
|
3712
3676
|
*/
|
|
3713
3677
|
inheritance?: Partial<InheritableOptions>;
|
|
3714
|
-
/**
|
|
3715
|
-
* Control which options to ignore when creating a Platform Window.
|
|
3716
|
-
*/
|
|
3717
|
-
excludeOptions: ExcludeOptions;
|
|
3718
3678
|
};
|
|
3719
3679
|
|
|
3720
3680
|
/**
|
|
@@ -3727,7 +3687,6 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3727
3687
|
|
|
3728
3688
|
/**
|
|
3729
3689
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3730
|
-
* @interface
|
|
3731
3690
|
*/
|
|
3732
3691
|
declare type ContentBlockedEvent = NamedEvent & {
|
|
3733
3692
|
type: 'content-blocked';
|
|
@@ -4093,13 +4052,13 @@ declare type CreateViewPayload = {
|
|
|
4093
4052
|
* Window the view will be added to. If no target is provided, a new window will be created.
|
|
4094
4053
|
*/
|
|
4095
4054
|
target?: CreateViewTarget;
|
|
4096
|
-
targetView?:
|
|
4055
|
+
targetView?: Identity_5;
|
|
4097
4056
|
};
|
|
4098
4057
|
|
|
4099
4058
|
/**
|
|
4100
4059
|
* @interface
|
|
4101
4060
|
*/
|
|
4102
|
-
declare type CreateViewTarget = (
|
|
4061
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
|
4103
4062
|
/**
|
|
4104
4063
|
* If specified, view creation will not attach to a window and caller must
|
|
4105
4064
|
* insert the view into the layout explicitly
|
|
@@ -4384,10 +4343,6 @@ declare type DomainSettingsRule = {
|
|
|
4384
4343
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4385
4344
|
*/
|
|
4386
4345
|
options: PerDomainSettings;
|
|
4387
|
-
/**
|
|
4388
|
-
* Options to use when comparing URIs to the `match` patterns.
|
|
4389
|
-
*/
|
|
4390
|
-
matchOptions?: RuleMatchOptions;
|
|
4391
4346
|
};
|
|
4392
4347
|
|
|
4393
4348
|
/**
|
|
@@ -4545,7 +4500,7 @@ declare type EmitterAccessor = string[];
|
|
|
4545
4500
|
declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType extends EmitterEvent['type'] = EmitterEvent['type']> extends Base {
|
|
4546
4501
|
#private;
|
|
4547
4502
|
private topic;
|
|
4548
|
-
protected identity:
|
|
4503
|
+
protected identity: ApplicationIdentity;
|
|
4549
4504
|
constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
|
|
4550
4505
|
eventNames: () => (string | symbol)[];
|
|
4551
4506
|
/* Excluded from this release type: emit */
|
|
@@ -4620,17 +4575,20 @@ declare type EndLoadEvent = BaseEvent_5 & {
|
|
|
4620
4575
|
|
|
4621
4576
|
/**
|
|
4622
4577
|
* Generated at the end of a user-driven change to a window's size or position.
|
|
4623
|
-
*
|
|
4624
4578
|
* @interface
|
|
4625
4579
|
*/
|
|
4626
4580
|
declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
4627
4581
|
type: 'end-user-bounds-changing';
|
|
4628
4582
|
};
|
|
4629
4583
|
|
|
4584
|
+
declare type Entity = OpenFin.ApplicationType;
|
|
4585
|
+
|
|
4586
|
+
declare type EntityInfo = OpenFin.EntityInfo;
|
|
4587
|
+
|
|
4630
4588
|
/**
|
|
4631
4589
|
* @interface
|
|
4632
4590
|
*/
|
|
4633
|
-
declare type
|
|
4591
|
+
declare type EntityInfo_2 = {
|
|
4634
4592
|
uuid: string;
|
|
4635
4593
|
name: string;
|
|
4636
4594
|
entityType: EntityType_4;
|
|
@@ -4681,12 +4639,6 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
|
4681
4639
|
} : never;
|
|
4682
4640
|
|
|
4683
4641
|
declare interface Environment {
|
|
4684
|
-
/**
|
|
4685
|
-
* Returns the version of the adapter synchronously.
|
|
4686
|
-
* In OpenFin, this is the version of the runtime.
|
|
4687
|
-
* Elsewhere (e.g. Node.js), this is the version of the adapter, NOT the runtime.
|
|
4688
|
-
*/
|
|
4689
|
-
getAdapterVersionSync(): string;
|
|
4690
4642
|
layoutAllowedInContext(fin: OpenFin.Fin<OpenFin.EntityType>): boolean;
|
|
4691
4643
|
initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
|
|
4692
4644
|
applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
|
|
@@ -4748,7 +4700,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
|
4748
4700
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
4749
4701
|
* from which they propagate).
|
|
4750
4702
|
*/
|
|
4751
|
-
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent
|
|
4703
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
|
4752
4704
|
|
|
4753
4705
|
/**
|
|
4754
4706
|
* [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.
|
|
@@ -4780,7 +4732,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
|
4780
4732
|
*/
|
|
4781
4733
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
4782
4734
|
target: OpenFin.Identity;
|
|
4783
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent
|
|
4735
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
4784
4736
|
|
|
4785
4737
|
/**
|
|
4786
4738
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
|
@@ -4829,7 +4781,9 @@ declare class EventAggregator extends EmitterMap {
|
|
|
4829
4781
|
* @remarks Selects the correct type for the event
|
|
4830
4782
|
* payload from the provided union based on the provided string literal type.
|
|
4831
4783
|
*/
|
|
4832
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
|
4784
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
|
|
4785
|
+
type: EventType;
|
|
4786
|
+
}>, ...args: any[]) => void;
|
|
4833
4787
|
|
|
4834
4788
|
declare namespace Events {
|
|
4835
4789
|
export {
|
|
@@ -4893,18 +4847,6 @@ declare type EventType_9 = Event_12['type'];
|
|
|
4893
4847
|
|
|
4894
4848
|
/* Excluded from this release type: EventWithId */
|
|
4895
4849
|
|
|
4896
|
-
/**
|
|
4897
|
-
* @interface
|
|
4898
|
-
*/
|
|
4899
|
-
declare type ExcludeOptions = {
|
|
4900
|
-
/**
|
|
4901
|
-
* @defaultValue false
|
|
4902
|
-
*
|
|
4903
|
-
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
4904
|
-
*/
|
|
4905
|
-
preloadScripts: boolean;
|
|
4906
|
-
};
|
|
4907
|
-
|
|
4908
4850
|
/* Excluded from this release type: ExcludeRequested */
|
|
4909
4851
|
|
|
4910
4852
|
declare type ExistingConnectConfig = ConfigWithUuid & {
|
|
@@ -4920,105 +4862,6 @@ declare type ExitCode = {
|
|
|
4920
4862
|
exitCode: number;
|
|
4921
4863
|
};
|
|
4922
4864
|
|
|
4923
|
-
declare type ExtensionEvent = SecurityRealmEvent & {
|
|
4924
|
-
/**
|
|
4925
|
-
* Runtime extension whose status has been (possibly) modified
|
|
4926
|
-
*/
|
|
4927
|
-
extension: string;
|
|
4928
|
-
};
|
|
4929
|
-
|
|
4930
|
-
/**
|
|
4931
|
-
* @interface
|
|
4932
|
-
*/
|
|
4933
|
-
declare type ExtensionInfo = {
|
|
4934
|
-
extensionId: string;
|
|
4935
|
-
name: string;
|
|
4936
|
-
enabled: boolean;
|
|
4937
|
-
};
|
|
4938
|
-
|
|
4939
|
-
/**
|
|
4940
|
-
* An event that fires when an extension is installed in the security realm.
|
|
4941
|
-
*
|
|
4942
|
-
* @interface
|
|
4943
|
-
*/
|
|
4944
|
-
declare type ExtensionInstalledEvent = ExtensionEvent & {
|
|
4945
|
-
type: 'extension-installed';
|
|
4946
|
-
};
|
|
4947
|
-
|
|
4948
|
-
/**
|
|
4949
|
-
* An event that fires when an extension fails to install in the security realm.
|
|
4950
|
-
*
|
|
4951
|
-
* @interface
|
|
4952
|
-
*/
|
|
4953
|
-
declare type ExtensionInstallFailedEvent = ExtensionEvent & {
|
|
4954
|
-
type: 'extension-install-failed';
|
|
4955
|
-
};
|
|
4956
|
-
|
|
4957
|
-
/**
|
|
4958
|
-
* An event that fires when extensions are disabled in the security realm.
|
|
4959
|
-
*
|
|
4960
|
-
* @interface
|
|
4961
|
-
*/
|
|
4962
|
-
declare type ExtensionsDisabledEvent = ExtensionsEvent & {
|
|
4963
|
-
type: 'extensions-disabled';
|
|
4964
|
-
};
|
|
4965
|
-
|
|
4966
|
-
/**
|
|
4967
|
-
* An event that fires when extensions are enabled in the security realm.
|
|
4968
|
-
*
|
|
4969
|
-
* @interface
|
|
4970
|
-
*/
|
|
4971
|
-
declare type ExtensionsEnabledEvent = ExtensionsEvent & {
|
|
4972
|
-
type: 'extensions-enabled';
|
|
4973
|
-
};
|
|
4974
|
-
|
|
4975
|
-
declare type ExtensionsEvent = SecurityRealmEvent & {
|
|
4976
|
-
/**
|
|
4977
|
-
* Runtime extensions whose status has been (possibly) modified
|
|
4978
|
-
*/
|
|
4979
|
-
extensions: string[];
|
|
4980
|
-
};
|
|
4981
|
-
|
|
4982
|
-
/**
|
|
4983
|
-
* An event that fires when requested extensions are not allowed to be installed in the security realm.
|
|
4984
|
-
*
|
|
4985
|
-
* @interface
|
|
4986
|
-
*/
|
|
4987
|
-
declare type ExtensionsExcludedEvent = ExtensionsEvent & {
|
|
4988
|
-
type: 'extensions-excluded';
|
|
4989
|
-
};
|
|
4990
|
-
|
|
4991
|
-
/**
|
|
4992
|
-
* An event that fires when extension initialization fails on initial app launch. Users may attempt to
|
|
4993
|
-
* re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
|
|
4994
|
-
* to manual extension refreshes (users should catch the error normally).
|
|
4995
|
-
*/
|
|
4996
|
-
declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
|
|
4997
|
-
type: 'extensions-initialization-failed';
|
|
4998
|
-
/**
|
|
4999
|
-
* The error that caused the extension initialization failure
|
|
5000
|
-
*/
|
|
5001
|
-
error: Error;
|
|
5002
|
-
};
|
|
5003
|
-
|
|
5004
|
-
/**
|
|
5005
|
-
* An event that fires when extensions are installed in the security realm.
|
|
5006
|
-
*
|
|
5007
|
-
* @interface
|
|
5008
|
-
*/
|
|
5009
|
-
declare type ExtensionsInstalledEvent = ExtensionsEvent & {
|
|
5010
|
-
type: 'extensions-installed';
|
|
5011
|
-
};
|
|
5012
|
-
|
|
5013
|
-
/**
|
|
5014
|
-
* An event that fires when extensions fail to install in the security realm.
|
|
5015
|
-
*
|
|
5016
|
-
* @interface
|
|
5017
|
-
*/
|
|
5018
|
-
declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
5019
|
-
type: 'extensions-install-failed';
|
|
5020
|
-
};
|
|
5021
|
-
|
|
5022
4865
|
/**
|
|
5023
4866
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
5024
4867
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
@@ -5076,7 +4919,7 @@ declare namespace ExternalApplicationEvents {
|
|
|
5076
4919
|
ExternalApplicationEvent,
|
|
5077
4920
|
EventType_4 as EventType,
|
|
5078
4921
|
ExternalApplicationEventType,
|
|
5079
|
-
|
|
4922
|
+
Payload_5 as Payload,
|
|
5080
4923
|
ByType_4 as ByType
|
|
5081
4924
|
}
|
|
5082
4925
|
}
|
|
@@ -5090,7 +4933,7 @@ declare type ExternalApplicationEventType = EventType_4;
|
|
|
5090
4933
|
* @interface
|
|
5091
4934
|
*/
|
|
5092
4935
|
declare type ExternalApplicationInfo = {
|
|
5093
|
-
parent:
|
|
4936
|
+
parent: Identity_5;
|
|
5094
4937
|
};
|
|
5095
4938
|
|
|
5096
4939
|
/**
|
|
@@ -5633,10 +5476,6 @@ declare type FileDownloadEvent = {
|
|
|
5633
5476
|
* The number of bytes of the item that have already been downloaded.
|
|
5634
5477
|
*/
|
|
5635
5478
|
downloadedBytes: number;
|
|
5636
|
-
/**
|
|
5637
|
-
* Unique identifier for the downloaded file.
|
|
5638
|
-
*/
|
|
5639
|
-
fileUuid: string;
|
|
5640
5479
|
} & NamedEvent;
|
|
5641
5480
|
|
|
5642
5481
|
/**
|
|
@@ -5870,7 +5709,7 @@ declare namespace FrameEvents {
|
|
|
5870
5709
|
FrameEvent,
|
|
5871
5710
|
EventType_5 as EventType,
|
|
5872
5711
|
FrameEventType,
|
|
5873
|
-
|
|
5712
|
+
Payload_6 as Payload,
|
|
5874
5713
|
ByType_5 as ByType
|
|
5875
5714
|
}
|
|
5876
5715
|
}
|
|
@@ -5888,7 +5727,7 @@ declare type FrameInfo = {
|
|
|
5888
5727
|
uuid: string;
|
|
5889
5728
|
url: string;
|
|
5890
5729
|
entityType: EntityType_4;
|
|
5891
|
-
parent:
|
|
5730
|
+
parent: Identity_5;
|
|
5892
5731
|
};
|
|
5893
5732
|
|
|
5894
5733
|
/**
|
|
@@ -5963,10 +5802,12 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
5963
5802
|
entityType: string;
|
|
5964
5803
|
};
|
|
5965
5804
|
|
|
5805
|
+
declare type GetLogRequestType = OpenFin.GetLogRequestType;
|
|
5806
|
+
|
|
5966
5807
|
/**
|
|
5967
5808
|
* @interface
|
|
5968
5809
|
*/
|
|
5969
|
-
declare type
|
|
5810
|
+
declare type GetLogRequestType_2 = {
|
|
5970
5811
|
/**
|
|
5971
5812
|
* The name of the running application
|
|
5972
5813
|
*/
|
|
@@ -5986,7 +5827,7 @@ declare type GetWindowContextPayload = {
|
|
|
5986
5827
|
/**
|
|
5987
5828
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
5988
5829
|
*/
|
|
5989
|
-
target:
|
|
5830
|
+
target: Identity_5;
|
|
5990
5831
|
};
|
|
5991
5832
|
|
|
5992
5833
|
/**
|
|
@@ -6108,7 +5949,7 @@ declare namespace GlobalHotkeyEvents {
|
|
|
6108
5949
|
GlobalHotkeyEvent,
|
|
6109
5950
|
EventType_6 as EventType,
|
|
6110
5951
|
GlobalHotkeyEventType,
|
|
6111
|
-
|
|
5952
|
+
Payload_7 as Payload,
|
|
6112
5953
|
ByType_6 as ByType
|
|
6113
5954
|
}
|
|
6114
5955
|
}
|
|
@@ -6252,6 +6093,8 @@ declare type Identity_2 = OpenFin.Identity;
|
|
|
6252
6093
|
|
|
6253
6094
|
declare type Identity_3 = OpenFin.Identity;
|
|
6254
6095
|
|
|
6096
|
+
declare type Identity_4 = OpenFin.Identity;
|
|
6097
|
+
|
|
6255
6098
|
/**
|
|
6256
6099
|
* Unique identifier for a window, view or iframe.
|
|
6257
6100
|
*
|
|
@@ -6260,7 +6103,7 @@ declare type Identity_3 = OpenFin.Identity;
|
|
|
6260
6103
|
*
|
|
6261
6104
|
* @interface
|
|
6262
6105
|
*/
|
|
6263
|
-
declare type
|
|
6106
|
+
declare type Identity_5 = {
|
|
6264
6107
|
/**
|
|
6265
6108
|
* Universally unique identifier of the application that owns the component.
|
|
6266
6109
|
*/
|
|
@@ -6419,10 +6262,12 @@ declare type InstallationInfo = {
|
|
|
6419
6262
|
cachedManifest: any;
|
|
6420
6263
|
};
|
|
6421
6264
|
|
|
6265
|
+
declare type InstalledApps = OpenFin.InstalledApps;
|
|
6266
|
+
|
|
6422
6267
|
/**
|
|
6423
6268
|
* @interface
|
|
6424
6269
|
*/
|
|
6425
|
-
declare type
|
|
6270
|
+
declare type InstalledApps_2 = {
|
|
6426
6271
|
[key: string]: InstallationInfo;
|
|
6427
6272
|
};
|
|
6428
6273
|
|
|
@@ -7193,7 +7038,7 @@ declare class InteropBroker extends Base {
|
|
|
7193
7038
|
* @param _id the identity tryinc to connect
|
|
7194
7039
|
* @param _connectionPayload optional payload to use in custom implementations, will be undefined by default
|
|
7195
7040
|
*/
|
|
7196
|
-
isConnectionAuthorized(_id:
|
|
7041
|
+
isConnectionAuthorized(_id: Identity_3, _connectionPayload?: any): Promise<boolean> | boolean;
|
|
7197
7042
|
/**
|
|
7198
7043
|
* Called before every action to check if this entity should be allowed to take the action.
|
|
7199
7044
|
* Return false to prevent the action
|
|
@@ -8111,7 +7956,7 @@ declare class Layout extends Base {
|
|
|
8111
7956
|
* await layout.replaceView(viewToReplace.identity, newViewConfig);
|
|
8112
7957
|
* ```
|
|
8113
7958
|
*/
|
|
8114
|
-
replaceView: (viewToReplace:
|
|
7959
|
+
replaceView: (viewToReplace: Identity_4, newView: OpenFin.PlatformViewCreationOptions) => Promise<void>;
|
|
8115
7960
|
/**
|
|
8116
7961
|
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
8117
7962
|
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
@@ -8166,7 +8011,7 @@ declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn |
|
|
|
8166
8011
|
/**
|
|
8167
8012
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
|
8168
8013
|
*/
|
|
8169
|
-
declare type LayoutDOMEvent =
|
|
8014
|
+
declare type LayoutDOMEvent = Identity_5 & {
|
|
8170
8015
|
type: string;
|
|
8171
8016
|
topic: 'openfin-DOM-event';
|
|
8172
8017
|
tabSelector: string;
|
|
@@ -8184,7 +8029,7 @@ declare namespace LayoutDOMEvents {
|
|
|
8184
8029
|
LayoutStateChangedEvent,
|
|
8185
8030
|
Event_12 as Event,
|
|
8186
8031
|
EventType_9 as EventType,
|
|
8187
|
-
|
|
8032
|
+
Payload_10 as Payload,
|
|
8188
8033
|
ByType_9 as ByType
|
|
8189
8034
|
}
|
|
8190
8035
|
}
|
|
@@ -8227,7 +8072,7 @@ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
|
|
|
8227
8072
|
/**
|
|
8228
8073
|
* @interface
|
|
8229
8074
|
*/
|
|
8230
|
-
declare type LayoutIdentity =
|
|
8075
|
+
declare type LayoutIdentity = Identity_5 & {
|
|
8231
8076
|
/**
|
|
8232
8077
|
* The name of the layout in a given window.
|
|
8233
8078
|
*/
|
|
@@ -8242,7 +8087,10 @@ declare type LayoutIdentity = Identity_4 & {
|
|
|
8242
8087
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8243
8088
|
type: 'layout-initialized';
|
|
8244
8089
|
layoutIdentity: OpenFin.LayoutIdentity;
|
|
8245
|
-
ofViews:
|
|
8090
|
+
ofViews: {
|
|
8091
|
+
identity: OpenFin.Identity;
|
|
8092
|
+
entityType: 'view';
|
|
8093
|
+
}[];
|
|
8246
8094
|
};
|
|
8247
8095
|
|
|
8248
8096
|
/**
|
|
@@ -8333,7 +8181,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8333
8181
|
* @param identity
|
|
8334
8182
|
* @returns LayoutIdentity | undefined
|
|
8335
8183
|
*/
|
|
8336
|
-
resolveLayoutIdentity(identity?:
|
|
8184
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
|
8337
8185
|
/**
|
|
8338
8186
|
* @experimental
|
|
8339
8187
|
*
|
|
@@ -8350,7 +8198,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8350
8198
|
/**
|
|
8351
8199
|
* @experimental
|
|
8352
8200
|
*/
|
|
8353
|
-
getLayoutIdentityForView(viewIdentity:
|
|
8201
|
+
getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
|
|
8354
8202
|
/**
|
|
8355
8203
|
* @experimental
|
|
8356
8204
|
*/
|
|
@@ -8654,10 +8502,12 @@ declare type Listener<T extends {
|
|
|
8654
8502
|
type: string;
|
|
8655
8503
|
}> = (payload: T) => void;
|
|
8656
8504
|
|
|
8505
|
+
declare type LogInfo = OpenFin.LogInfo;
|
|
8506
|
+
|
|
8657
8507
|
/**
|
|
8658
8508
|
* @interface
|
|
8659
8509
|
*/
|
|
8660
|
-
declare type
|
|
8510
|
+
declare type LogInfo_2 = {
|
|
8661
8511
|
/**
|
|
8662
8512
|
* The filename of the log
|
|
8663
8513
|
*/
|
|
@@ -8672,6 +8522,8 @@ declare type LogInfo = {
|
|
|
8672
8522
|
date: string;
|
|
8673
8523
|
};
|
|
8674
8524
|
|
|
8525
|
+
declare type LogLevel = OpenFin.LogLevel;
|
|
8526
|
+
|
|
8675
8527
|
/**
|
|
8676
8528
|
* Describes the minimum level (inclusive) above which logs will be written.
|
|
8677
8529
|
*
|
|
@@ -8681,7 +8533,7 @@ declare type LogInfo = {
|
|
|
8681
8533
|
* `error` and above<br>
|
|
8682
8534
|
* `fatal`: fatal only, indicates a crash is imminent
|
|
8683
8535
|
*/
|
|
8684
|
-
declare type
|
|
8536
|
+
declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
8685
8537
|
|
|
8686
8538
|
/**
|
|
8687
8539
|
* @interface
|
|
@@ -9066,16 +8918,6 @@ declare type MutableViewOptions = {
|
|
|
9066
8918
|
preventDragOut: boolean;
|
|
9067
8919
|
interop?: InteropConfig;
|
|
9068
8920
|
/* Excluded from this release type: _internalWorkspaceData */
|
|
9069
|
-
/**
|
|
9070
|
-
* {@inheritDoc ViewThrottling}
|
|
9071
|
-
*
|
|
9072
|
-
* @defaultValue 'enabled'
|
|
9073
|
-
*/
|
|
9074
|
-
throttling: ViewThrottling;
|
|
9075
|
-
/**
|
|
9076
|
-
* {@inheritDoc ChromiumPolicies}
|
|
9077
|
-
*/
|
|
9078
|
-
chromiumPolicies: ChromiumPolicies;
|
|
9079
8921
|
};
|
|
9080
8922
|
|
|
9081
8923
|
/**
|
|
@@ -9316,27 +9158,9 @@ declare type MutableWindowOptions = {
|
|
|
9316
9158
|
* Shows the window's icon in the taskbar.
|
|
9317
9159
|
*/
|
|
9318
9160
|
showTaskbarIcon: boolean;
|
|
9319
|
-
/**
|
|
9320
|
-
* Specify a taskbar group for the window.
|
|
9321
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
9322
|
-
* @remarks It's only updatable when `enableJumpList` is set to false.
|
|
9323
|
-
*/
|
|
9324
|
-
taskbarIconGroup: string;
|
|
9325
9161
|
interop: InteropConfig;
|
|
9326
9162
|
/* Excluded from this release type: _internalWorkspaceData */
|
|
9327
9163
|
/* Excluded from this release type: workspacePlatform */
|
|
9328
|
-
/**
|
|
9329
|
-
* {@inheritDoc WindowThrottling}
|
|
9330
|
-
*
|
|
9331
|
-
* @defaultValue 'enabled'
|
|
9332
|
-
*
|
|
9333
|
-
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9334
|
-
*/
|
|
9335
|
-
throttling: WindowThrottling;
|
|
9336
|
-
/**
|
|
9337
|
-
* {@inheritDoc ChromiumPolicies}
|
|
9338
|
-
*/
|
|
9339
|
-
chromiumPolicies: ChromiumPolicies;
|
|
9340
9164
|
};
|
|
9341
9165
|
|
|
9342
9166
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
|
@@ -9378,42 +9202,10 @@ declare type NavigationRules = {
|
|
|
9378
9202
|
allowlist?: string[];
|
|
9379
9203
|
/** Forbidden URLs for navigation. */
|
|
9380
9204
|
denylist?: string[];
|
|
9381
|
-
/**
|
|
9382
|
-
* Options to use when comparing URIs to the `allowlist` and `denylist` patterns.
|
|
9383
|
-
*/
|
|
9384
|
-
matchOptions?: RuleMatchOptions;
|
|
9385
9205
|
};
|
|
9386
9206
|
|
|
9387
9207
|
declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
|
|
9388
9208
|
|
|
9389
|
-
declare interface NodeNetworkInterfaceBase {
|
|
9390
|
-
address: string;
|
|
9391
|
-
netmask: string;
|
|
9392
|
-
mac: string;
|
|
9393
|
-
internal: boolean;
|
|
9394
|
-
cidr: string | null;
|
|
9395
|
-
}
|
|
9396
|
-
|
|
9397
|
-
declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
|
|
9398
|
-
|
|
9399
|
-
declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
|
|
9400
|
-
family: 'IPv4';
|
|
9401
|
-
scopeid?: undefined;
|
|
9402
|
-
}
|
|
9403
|
-
|
|
9404
|
-
declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
|
|
9405
|
-
family: 'IPv6';
|
|
9406
|
-
scopeid: number;
|
|
9407
|
-
}
|
|
9408
|
-
|
|
9409
|
-
declare interface NodeUserInfo {
|
|
9410
|
-
username: string;
|
|
9411
|
-
uid: number;
|
|
9412
|
-
gid: number;
|
|
9413
|
-
shell: string | null;
|
|
9414
|
-
homedir: string;
|
|
9415
|
-
}
|
|
9416
|
-
|
|
9417
9209
|
/**
|
|
9418
9210
|
* @interface
|
|
9419
9211
|
*/
|
|
@@ -9505,19 +9297,18 @@ declare namespace OpenFin {
|
|
|
9505
9297
|
LayoutPosition,
|
|
9506
9298
|
WebContent,
|
|
9507
9299
|
PlatformProvider,
|
|
9508
|
-
ApplicationIdentity,
|
|
9509
|
-
|
|
9300
|
+
ApplicationIdentity_2 as ApplicationIdentity,
|
|
9301
|
+
Identity_5 as Identity,
|
|
9510
9302
|
ClientIdentity,
|
|
9511
9303
|
ClientInfo,
|
|
9512
9304
|
ClientIdentityMultiRuntime,
|
|
9513
9305
|
ClientConnectionPayload,
|
|
9514
|
-
EntityInfo,
|
|
9306
|
+
EntityInfo_2 as EntityInfo,
|
|
9515
9307
|
EntityType_4 as EntityType,
|
|
9516
9308
|
Bounds,
|
|
9517
9309
|
WindowBounds,
|
|
9518
9310
|
Rectangle,
|
|
9519
9311
|
ApplicationCreationOptions,
|
|
9520
|
-
TimeZones,
|
|
9521
9312
|
ApplicationOptions,
|
|
9522
9313
|
CustomProtocolMissingState,
|
|
9523
9314
|
CustomProtocolMalformedState,
|
|
@@ -9547,11 +9338,8 @@ declare namespace OpenFin {
|
|
|
9547
9338
|
ViewVisibilityOptions,
|
|
9548
9339
|
WindowState,
|
|
9549
9340
|
AutoplayPolicyOptions,
|
|
9550
|
-
ExcludeOptions,
|
|
9551
9341
|
ConstWindowOptions,
|
|
9552
9342
|
InheritableOptions,
|
|
9553
|
-
PolicyOptions,
|
|
9554
|
-
ChromiumPolicies,
|
|
9555
9343
|
MutableWindowOptions,
|
|
9556
9344
|
WorkspacePlatformOptions,
|
|
9557
9345
|
WebRequestHeader,
|
|
@@ -9562,7 +9350,6 @@ declare namespace OpenFin {
|
|
|
9562
9350
|
Api,
|
|
9563
9351
|
ApiSettings,
|
|
9564
9352
|
InjectionType,
|
|
9565
|
-
RuleMatchOptions,
|
|
9566
9353
|
NavigationRules,
|
|
9567
9354
|
ContentNavigation,
|
|
9568
9355
|
ContentRedirect,
|
|
@@ -9577,17 +9364,12 @@ declare namespace OpenFin {
|
|
|
9577
9364
|
AutoResizeOptions,
|
|
9578
9365
|
InteropConfig,
|
|
9579
9366
|
ViewInfo,
|
|
9580
|
-
WindowThrottling,
|
|
9581
|
-
ViewThrottling,
|
|
9582
9367
|
UpdatableViewOptions,
|
|
9583
9368
|
ViewCreationOptions,
|
|
9584
9369
|
MutableViewOptions,
|
|
9585
9370
|
ViewOptions,
|
|
9586
9371
|
ConstViewOptions,
|
|
9587
9372
|
ViewState,
|
|
9588
|
-
ViewCreationSuccess,
|
|
9589
|
-
ViewCreationFailure,
|
|
9590
|
-
ViewCreationResult,
|
|
9591
9373
|
Certificate,
|
|
9592
9374
|
HostContextChangedPayload,
|
|
9593
9375
|
ApplySnapshotOptions,
|
|
@@ -9649,9 +9431,8 @@ declare namespace OpenFin {
|
|
|
9649
9431
|
Time,
|
|
9650
9432
|
CpuInfo,
|
|
9651
9433
|
GpuInfo,
|
|
9652
|
-
OSInfo,
|
|
9653
9434
|
HostSpecs,
|
|
9654
|
-
PrinterInfo,
|
|
9435
|
+
PrinterInfo_2 as PrinterInfo,
|
|
9655
9436
|
Dpi,
|
|
9656
9437
|
Margins,
|
|
9657
9438
|
PrintOptions,
|
|
@@ -9759,24 +9540,24 @@ declare namespace OpenFin {
|
|
|
9759
9540
|
BeforeUnloadUserDecision,
|
|
9760
9541
|
ViewStatuses,
|
|
9761
9542
|
CloseWindowPayload,
|
|
9762
|
-
ProxyInfo,
|
|
9763
|
-
ProxyConfig,
|
|
9543
|
+
ProxyInfo_2 as ProxyInfo,
|
|
9544
|
+
ProxyConfig_2 as ProxyConfig,
|
|
9764
9545
|
ProxySystemInfo,
|
|
9765
9546
|
ChannelAction_2 as ChannelAction,
|
|
9766
9547
|
ChannelMiddleware_2 as ChannelMiddleware,
|
|
9767
9548
|
ErrorMiddleware_2 as ErrorMiddleware,
|
|
9768
|
-
ApplicationState,
|
|
9769
|
-
InstalledApps,
|
|
9549
|
+
ApplicationState_2 as ApplicationState,
|
|
9550
|
+
InstalledApps_2 as InstalledApps,
|
|
9770
9551
|
InstallationInfo,
|
|
9771
|
-
GetLogRequestType,
|
|
9772
|
-
LogInfo,
|
|
9552
|
+
GetLogRequestType_2 as GetLogRequestType,
|
|
9553
|
+
LogInfo_2 as LogInfo,
|
|
9773
9554
|
SendApplicationLogResponse,
|
|
9774
|
-
LogLevel,
|
|
9555
|
+
LogLevel_2 as LogLevel,
|
|
9775
9556
|
PermissionState_2 as PermissionState,
|
|
9776
|
-
RegistryInfo,
|
|
9557
|
+
RegistryInfo_2 as RegistryInfo,
|
|
9777
9558
|
ApplicationType,
|
|
9778
9559
|
WindowInfo,
|
|
9779
|
-
ApplicationWindowInfo,
|
|
9560
|
+
ApplicationWindowInfo_2 as ApplicationWindowInfo,
|
|
9780
9561
|
WindowDetail,
|
|
9781
9562
|
LayoutPresetType,
|
|
9782
9563
|
LayoutIdentity,
|
|
@@ -9830,8 +9611,6 @@ declare namespace OpenFin {
|
|
|
9830
9611
|
ChannelProviderDisconnectionListener,
|
|
9831
9612
|
RoutingInfo,
|
|
9832
9613
|
DownloadShelfOptions,
|
|
9833
|
-
ViewShowAtOptions,
|
|
9834
|
-
ExtensionInfo,
|
|
9835
9614
|
ApplicationEvents,
|
|
9836
9615
|
BaseEvents,
|
|
9837
9616
|
ExternalApplicationEvents,
|
|
@@ -9858,25 +9637,6 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
|
|
|
9858
9637
|
diff: OpenFin.WindowOptionDiff;
|
|
9859
9638
|
};
|
|
9860
9639
|
|
|
9861
|
-
/**
|
|
9862
|
-
* @interface
|
|
9863
|
-
* The keys represent the output from calling individual Node `os` APIs.
|
|
9864
|
-
* For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
|
|
9865
|
-
* see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
|
|
9866
|
-
*/
|
|
9867
|
-
declare type OSInfo = {
|
|
9868
|
-
platform: string;
|
|
9869
|
-
release: string;
|
|
9870
|
-
version: string;
|
|
9871
|
-
/**
|
|
9872
|
-
* Throws if a user has no username or homedir.
|
|
9873
|
-
* See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
|
|
9874
|
-
*/
|
|
9875
|
-
userInfo: NodeUserInfo;
|
|
9876
|
-
hostname: string;
|
|
9877
|
-
networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
|
|
9878
|
-
};
|
|
9879
|
-
|
|
9880
9640
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
9881
9641
|
|
|
9882
9642
|
/**
|
|
@@ -9905,110 +9665,86 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
9905
9665
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
|
9906
9666
|
};
|
|
9907
9667
|
|
|
9908
|
-
/**
|
|
9909
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
9910
|
-
*
|
|
9911
|
-
* @see {@link ByType}
|
|
9912
|
-
*
|
|
9913
|
-
* @typeParam Type String key specifying the event to extract
|
|
9914
|
-
*/
|
|
9915
|
-
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
|
9916
|
-
|
|
9917
9668
|
/**
|
|
9918
9669
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
|
9919
9670
|
*
|
|
9920
9671
|
* @typeParam Type String key specifying the event to extract
|
|
9921
9672
|
*/
|
|
9922
|
-
declare type
|
|
9673
|
+
declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
|
|
9923
9674
|
type: Type;
|
|
9924
9675
|
}>;
|
|
9925
9676
|
|
|
9926
|
-
/**
|
|
9927
|
-
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
|
9928
|
-
*
|
|
9929
|
-
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
|
9930
|
-
* the appropriate payload union for that namespace.
|
|
9931
|
-
*
|
|
9932
|
-
* @typeParam Event Union of payloads for events on the given emitter
|
|
9933
|
-
* @see {@link ByType}
|
|
9934
|
-
*
|
|
9935
|
-
* @typeParam Type String key specifying the event to extract from the union
|
|
9936
|
-
*
|
|
9937
|
-
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
|
9938
|
-
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
|
9939
|
-
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
|
9940
|
-
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
|
9941
|
-
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
|
9942
|
-
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
|
9943
|
-
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
|
9944
|
-
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
|
9945
|
-
*/
|
|
9946
|
-
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
|
9947
|
-
type: EventType;
|
|
9948
|
-
}>;
|
|
9949
|
-
|
|
9950
9677
|
/**
|
|
9951
9678
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
9952
9679
|
*
|
|
9953
|
-
* @see {@link ByType}
|
|
9954
|
-
*
|
|
9955
9680
|
* @typeParam Type String key specifying the event to extract
|
|
9956
9681
|
*/
|
|
9957
|
-
declare type
|
|
9682
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
|
9683
|
+
type: Type;
|
|
9684
|
+
}>;
|
|
9958
9685
|
|
|
9959
9686
|
/**
|
|
9960
9687
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
9961
9688
|
*
|
|
9962
|
-
* @see {@link ByType}
|
|
9963
|
-
*
|
|
9964
9689
|
* @typeParam Type String key specifying the event to extract
|
|
9965
9690
|
*/
|
|
9966
|
-
declare type
|
|
9691
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
|
9692
|
+
type: Type;
|
|
9693
|
+
}>;
|
|
9967
9694
|
|
|
9968
9695
|
/**
|
|
9969
9696
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
9970
9697
|
*
|
|
9971
|
-
* @see {@link ByType}
|
|
9972
|
-
*
|
|
9973
9698
|
* @typeParam Type String key specifying the event to extract
|
|
9974
9699
|
*/
|
|
9975
|
-
declare type
|
|
9700
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
|
9701
|
+
type: Type;
|
|
9702
|
+
}>;
|
|
9976
9703
|
|
|
9977
9704
|
/**
|
|
9978
9705
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
9979
9706
|
*
|
|
9980
|
-
* @see {@link ByType}
|
|
9981
|
-
*
|
|
9982
9707
|
* @typeParam Type String key specifying the event to extract
|
|
9983
9708
|
*/
|
|
9984
|
-
declare type
|
|
9709
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
|
9710
|
+
type: Type;
|
|
9711
|
+
}>;
|
|
9985
9712
|
|
|
9986
9713
|
/**
|
|
9987
9714
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
9988
9715
|
*
|
|
9989
|
-
* @see {@link ByType}
|
|
9990
|
-
*
|
|
9991
9716
|
* @typeParam Type String key specifying the event to extract
|
|
9992
9717
|
*/
|
|
9993
|
-
declare type
|
|
9718
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
|
9719
|
+
type: Type;
|
|
9720
|
+
}>;
|
|
9994
9721
|
|
|
9995
9722
|
/**
|
|
9996
9723
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
9997
9724
|
*
|
|
9998
|
-
* @see {@link ByType}
|
|
9999
|
-
*
|
|
10000
9725
|
* @typeParam Type String key specifying the event to extract
|
|
10001
9726
|
*/
|
|
10002
|
-
declare type
|
|
9727
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
|
9728
|
+
type: Type;
|
|
9729
|
+
}>;
|
|
10003
9730
|
|
|
10004
9731
|
/**
|
|
10005
9732
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
10006
9733
|
*
|
|
10007
|
-
* @
|
|
9734
|
+
* @typeParam Type String key specifying the event to extract
|
|
9735
|
+
*/
|
|
9736
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
9737
|
+
type: Type;
|
|
9738
|
+
}>;
|
|
9739
|
+
|
|
9740
|
+
/**
|
|
9741
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10008
9742
|
*
|
|
10009
9743
|
* @typeParam Type String key specifying the event to extract
|
|
10010
9744
|
*/
|
|
10011
|
-
declare type Payload_9<Type extends
|
|
9745
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
|
9746
|
+
type: Type;
|
|
9747
|
+
}>;
|
|
10012
9748
|
|
|
10013
9749
|
/**
|
|
10014
9750
|
* @interface
|
|
@@ -10033,10 +9769,6 @@ declare type PerDomainSettings = {
|
|
|
10033
9769
|
* {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
|
|
10034
9770
|
*/
|
|
10035
9771
|
content?: ContentPermission;
|
|
10036
|
-
/**
|
|
10037
|
-
* {@inheritdoc ChromiumPolicies}
|
|
10038
|
-
*/
|
|
10039
|
-
chromiumPolicies?: ChromiumPolicies;
|
|
10040
9772
|
};
|
|
10041
9773
|
|
|
10042
9774
|
/**
|
|
@@ -10707,7 +10439,7 @@ declare namespace PlatformEvents {
|
|
|
10707
10439
|
PlatformEvent,
|
|
10708
10440
|
EventType_7 as EventType,
|
|
10709
10441
|
PlatformEventType,
|
|
10710
|
-
|
|
10442
|
+
Payload_8 as Payload,
|
|
10711
10443
|
ByType_7 as ByType
|
|
10712
10444
|
}
|
|
10713
10445
|
}
|
|
@@ -11391,45 +11123,6 @@ declare interface PlatformProvider {
|
|
|
11391
11123
|
* @returns {Promise<void>}
|
|
11392
11124
|
*/
|
|
11393
11125
|
handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
|
|
11394
|
-
/**
|
|
11395
|
-
* @experimental
|
|
11396
|
-
*
|
|
11397
|
-
* This method is called to handle errors with view creation and initial navigation during layout creation.
|
|
11398
|
-
* Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
|
|
11399
|
-
* * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
|
|
11400
|
-
* * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
|
|
11401
|
-
* * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
|
|
11402
|
-
*
|
|
11403
|
-
* @param viewIdentity Identity of the view
|
|
11404
|
-
* @param error error thrown during a view creation
|
|
11405
|
-
* @returns {Promise<OpenFin.ViewCreationSuccess | void>}
|
|
11406
|
-
*
|
|
11407
|
-
* @example
|
|
11408
|
-
*
|
|
11409
|
-
* ```js
|
|
11410
|
-
* const overrideCallback = (PlatformProvider) => {
|
|
11411
|
-
* class Override extends PlatformProvider {
|
|
11412
|
-
* async handleFailedViewCreation(viewIdentity, error) {
|
|
11413
|
-
* const view = fin.View.wrapSync(viewId);
|
|
11414
|
-
* try {
|
|
11415
|
-
* // navigate to an error page
|
|
11416
|
-
* await view.navigate('http://localhost:3000/errorPage.html');
|
|
11417
|
-
* // resolve a success result after redirecting to a error page
|
|
11418
|
-
* return {identity: viewIdentity, success: true};
|
|
11419
|
-
* } catch(e) {
|
|
11420
|
-
* // layout-initialized event will include this view with the error
|
|
11421
|
-
* throw error;
|
|
11422
|
-
* }
|
|
11423
|
-
* }
|
|
11424
|
-
* }
|
|
11425
|
-
* return new Override();
|
|
11426
|
-
* }
|
|
11427
|
-
*
|
|
11428
|
-
* fin.Platform.init({ overrideCallback });
|
|
11429
|
-
*
|
|
11430
|
-
* ```
|
|
11431
|
-
*/
|
|
11432
|
-
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
11433
11126
|
}
|
|
11434
11127
|
|
|
11435
11128
|
/**
|
|
@@ -11494,12 +11187,6 @@ declare type PointTopLeft = {
|
|
|
11494
11187
|
left: number;
|
|
11495
11188
|
};
|
|
11496
11189
|
|
|
11497
|
-
/**
|
|
11498
|
-
* When set to `disable`, disables the policy
|
|
11499
|
-
* When set to `defer-to-group-policy`, respects Group Policy settings
|
|
11500
|
-
*/
|
|
11501
|
-
declare type PolicyOptions = 'disable' | 'defer-to-group-policy';
|
|
11502
|
-
|
|
11503
11190
|
declare type PopupBaseBehavior = 'close' | 'hide';
|
|
11504
11191
|
|
|
11505
11192
|
declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
|
|
@@ -11735,10 +11422,12 @@ declare type PresetLayoutOptions_2 = {
|
|
|
11735
11422
|
presetType: LayoutPresetType;
|
|
11736
11423
|
};
|
|
11737
11424
|
|
|
11425
|
+
declare type PrinterInfo = OpenFin.PrinterInfo;
|
|
11426
|
+
|
|
11738
11427
|
/**
|
|
11739
11428
|
* @interface
|
|
11740
11429
|
*/
|
|
11741
|
-
declare type
|
|
11430
|
+
declare type PrinterInfo_2 = {
|
|
11742
11431
|
/**
|
|
11743
11432
|
* Printer Name
|
|
11744
11433
|
*/
|
|
@@ -12000,100 +11689,20 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
12000
11689
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12001
11690
|
|
|
12002
11691
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
12003
|
-
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12004
|
-
'destroy-application': ApplicationIdentityCall<{
|
|
12005
|
-
force: boolean;
|
|
12006
|
-
}, void>;
|
|
12007
|
-
'close-application': ApplicationIdentityCall<{
|
|
12008
|
-
force: boolean;
|
|
12009
|
-
}, void>;
|
|
12010
|
-
'application-close': ApplicationIdentityCall<{}, void>;
|
|
12011
|
-
'get-child-windows': ApplicationIdentityCall<{}, Array<unknown>>;
|
|
12012
|
-
'get-application-manifest': {
|
|
12013
|
-
request: {
|
|
12014
|
-
manifestUrl?: string;
|
|
12015
|
-
uuid?: string;
|
|
12016
|
-
};
|
|
12017
|
-
response: OpenFin.Manifest;
|
|
12018
|
-
};
|
|
12019
|
-
'get-parent-application': ApplicationIdentityCall<{}, string>;
|
|
12020
|
-
'get-shortcuts': ApplicationIdentityCall<{}, OpenFin.ShortCutConfig>;
|
|
12021
|
-
'application-get-views': ApplicationIdentityCall<{}, OpenFin.Identity[]>;
|
|
12022
|
-
'get-application-zoom-level': ApplicationIdentityCall<{}, number>;
|
|
12023
|
-
'application-get-window': ApplicationIdentityCall<{}, void>;
|
|
12024
|
-
'register-user': ApplicationIdentityCall<{
|
|
12025
|
-
userName: string;
|
|
12026
|
-
appName: string;
|
|
12027
|
-
}, void>;
|
|
12028
|
-
'remove-tray-icon': ApplicationIdentityCall<{}, void>;
|
|
12029
|
-
'restart-application': ApplicationIdentityCall<{}, void>;
|
|
12030
|
-
'application-run': ApplicationIdentityCall<{}, void>;
|
|
12031
|
-
'run-application': ApplicationIdentityCall<{
|
|
12032
|
-
manifestUrl?: string | undefined;
|
|
12033
|
-
opts?: OpenFin.RvmLaunchOptions;
|
|
12034
|
-
}, void>;
|
|
12035
|
-
'relaunch-on-close': ApplicationIdentityCall<{}, void>;
|
|
12036
|
-
'send-application-log': ApplicationIdentityCall<{}, OpenFin.SendApplicationLogResponse>;
|
|
12037
|
-
'set-jump-list': ApplicationIdentityCall<{
|
|
12038
|
-
config: OpenFin.JumpListCategory[] | null;
|
|
12039
|
-
}, void>;
|
|
12040
|
-
'set-tray-icon': ApplicationIdentityCall<{
|
|
12041
|
-
enabledIcon: string;
|
|
12042
|
-
}, void>;
|
|
12043
|
-
'set-shortcuts': ApplicationIdentityCall<{
|
|
12044
|
-
data: OpenFin.ShortCutConfig;
|
|
12045
|
-
}, void>;
|
|
12046
|
-
'set-shortcut-query-args': ApplicationIdentityCall<{
|
|
12047
|
-
data: string;
|
|
12048
|
-
}, void>;
|
|
12049
|
-
'set-application-zoom-level': ApplicationIdentityCall<{
|
|
12050
|
-
level: number;
|
|
12051
|
-
}, void>;
|
|
12052
|
-
'set-app-log-username': ApplicationIdentityCall<{
|
|
12053
|
-
data: string;
|
|
12054
|
-
}, void>;
|
|
12055
|
-
'get-tray-icon-info': ApplicationIdentityCall<{}, OpenFin.TrayInfo>;
|
|
12056
|
-
'has-tray-icon': ApplicationIdentityCall<{}, boolean>;
|
|
12057
|
-
'terminate-application': ApplicationIdentityCall<{}, void>;
|
|
12058
|
-
'wait-for-hung-application': ApplicationIdentityCall<{}, void>;
|
|
12059
|
-
'get-info': ApplicationIdentityCall<{}, OpenFin.ApplicationInfo>;
|
|
12060
|
-
'application-get-process-info': ApplicationIdentityCall<{}, OpenFin.AppProcessInfo>;
|
|
12061
|
-
'set-file-download-location': {
|
|
12062
|
-
request: OpenFin.Identity & {
|
|
12063
|
-
downloadLocation: string;
|
|
12064
|
-
};
|
|
12065
|
-
response: void;
|
|
12066
|
-
};
|
|
12067
|
-
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12068
|
-
'show-tray-icon-popup-menu': {
|
|
12069
|
-
request: OpenFin.Identity & {
|
|
12070
|
-
options: OpenFin.ShowTrayIconPopupMenuOptions;
|
|
12071
|
-
};
|
|
12072
|
-
response: OpenFin.MenuResult;
|
|
12073
|
-
};
|
|
12074
|
-
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12075
|
-
'wrap-application': VoidCall;
|
|
12076
|
-
'wrap-application-sync': VoidCall;
|
|
12077
|
-
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
12078
|
-
'application-create': VoidCall;
|
|
12079
|
-
'start-application': VoidCall;
|
|
12080
|
-
'run-applications': ApiCall<{
|
|
12081
|
-
applications: Array<OpenFin.ManifestInfo>;
|
|
12082
|
-
opts?: OpenFin.RvmLaunchOptions;
|
|
12083
|
-
}, void>;
|
|
12084
|
-
'get-current-application': VoidCall;
|
|
12085
|
-
'get-current-application-sync': VoidCall;
|
|
12086
|
-
'application-start-from-manifest': VoidCall;
|
|
12087
|
-
'application-create-from-manifest': VoidCall;
|
|
12088
11692
|
'request-external-authorization': {
|
|
12089
11693
|
request: any;
|
|
12090
11694
|
response: void;
|
|
12091
11695
|
specialResponse: AuthorizationPayload;
|
|
12092
11696
|
};
|
|
12093
|
-
'
|
|
12094
|
-
request:
|
|
11697
|
+
'application-get-views': {
|
|
11698
|
+
request: OpenFin.ApplicationIdentity;
|
|
11699
|
+
response: OpenFin.Identity[];
|
|
11700
|
+
};
|
|
11701
|
+
'set-jump-list': {
|
|
11702
|
+
request: {
|
|
11703
|
+
config: OpenFin.JumpListCategory[] | null;
|
|
11704
|
+
} & OpenFin.ApplicationIdentity;
|
|
12095
11705
|
response: void;
|
|
12096
|
-
specialResponse: Payload;
|
|
12097
11706
|
};
|
|
12098
11707
|
'clipboard-read-formats': {
|
|
12099
11708
|
request: {
|
|
@@ -12105,24 +11714,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12105
11714
|
request: OpenFin.ReadImageClipboardRequest;
|
|
12106
11715
|
response: string;
|
|
12107
11716
|
};
|
|
12108
|
-
'clipboard-read-text': {
|
|
12109
|
-
request: {
|
|
12110
|
-
type?: OpenFin.ClipboardSelectionType;
|
|
12111
|
-
};
|
|
12112
|
-
response: string;
|
|
12113
|
-
};
|
|
12114
|
-
'clipboard-read-html': {
|
|
12115
|
-
request: {
|
|
12116
|
-
type?: OpenFin.ClipboardSelectionType;
|
|
12117
|
-
};
|
|
12118
|
-
response: string;
|
|
12119
|
-
};
|
|
12120
|
-
'clipboard-read-rtf': {
|
|
12121
|
-
request: {
|
|
12122
|
-
type?: OpenFin.ClipboardSelectionType;
|
|
12123
|
-
};
|
|
12124
|
-
response: string;
|
|
12125
|
-
};
|
|
12126
11717
|
'clipboard-write-image': {
|
|
12127
11718
|
request: OpenFin.WriteImageClipboardRequest;
|
|
12128
11719
|
response: void;
|
|
@@ -12131,18 +11722,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12131
11722
|
request: OpenFin.WriteAnyRequestType;
|
|
12132
11723
|
response: void;
|
|
12133
11724
|
};
|
|
12134
|
-
'clipboard-write-text': {
|
|
12135
|
-
request: OpenFin.WriteClipboardRequest;
|
|
12136
|
-
response: void;
|
|
12137
|
-
};
|
|
12138
|
-
'clipboard-write-html': {
|
|
12139
|
-
request: OpenFin.WriteClipboardRequest;
|
|
12140
|
-
response: void;
|
|
12141
|
-
};
|
|
12142
|
-
'clipboard-write-rtf': {
|
|
12143
|
-
request: OpenFin.WriteClipboardRequest;
|
|
12144
|
-
response: void;
|
|
12145
|
-
};
|
|
12146
11725
|
'get-view-window': IdentityCall<{}, OpenFin.Identity>;
|
|
12147
11726
|
'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
|
|
12148
11727
|
uuid: string;
|
|
@@ -12159,94 +11738,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12159
11738
|
'get-view-options': IdentityCall<{}, OpenFin.ViewOptions>;
|
|
12160
11739
|
'hide-view': IdentityCall;
|
|
12161
11740
|
'show-view': IdentityCall;
|
|
12162
|
-
'show-view-at': IdentityCall<{
|
|
12163
|
-
bounds: OpenFin.Bounds;
|
|
12164
|
-
options?: OpenFin.ViewShowAtOptions;
|
|
12165
|
-
}>;
|
|
12166
|
-
'bring-view-to-front': IdentityCall;
|
|
12167
11741
|
'update-view-options': IdentityCall<{
|
|
12168
11742
|
options: OpenFin.UpdatableViewOptions;
|
|
12169
11743
|
}>;
|
|
12170
11744
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12171
|
-
'view-wrap-sync': VoidCall;
|
|
12172
|
-
'view-wrap': VoidCall;
|
|
12173
|
-
'view-get-current': VoidCall;
|
|
12174
|
-
'view-get-current-sync': VoidCall;
|
|
12175
|
-
'animate-window': IdentityCall<{
|
|
12176
|
-
transitions: OpenFin.Transition;
|
|
12177
|
-
options: OpenFin.TransitionOptions;
|
|
12178
|
-
}>;
|
|
12179
|
-
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12180
|
-
'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
|
|
12181
|
-
'center-window': IdentityCall;
|
|
12182
|
-
'blur-window': IdentityCall;
|
|
12183
|
-
'bring-window-to-front': IdentityCall;
|
|
12184
|
-
'hide-window': IdentityCall;
|
|
12185
|
-
'close-window': IdentityCall<{
|
|
12186
|
-
force: boolean;
|
|
12187
|
-
}>;
|
|
12188
|
-
'focused-webview-changed': IdentityCall;
|
|
12189
|
-
'get-window-native-id': IdentityCall<{}, string>;
|
|
12190
11745
|
'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
|
|
12191
|
-
'
|
|
12192
|
-
'enable-window-frame': IdentityCall;
|
|
12193
|
-
'flash-window': IdentityCall;
|
|
12194
|
-
'stop-flash-window': IdentityCall;
|
|
12195
|
-
'get-window-info': IdentityCall<{}, OpenFin.WindowInfo>;
|
|
12196
|
-
'get-window-options': IdentityCall<{}, OpenFin.WindowOptions>;
|
|
12197
|
-
'get-window-snapshot': IdentityCall<{
|
|
12198
|
-
area?: OpenFin.Rectangle;
|
|
12199
|
-
}, string>;
|
|
12200
|
-
'get-window-state': IdentityCall<{}, 'minimized' | 'maximized' | 'normal'>;
|
|
12201
|
-
'is-window-showing': IdentityCall<{}, boolean>;
|
|
12202
|
-
'maximize-window': IdentityCall;
|
|
12203
|
-
'minimize-window': IdentityCall;
|
|
12204
|
-
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12205
|
-
deltaLeft: number;
|
|
12206
|
-
deltaTop: number;
|
|
12207
|
-
}>>;
|
|
12208
|
-
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12209
|
-
left: number;
|
|
12210
|
-
top: number;
|
|
12211
|
-
}>>;
|
|
12212
|
-
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12213
|
-
deltaWidth: number;
|
|
12214
|
-
deltaHeight: number;
|
|
12215
|
-
anchor: OpenFin.AnchorType;
|
|
12216
|
-
}>>;
|
|
12217
|
-
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12218
|
-
width: number;
|
|
12219
|
-
height: number;
|
|
12220
|
-
anchor: OpenFin.AnchorType;
|
|
12221
|
-
}>>;
|
|
12222
|
-
'restore-window': IdentityCall;
|
|
12223
|
-
'set-foreground-window': IdentityCall;
|
|
12224
|
-
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12225
|
-
'show-window': IdentityCall<{
|
|
12226
|
-
force: boolean;
|
|
12227
|
-
}>;
|
|
12228
|
-
'show-at-window': IdentityCall<{
|
|
12229
|
-
left: number;
|
|
12230
|
-
top: number;
|
|
12231
|
-
force: boolean;
|
|
12232
|
-
}>;
|
|
12233
|
-
'update-window-options': IdentityCall<{
|
|
12234
|
-
options: OpenFin.UpdatableWindowOptions;
|
|
12235
|
-
}>;
|
|
12236
|
-
'window-authenticate': IdentityCall<{
|
|
12237
|
-
userName: string;
|
|
12238
|
-
password: string;
|
|
12239
|
-
}>;
|
|
12240
|
-
'show-popup-menu': {
|
|
11746
|
+
'print': {
|
|
12241
11747
|
request: OpenFin.Identity & {
|
|
12242
|
-
options: OpenFin.
|
|
11748
|
+
options: OpenFin.PrintOptions;
|
|
12243
11749
|
};
|
|
12244
|
-
response:
|
|
11750
|
+
response: void;
|
|
12245
11751
|
};
|
|
12246
|
-
'close-popup-menu': IdentityCall;
|
|
12247
|
-
'dispatch-popup-result': IdentityCall<{
|
|
12248
|
-
data: any;
|
|
12249
|
-
}>;
|
|
12250
11752
|
'print-screenshot': {
|
|
12251
11753
|
request: OpenFin.Identity;
|
|
12252
11754
|
response: void;
|
|
@@ -12257,232 +11759,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12257
11759
|
};
|
|
12258
11760
|
response: void;
|
|
12259
11761
|
};
|
|
12260
|
-
'window-wrap': VoidCall;
|
|
12261
|
-
'window-wrap-sync': VoidCall;
|
|
12262
|
-
'create-window': VoidCall;
|
|
12263
|
-
'get-current-window': VoidCall;
|
|
12264
|
-
'get-current-window-sync': VoidCall;
|
|
12265
|
-
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
12266
|
-
'external-application-wrap': VoidCall;
|
|
12267
|
-
'external-application-wrap-sync': VoidCall;
|
|
12268
|
-
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12269
|
-
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12270
|
-
'frame-wrap': VoidCall;
|
|
12271
|
-
'frame-wrap-sync': VoidCall;
|
|
12272
|
-
'frame-get-current': VoidCall;
|
|
12273
|
-
'frame-get-current-sync': VoidCall;
|
|
12274
|
-
'global-hotkey-register': {
|
|
12275
|
-
request: {
|
|
12276
|
-
hotkey: string;
|
|
12277
|
-
};
|
|
12278
|
-
response: void;
|
|
12279
|
-
};
|
|
12280
|
-
'global-hotkey-unregister': {
|
|
12281
|
-
request: {
|
|
12282
|
-
hotkey: string;
|
|
12283
|
-
};
|
|
12284
|
-
response: void;
|
|
12285
|
-
};
|
|
12286
|
-
'global-hotkey-unregister-all': {
|
|
12287
|
-
request: {};
|
|
12288
|
-
response: void;
|
|
12289
|
-
};
|
|
12290
|
-
'global-hotkey-is-registered': {
|
|
12291
|
-
request: {
|
|
12292
|
-
hotkey: string;
|
|
12293
|
-
};
|
|
12294
|
-
response: boolean;
|
|
12295
|
-
};
|
|
12296
|
-
'publish-message': {
|
|
12297
|
-
request: {
|
|
12298
|
-
topic: string;
|
|
12299
|
-
message: any;
|
|
12300
|
-
sourceWindowName: string;
|
|
12301
|
-
};
|
|
12302
|
-
response: void;
|
|
12303
|
-
};
|
|
12304
|
-
'send-message': {
|
|
12305
|
-
request: {
|
|
12306
|
-
destinationUuid: string;
|
|
12307
|
-
destinationWindowName: string | undefined;
|
|
12308
|
-
topic: string;
|
|
12309
|
-
message: any;
|
|
12310
|
-
sourceWindowName: string;
|
|
12311
|
-
};
|
|
12312
|
-
response: void;
|
|
12313
|
-
};
|
|
12314
|
-
'subscribe': {
|
|
12315
|
-
request: {
|
|
12316
|
-
sourceUuid: string;
|
|
12317
|
-
sourceWindowName: string;
|
|
12318
|
-
topic: string;
|
|
12319
|
-
destinationWindowName: string;
|
|
12320
|
-
messageKey?: any;
|
|
12321
|
-
};
|
|
12322
|
-
response: void;
|
|
12323
|
-
};
|
|
12324
|
-
'unsubscribe': {
|
|
12325
|
-
request: {
|
|
12326
|
-
sourceUuid: string;
|
|
12327
|
-
sourceWindowName: string;
|
|
12328
|
-
topic: string;
|
|
12329
|
-
destinationWindowName: string;
|
|
12330
|
-
};
|
|
12331
|
-
response: void;
|
|
12332
|
-
};
|
|
12333
|
-
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
12334
|
-
'connect-to-channel': {
|
|
12335
|
-
request: any;
|
|
12336
|
-
response: OpenFin.RoutingInfo;
|
|
12337
|
-
};
|
|
12338
|
-
'create-channel': ApiCall<{
|
|
12339
|
-
channelName: string;
|
|
12340
|
-
}, OpenFin.ProviderIdentity>;
|
|
12341
|
-
'destroy-channel': ApiCall<{
|
|
12342
|
-
channelName: string;
|
|
12343
|
-
}, void>;
|
|
12344
|
-
'disconnect-from-channel': {
|
|
12345
|
-
request: {
|
|
12346
|
-
channelName: string;
|
|
12347
|
-
uuid: string;
|
|
12348
|
-
name: string;
|
|
12349
|
-
endpointId: string;
|
|
12350
|
-
};
|
|
12351
|
-
response: void;
|
|
12352
|
-
};
|
|
12353
|
-
'send-channel-message': {
|
|
12354
|
-
request: any;
|
|
12355
|
-
response: any;
|
|
12356
|
-
};
|
|
12357
|
-
'get-version': GetterCall<string>;
|
|
12358
|
-
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
12359
|
-
'delete-cache-request': VoidCall;
|
|
12360
|
-
'exit-desktop': VoidCall;
|
|
12361
|
-
'fetch-manifest': ApiCall<{
|
|
12362
|
-
manifestUrl: string;
|
|
12363
|
-
}, any>;
|
|
12364
|
-
'flush-cookie-store': VoidCall;
|
|
12365
|
-
'get-all-windows': GetterCall<OpenFin.ApplicationWindowInfo[]>;
|
|
12366
|
-
'get-all-applications': GetterCall<OpenFin.ApplicationState[]>;
|
|
12367
|
-
'get-command-line-arguments': GetterCall<string>;
|
|
12368
|
-
'get-crash-reporter-state': GetterCall<OpenFin.CrashReporterState>;
|
|
12369
|
-
'start-crash-reporter': {
|
|
12370
|
-
request: OpenFin.CrashReporterOptions | {
|
|
12371
|
-
diagnosticMode: boolean;
|
|
12372
|
-
};
|
|
12373
|
-
response: OpenFin.CrashReporterState;
|
|
12374
|
-
};
|
|
12375
|
-
'get-unique-user-id': GetterCall<string>;
|
|
12376
|
-
'get-entity-info': {
|
|
12377
|
-
request: {
|
|
12378
|
-
uuid: string;
|
|
12379
|
-
name: string;
|
|
12380
|
-
};
|
|
12381
|
-
response: OpenFin.EntityInfo;
|
|
12382
|
-
};
|
|
12383
|
-
'get-environment-variable': {
|
|
12384
|
-
request: {
|
|
12385
|
-
environmentVariables: string;
|
|
12386
|
-
};
|
|
12387
|
-
response: string;
|
|
12388
|
-
};
|
|
12389
|
-
'get-focused-window': GetterCall<OpenFin.Identity | null>;
|
|
12390
|
-
'get-focused-content': GetterCall<(OpenFin.Identity & {
|
|
12391
|
-
entityType: 'window' | 'view';
|
|
12392
|
-
}) | null>;
|
|
12393
|
-
'is-app-certified': {
|
|
12394
|
-
request: {
|
|
12395
|
-
manifestUrl: string;
|
|
12396
|
-
};
|
|
12397
|
-
response: {
|
|
12398
|
-
action: string;
|
|
12399
|
-
certifiedInfo: OpenFin.CertifiedAppInfo;
|
|
12400
|
-
};
|
|
12401
|
-
};
|
|
12402
|
-
'get-installed-runtimes': GetterCall<{
|
|
12403
|
-
action: string;
|
|
12404
|
-
runtimes: string[];
|
|
12405
|
-
}>;
|
|
12406
|
-
'get-installed-apps': GetterCall<OpenFin.InstalledApps>;
|
|
12407
|
-
'view-log': ApiCall<OpenFin.GetLogRequestType, string>;
|
|
12408
|
-
'get-machine-id': GetterCall<string>;
|
|
12409
|
-
'get-min-log-level': GetterCall<OpenFin.LogLevel>;
|
|
12410
|
-
'list-logs': GetterCall<OpenFin.LogInfo[]>;
|
|
12411
|
-
'get-monitor-info': GetterCall<OpenFin.MonitorInfo>;
|
|
12412
|
-
'get-mouse-position': GetterCall<OpenFin.PointTopLeft>;
|
|
12413
|
-
'process-snapshot': GetterCall<Array<any>>;
|
|
12414
|
-
'get-all-process-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.SystemProcessInfo>;
|
|
12415
|
-
'get-proxy-settings': GetterCall<OpenFin.ProxyInfo>;
|
|
12416
|
-
'get-runtime-info': GetterCall<OpenFin.RuntimeInfo>;
|
|
12417
|
-
'get-rvm-info': GetterCall<OpenFin.RVMInfo>;
|
|
12418
|
-
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12419
|
-
'get-os-info': GetterCall<OpenFin.OSInfo>;
|
|
12420
|
-
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity>;
|
|
12421
|
-
'monitor-external-process': ApiCall<OpenFin.ExternalProcessInfo, OpenFin.Identity>;
|
|
12422
|
-
'write-to-log': ApiCall<{
|
|
12423
|
-
level: string;
|
|
12424
|
-
message: string;
|
|
12425
|
-
}, void>;
|
|
12426
|
-
'open-url-with-browser': ApiCall<{
|
|
12427
|
-
url: string;
|
|
12428
|
-
}, void>;
|
|
12429
|
-
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12430
|
-
'unregister-custom-protocol': ApiCall<{
|
|
12431
|
-
protocolName: string;
|
|
12432
|
-
}, void>;
|
|
12433
|
-
'get-custom-protocol-state': ApiCall<{
|
|
12434
|
-
protocolName: string;
|
|
12435
|
-
}, OpenFin.CustomProtocolState>;
|
|
12436
|
-
'release-external-process': ApiCall<{
|
|
12437
|
-
uuid: string;
|
|
12438
|
-
}, void>;
|
|
12439
|
-
'show-developer-tools': ApiCall<OpenFin.Identity, void>;
|
|
12440
|
-
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void>;
|
|
12441
|
-
'update-proxy': ApiCall<OpenFin.ProxyConfig, void>;
|
|
12442
|
-
'download-asset': {
|
|
12443
|
-
request: OpenFin.AppAssetInfo & {
|
|
12444
|
-
downloadId: string;
|
|
12445
|
-
};
|
|
12446
|
-
response: void;
|
|
12447
|
-
};
|
|
12448
|
-
'download-runtime': {
|
|
12449
|
-
request: OpenFin.RuntimeDownloadOptions & {
|
|
12450
|
-
downloadId: string;
|
|
12451
|
-
};
|
|
12452
|
-
response: void;
|
|
12453
|
-
};
|
|
12454
|
-
'download-preload-scripts': ApiCall<{
|
|
12455
|
-
scripts: Array<OpenFin.DownloadPreloadOption>;
|
|
12456
|
-
}, Array<OpenFin.DownloadPreloadInfo>>;
|
|
12457
|
-
'get-all-external-applications': ApiCall<void, Array<OpenFin.Identity>>;
|
|
12458
|
-
'get-app-asset-info': ApiCall<OpenFin.AppAssetRequest, OpenFin.AppAssetInfo>;
|
|
12459
|
-
'get-cookies': {
|
|
12460
|
-
request: OpenFin.CookieOption & {
|
|
12461
|
-
url: string;
|
|
12462
|
-
};
|
|
12463
|
-
response: Array<OpenFin.CookieInfo>;
|
|
12464
|
-
};
|
|
12465
|
-
'set-min-log-level': ApiCall<{
|
|
12466
|
-
level: OpenFin.LogLevel;
|
|
12467
|
-
}, void>;
|
|
12468
|
-
'resolve-uuid': ApiCall<{
|
|
12469
|
-
entityKey: string;
|
|
12470
|
-
}, OpenFin.ApplicationType>;
|
|
12471
|
-
'read-registry-value': ApiCall<{
|
|
12472
|
-
rootKey: string;
|
|
12473
|
-
subkey: string;
|
|
12474
|
-
value: string;
|
|
12475
|
-
}, OpenFin.RegistryInfo>;
|
|
12476
|
-
'register-external-connection': ApiCall<{
|
|
12477
|
-
uuid: string;
|
|
12478
|
-
}, OpenFin.ExternalConnection>;
|
|
12479
|
-
'get-service-configuration': ApiCall<{
|
|
12480
|
-
name: string;
|
|
12481
|
-
}, OpenFin.ServiceConfiguration>;
|
|
12482
|
-
'get-system-app-configuration': ApiCall<{
|
|
12483
|
-
name: string;
|
|
12484
|
-
}, any>;
|
|
12485
|
-
'run-rvm-health-check': ApiCall<void, string[]>;
|
|
12486
11762
|
'launch-manifest': {
|
|
12487
11763
|
request: {
|
|
12488
11764
|
manifestUrl: string;
|
|
@@ -12494,12 +11770,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12494
11770
|
manifest: OpenFin.Manifest;
|
|
12495
11771
|
};
|
|
12496
11772
|
};
|
|
12497
|
-
'
|
|
11773
|
+
'get-system-app-configuration': {
|
|
12498
11774
|
request: {
|
|
12499
|
-
|
|
12500
|
-
identity: OpenFin.Identity;
|
|
11775
|
+
name: string;
|
|
12501
11776
|
};
|
|
12502
|
-
response:
|
|
11777
|
+
response: any;
|
|
11778
|
+
};
|
|
11779
|
+
'show-popup-menu': {
|
|
11780
|
+
request: OpenFin.Identity & {
|
|
11781
|
+
options: OpenFin.ShowPopupMenuOptions;
|
|
11782
|
+
};
|
|
11783
|
+
response: OpenFin.MenuResult;
|
|
12503
11784
|
};
|
|
12504
11785
|
'enable-native-window-integration-provider': {
|
|
12505
11786
|
request: {
|
|
@@ -12507,42 +11788,24 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12507
11788
|
};
|
|
12508
11789
|
response: OpenFin.NativeWindowIntegrationProviderAuthorization;
|
|
12509
11790
|
};
|
|
12510
|
-
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
12511
|
-
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12512
|
-
'system-update-process-logging-options': ApiCall<{
|
|
12513
|
-
options: OpenFin.ProcessLoggingOptions;
|
|
12514
|
-
}, void>;
|
|
12515
|
-
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12516
|
-
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12517
|
-
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12518
|
-
}, void>;
|
|
12519
|
-
'system-register-shutdown-handler': VoidCall;
|
|
12520
11791
|
'get-permissions': GetterCall<any>;
|
|
12521
|
-
'
|
|
12522
|
-
|
|
12523
|
-
|
|
11792
|
+
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
11793
|
+
'set-file-download-location': {
|
|
11794
|
+
request: OpenFin.Identity & {
|
|
11795
|
+
downloadLocation: string;
|
|
11796
|
+
};
|
|
11797
|
+
response: void;
|
|
12524
11798
|
};
|
|
12525
|
-
'get-
|
|
12526
|
-
request:
|
|
12527
|
-
response:
|
|
11799
|
+
'get-file-download-location': {
|
|
11800
|
+
request: OpenFin.ApplicationIdentity;
|
|
11801
|
+
response: string;
|
|
12528
11802
|
};
|
|
11803
|
+
'close-popup-menu': IdentityCall;
|
|
12529
11804
|
'fdc3-add-context-listener': VoidCall;
|
|
12530
|
-
'fdc3-add-intent-listener': VoidCall;
|
|
12531
|
-
'fdc3-raise-intent': VoidCall;
|
|
12532
|
-
'fdc3-find-intent': VoidCall;
|
|
12533
|
-
'fdc3-find-intents-by-context': VoidCall;
|
|
12534
|
-
'fdc3-raise-intent-for-context': VoidCall;
|
|
12535
|
-
'fdc3-get-info': VoidCall;
|
|
12536
|
-
'fdc3-find-instances': VoidCall;
|
|
12537
|
-
'fdc3-get-app-metadata': VoidCall;
|
|
12538
11805
|
'fdc3-broadcast': VoidCall;
|
|
12539
|
-
'fdc3-open': VoidCall;
|
|
12540
|
-
'fdc3-get-or-create-channel': VoidCall;
|
|
12541
11806
|
'fdc3-get-system-channels': VoidCall;
|
|
12542
11807
|
'fdc3-join-channel': VoidCall;
|
|
12543
|
-
'fdc3-get-current-channel': VoidCall;
|
|
12544
11808
|
'fdc3-leave-current-channel': VoidCall;
|
|
12545
|
-
'interop-init': VoidCall;
|
|
12546
11809
|
'interop-connect-sync': VoidCall;
|
|
12547
11810
|
'interop-client-set-context': VoidCall;
|
|
12548
11811
|
'interop-client-add-context-handler': VoidCall;
|
|
@@ -12551,13 +11814,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12551
11814
|
'interop-client-remove-from-context-group': VoidCall;
|
|
12552
11815
|
'interop-client-get-all-clients-in-context-group': VoidCall;
|
|
12553
11816
|
'interop-client-get-info-for-context-group': VoidCall;
|
|
12554
|
-
'interop-client-fire-intent': VoidCall;
|
|
12555
|
-
'interop-client-register-intent-handler': VoidCall;
|
|
12556
|
-
'interop-client-get-current-context': VoidCall;
|
|
12557
|
-
'interop-client-get-info-for-intent': VoidCall;
|
|
12558
|
-
'interop-client-get-info-for-intents-by-context': VoidCall;
|
|
12559
|
-
'interop-client-fire-intent-for-context': VoidCall;
|
|
12560
|
-
'interop-client-add-ondisconnection-listener': VoidCall;
|
|
12561
11817
|
'interop-broker-add-client-to-context-group': VoidCall;
|
|
12562
11818
|
'interop-broker-get-all-clients-in-context-group': VoidCall;
|
|
12563
11819
|
'interop-broker-get-context-groups': VoidCall;
|
|
@@ -12569,100 +11825,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12569
11825
|
'interop-broker-remove-from-context-group': VoidCall;
|
|
12570
11826
|
'interop-broker-set-context': VoidCall;
|
|
12571
11827
|
'interop-broker-set-context-for-group': VoidCall;
|
|
12572
|
-
'
|
|
12573
|
-
|
|
12574
|
-
|
|
12575
|
-
|
|
12576
|
-
|
|
12577
|
-
|
|
12578
|
-
|
|
12579
|
-
'platform-get-current': VoidCall;
|
|
12580
|
-
'platform-get-current-sync': VoidCall;
|
|
12581
|
-
'platform-start': VoidCall;
|
|
12582
|
-
'platform-start-from-manifest': VoidCall;
|
|
12583
|
-
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
12584
|
-
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
12585
|
-
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
12586
|
-
'platform-quit': ApplicationIdentityCall<{}, void>;
|
|
12587
|
-
'platform-close-view': ApplicationIdentityCall<{}, void>;
|
|
12588
|
-
'platform-reparent-view': ApplicationIdentityCall<{}, void>;
|
|
12589
|
-
'platform-get-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12590
|
-
'platform-apply-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12591
|
-
'platform-launch-content-manifest': ApplicationIdentityCall<{}, void>;
|
|
12592
|
-
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
12593
|
-
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
12594
|
-
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
12595
|
-
'layout-wrap': VoidCall;
|
|
12596
|
-
'layout-wrap-sync': VoidCall;
|
|
12597
|
-
'layout-get-current': VoidCall;
|
|
12598
|
-
'layout-get-current-sync': VoidCall;
|
|
12599
|
-
'layout-init': VoidCall;
|
|
12600
|
-
'layout-get-config': VoidCall;
|
|
12601
|
-
'layout-get-views': VoidCall;
|
|
12602
|
-
'layout-replace': VoidCall;
|
|
12603
|
-
'layout-get-root-item': VoidCall;
|
|
12604
|
-
'layout-replace-view': VoidCall;
|
|
12605
|
-
'layout-apply-preset': VoidCall;
|
|
12606
|
-
'layout-controller-get-root': VoidCall;
|
|
12607
|
-
'layout-controller-get-stack-by-view': VoidCall;
|
|
12608
|
-
'layout-controller-get-stack-views': VoidCall;
|
|
12609
|
-
'layout-controller-get-content': VoidCall;
|
|
12610
|
-
'layout-controller-get-parent': VoidCall;
|
|
12611
|
-
'layout-controller-is-root': VoidCall;
|
|
12612
|
-
'layout-controller-exists': VoidCall;
|
|
12613
|
-
'layout-controller-add-view-to-stack': VoidCall;
|
|
12614
|
-
'layout-controller-remove-view-from-stack': VoidCall;
|
|
12615
|
-
'layout-controller-create-adjacent-stack': VoidCall;
|
|
12616
|
-
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
12617
|
-
'layout-controller-set-stack-active-view': VoidCall;
|
|
12618
|
-
'snapshot-source-init': VoidCall;
|
|
12619
|
-
'snapshot-source-wrap-sync': VoidCall;
|
|
12620
|
-
'snapshot-source-wrap': VoidCall;
|
|
12621
|
-
'snapshot-source-ready': VoidCall;
|
|
12622
|
-
'snapshot-source-get-snapshot': VoidCall;
|
|
12623
|
-
'snapshot-source-apply-snapshot': VoidCall;
|
|
12624
|
-
'capture-page': IdentityCall<{
|
|
12625
|
-
options?: OpenFin.CapturePageOptions;
|
|
12626
|
-
}, string>;
|
|
12627
|
-
'execute-javascript-in-window': IdentityCall<{
|
|
12628
|
-
code: string;
|
|
12629
|
-
}, unknown>;
|
|
12630
|
-
'get-zoom-level': IdentityCall<{}, number>;
|
|
12631
|
-
'set-zoom-level': IdentityCall<{
|
|
12632
|
-
level: number;
|
|
12633
|
-
}, void>;
|
|
12634
|
-
'navigate-window': IdentityCall<{
|
|
12635
|
-
url: string;
|
|
12636
|
-
}, void>;
|
|
12637
|
-
'navigate-window-back': IdentityCall<{}, void>;
|
|
12638
|
-
'navigate-window-forward': IdentityCall<{}, void>;
|
|
12639
|
-
'stop-window-navigation': IdentityCall<{}, void>;
|
|
12640
|
-
'reload-window': IdentityCall<{
|
|
12641
|
-
ignoreCache: boolean;
|
|
12642
|
-
}, void>;
|
|
12643
|
-
'print': IdentityCall<{
|
|
12644
|
-
options: OpenFin.PrintOptions;
|
|
12645
|
-
}, void>;
|
|
12646
|
-
'find-in-page': IdentityCall<{
|
|
12647
|
-
searchTerm: string;
|
|
12648
|
-
options?: OpenFin.FindInPageOptions;
|
|
12649
|
-
}, void>;
|
|
12650
|
-
'stop-find-in-page': IdentityCall<{
|
|
12651
|
-
action: 'clearSelection' | 'keepSelection' | 'activateSelection';
|
|
12652
|
-
}, void>;
|
|
12653
|
-
'get-printers': IdentityCall<{}, OpenFin.PrinterInfo>;
|
|
12654
|
-
'focus-window': IdentityCall<{
|
|
12655
|
-
emitSynthFocused: boolean;
|
|
12656
|
-
}, void>;
|
|
12657
|
-
'get-process-info': IdentityCall<{}, OpenFin.EntityProcessDetails>;
|
|
12658
|
-
'get-shared-workers': IdentityCall<{}, OpenFin.SharedWorkerInfo[]>;
|
|
12659
|
-
'inspect-shared-worker': IdentityCall<{}, void>;
|
|
12660
|
-
'inspect-shared-worker-by-id': IdentityCall<{
|
|
12661
|
-
workerId: string;
|
|
12662
|
-
}, void>;
|
|
12663
|
-
'inspect-service-worker': IdentityCall<{}, void>;
|
|
12664
|
-
'view-show-popup-window': IdentityCall<{}, void>;
|
|
12665
|
-
'window-show-popup-window': IdentityCall<{}, void>;
|
|
11828
|
+
'query-permission-for-current-context': {
|
|
11829
|
+
request: {
|
|
11830
|
+
apiName: string;
|
|
11831
|
+
identity: OpenFin.Identity;
|
|
11832
|
+
};
|
|
11833
|
+
response: OpenFin.QueryPermissionResult;
|
|
11834
|
+
};
|
|
12666
11835
|
'try-create-popup-window': {
|
|
12667
11836
|
request: OpenFin.Identity & {
|
|
12668
11837
|
options: OpenFin.PopupOptions;
|
|
@@ -12678,6 +11847,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12678
11847
|
};
|
|
12679
11848
|
response: OpenFin.PopupResult;
|
|
12680
11849
|
};
|
|
11850
|
+
'dispatch-popup-result': IdentityCall<{
|
|
11851
|
+
data: any;
|
|
11852
|
+
}>;
|
|
12681
11853
|
'render-overlay': {
|
|
12682
11854
|
request: {
|
|
12683
11855
|
bounds: OpenFin.Bounds;
|
|
@@ -12697,6 +11869,38 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12697
11869
|
};
|
|
12698
11870
|
response: void;
|
|
12699
11871
|
};
|
|
11872
|
+
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
11873
|
+
'system-register-shutdown-handler': VoidCall;
|
|
11874
|
+
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
11875
|
+
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
11876
|
+
domainSettings: OpenFin.DefaultDomainSettings;
|
|
11877
|
+
}, void>;
|
|
11878
|
+
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
11879
|
+
deltaLeft: number;
|
|
11880
|
+
deltaTop: number;
|
|
11881
|
+
}>>;
|
|
11882
|
+
'move-window': IdentityCall<WithPositioningOptions<{
|
|
11883
|
+
left: number;
|
|
11884
|
+
top: number;
|
|
11885
|
+
}>>;
|
|
11886
|
+
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
11887
|
+
deltaWidth: number;
|
|
11888
|
+
deltaHeight: number;
|
|
11889
|
+
anchor: OpenFin.AnchorType;
|
|
11890
|
+
}>>;
|
|
11891
|
+
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
11892
|
+
width: number;
|
|
11893
|
+
height: number;
|
|
11894
|
+
anchor: OpenFin.AnchorType;
|
|
11895
|
+
}>>;
|
|
11896
|
+
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
11897
|
+
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
11898
|
+
'unregister-custom-protocol': ApiCall<{
|
|
11899
|
+
protocolName: string;
|
|
11900
|
+
}, void>;
|
|
11901
|
+
'get-custom-protocol-state': ApiCall<{
|
|
11902
|
+
protocolName: string;
|
|
11903
|
+
}, OpenFin.CustomProtocolState>;
|
|
12700
11904
|
}
|
|
12701
11905
|
|
|
12702
11906
|
declare interface ProtocolMapBase {
|
|
@@ -12726,7 +11930,7 @@ declare type ProviderIdentity_3 = OpenFin.ProviderIdentity;
|
|
|
12726
11930
|
* Identity of a channel provider.
|
|
12727
11931
|
* @interface
|
|
12728
11932
|
*/
|
|
12729
|
-
declare type ProviderIdentity_4 =
|
|
11933
|
+
declare type ProviderIdentity_4 = Identity_5 & {
|
|
12730
11934
|
/**
|
|
12731
11935
|
* Identifier of the channel.
|
|
12732
11936
|
*/
|
|
@@ -12737,10 +11941,12 @@ declare type ProviderIdentity_4 = Identity_4 & {
|
|
|
12737
11941
|
channelName: string;
|
|
12738
11942
|
};
|
|
12739
11943
|
|
|
11944
|
+
declare type ProxyConfig = OpenFin.ProxyConfig;
|
|
11945
|
+
|
|
12740
11946
|
/**
|
|
12741
11947
|
* @interface
|
|
12742
11948
|
*/
|
|
12743
|
-
declare type
|
|
11949
|
+
declare type ProxyConfig_2 = {
|
|
12744
11950
|
/**
|
|
12745
11951
|
* The configured proxy address.
|
|
12746
11952
|
*/
|
|
@@ -12752,11 +11958,13 @@ declare type ProxyConfig = {
|
|
|
12752
11958
|
type: string;
|
|
12753
11959
|
};
|
|
12754
11960
|
|
|
11961
|
+
declare type ProxyInfo = OpenFin.ProxyInfo;
|
|
11962
|
+
|
|
12755
11963
|
/**
|
|
12756
11964
|
* @interface
|
|
12757
11965
|
*/
|
|
12758
|
-
declare type
|
|
12759
|
-
config:
|
|
11966
|
+
declare type ProxyInfo_2 = {
|
|
11967
|
+
config: ProxyConfig_2;
|
|
12760
11968
|
system: ProxySystemInfo;
|
|
12761
11969
|
};
|
|
12762
11970
|
|
|
@@ -12862,10 +12070,12 @@ declare type RegisterUsageData = {
|
|
|
12862
12070
|
type: string;
|
|
12863
12071
|
};
|
|
12864
12072
|
|
|
12073
|
+
declare type RegistryInfo = OpenFin.RegistryInfo;
|
|
12074
|
+
|
|
12865
12075
|
/**
|
|
12866
12076
|
* @interface
|
|
12867
12077
|
*/
|
|
12868
|
-
declare type
|
|
12078
|
+
declare type RegistryInfo_2 = {
|
|
12869
12079
|
data: any;
|
|
12870
12080
|
rootKey: string;
|
|
12871
12081
|
subkey: string;
|
|
@@ -12886,15 +12096,6 @@ declare interface RemoteConfig extends ExistingConnectConfig {
|
|
|
12886
12096
|
token: string;
|
|
12887
12097
|
}
|
|
12888
12098
|
|
|
12889
|
-
/**
|
|
12890
|
-
* Generated when a View is removed from a layout.
|
|
12891
|
-
* @interface
|
|
12892
|
-
*/
|
|
12893
|
-
declare type RemovedFromLayoutEvent = BaseEvent_4 & {
|
|
12894
|
-
type: 'removed-from-layout';
|
|
12895
|
-
layoutIdentity: OpenFin.LayoutIdentity;
|
|
12896
|
-
};
|
|
12897
|
-
|
|
12898
12099
|
/**
|
|
12899
12100
|
* @interface
|
|
12900
12101
|
*/
|
|
@@ -12923,14 +12124,14 @@ declare type ReplaceLayoutPayload = {
|
|
|
12923
12124
|
/**
|
|
12924
12125
|
* Identity of the window whose layout will be replaced.
|
|
12925
12126
|
*/
|
|
12926
|
-
target:
|
|
12127
|
+
target: Identity_5 | LayoutIdentity;
|
|
12927
12128
|
};
|
|
12928
12129
|
|
|
12929
12130
|
/**
|
|
12930
12131
|
* @interface
|
|
12931
12132
|
*/
|
|
12932
12133
|
declare type ReplaceViewOptions = {
|
|
12933
|
-
viewToReplace:
|
|
12134
|
+
viewToReplace: Identity_5;
|
|
12934
12135
|
newView: ViewState;
|
|
12935
12136
|
};
|
|
12936
12137
|
|
|
@@ -12939,7 +12140,7 @@ declare type ReplaceViewOptions = {
|
|
|
12939
12140
|
*/
|
|
12940
12141
|
declare type ReplaceViewPayload = {
|
|
12941
12142
|
opts: {
|
|
12942
|
-
viewToReplace:
|
|
12143
|
+
viewToReplace: Identity_5;
|
|
12943
12144
|
newView: Partial<ViewOptions>;
|
|
12944
12145
|
};
|
|
12945
12146
|
target: LayoutIdentity;
|
|
@@ -13061,17 +12262,6 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
|
|
|
13061
12262
|
};
|
|
13062
12263
|
}
|
|
13063
12264
|
|
|
13064
|
-
/**
|
|
13065
|
-
* Controls the behavior of the navigation URI pattern matching algorithm.
|
|
13066
|
-
*/
|
|
13067
|
-
declare type RuleMatchOptions = {
|
|
13068
|
-
/**
|
|
13069
|
-
* Matches all schemes rather than just http and https when a wild card is specified. For example, `'*://*.site.com'` will
|
|
13070
|
-
* only match urls which begin with `'http:'` or `'https:'` unless this setting is `true`.
|
|
13071
|
-
*/
|
|
13072
|
-
matchAllSchemes?: boolean;
|
|
13073
|
-
};
|
|
13074
|
-
|
|
13075
12265
|
declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
13076
12266
|
|
|
13077
12267
|
/**
|
|
@@ -13214,21 +12404,6 @@ declare type ScreenshotPrintOptions = {
|
|
|
13214
12404
|
content: 'screenshot';
|
|
13215
12405
|
};
|
|
13216
12406
|
|
|
13217
|
-
/**
|
|
13218
|
-
* An event generated when an application modifies the runtime in a way that affects all other applications in the
|
|
13219
|
-
* application runtime/security realm.
|
|
13220
|
-
*/
|
|
13221
|
-
declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
13222
|
-
/**
|
|
13223
|
-
* Config URL of the application that modified the security realm's extensions
|
|
13224
|
-
*/
|
|
13225
|
-
configUrl: string;
|
|
13226
|
-
/**
|
|
13227
|
-
* Identity of the application that modified the security realm's extensions
|
|
13228
|
-
*/
|
|
13229
|
-
applicationIdentity: OpenFin.ApplicationIdentity;
|
|
13230
|
-
};
|
|
13231
|
-
|
|
13232
12407
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
13233
12408
|
data: ProtocolMap[T]['response'];
|
|
13234
12409
|
} & ProtocolMap[T]['specialResponse']>;
|
|
@@ -13320,7 +12495,7 @@ declare type SetWindowContextPayload = {
|
|
|
13320
12495
|
/**
|
|
13321
12496
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
13322
12497
|
*/
|
|
13323
|
-
target:
|
|
12498
|
+
target: Identity_5;
|
|
13324
12499
|
};
|
|
13325
12500
|
|
|
13326
12501
|
/**
|
|
@@ -13539,7 +12714,7 @@ declare type Snapshot = {
|
|
|
13539
12714
|
* _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.
|
|
13540
12715
|
* @interface
|
|
13541
12716
|
*/
|
|
13542
|
-
declare type SnapshotAppliedEvent =
|
|
12717
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
13543
12718
|
topic: 'application';
|
|
13544
12719
|
type: 'platform-snapshot-applied';
|
|
13545
12720
|
};
|
|
@@ -13764,7 +12939,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13764
12939
|
* fin.System.getAllWindows().then(wins => console.log(wins)).catch(err => console.log(err));
|
|
13765
12940
|
* ```
|
|
13766
12941
|
*/
|
|
13767
|
-
getAllWindows(): Promise<Array<
|
|
12942
|
+
getAllWindows(): Promise<Array<ApplicationWindowInfo>>;
|
|
13768
12943
|
/**
|
|
13769
12944
|
* Retrieves an array of data for all applications.
|
|
13770
12945
|
*
|
|
@@ -13773,7 +12948,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13773
12948
|
* fin.System.getAllApplications().then(apps => console.log(apps)).catch(err => console.log(err));
|
|
13774
12949
|
* ```
|
|
13775
12950
|
*/
|
|
13776
|
-
getAllApplications(): Promise<Array<
|
|
12951
|
+
getAllApplications(): Promise<Array<ApplicationState>>;
|
|
13777
12952
|
/**
|
|
13778
12953
|
* Retrieves the command line argument string that started OpenFin Runtime.
|
|
13779
12954
|
*
|
|
@@ -13848,7 +13023,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13848
13023
|
* }
|
|
13849
13024
|
* ```
|
|
13850
13025
|
*/
|
|
13851
|
-
getEntityInfo(uuid: string, name: string): Promise<
|
|
13026
|
+
getEntityInfo(uuid: string, name: string): Promise<EntityInfo>;
|
|
13852
13027
|
/**
|
|
13853
13028
|
* Gets the value of a given environment variable on the computer on which the runtime is installed
|
|
13854
13029
|
*
|
|
@@ -13859,9 +13034,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13859
13034
|
*/
|
|
13860
13035
|
getEnvironmentVariable(envName: string): Promise<string>;
|
|
13861
13036
|
/**
|
|
13862
|
-
* Get
|
|
13863
|
-
* If a View currently has focus, returns the identity of View's parent Window.
|
|
13864
|
-
* Use {@link Window._Window#getFocusedContent Window.getFocusedContent} to directly access currently focused Window or View.
|
|
13037
|
+
* Get current focused window.
|
|
13865
13038
|
*
|
|
13866
13039
|
* @example
|
|
13867
13040
|
* ```js
|
|
@@ -13869,17 +13042,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13869
13042
|
* ```
|
|
13870
13043
|
*/
|
|
13871
13044
|
getFocusedWindow(): Promise<OpenFin.Identity | null>;
|
|
13872
|
-
/**
|
|
13873
|
-
* Get currently focused content. Returns identity of entity with `entityType`.
|
|
13874
|
-
*
|
|
13875
|
-
* @example
|
|
13876
|
-
* ```js
|
|
13877
|
-
* fin.System.getFocusedContent().then(contentIdentity => console.log(contentIdentity)).catch(err => console.log(err));
|
|
13878
|
-
* ```
|
|
13879
|
-
*/
|
|
13880
|
-
getFocusedContent(): Promise<(OpenFin.Identity & {
|
|
13881
|
-
entityType: 'window' | 'view';
|
|
13882
|
-
}) | null>;
|
|
13883
13045
|
/**
|
|
13884
13046
|
* Returns information about the given app's certification status
|
|
13885
13047
|
*
|
|
@@ -13903,7 +13065,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13903
13065
|
* ```
|
|
13904
13066
|
*/
|
|
13905
13067
|
getInstalledRuntimes(): Promise<string[]>;
|
|
13906
|
-
getInstalledApps(): Promise<
|
|
13068
|
+
getInstalledApps(): Promise<InstalledApps>;
|
|
13907
13069
|
/**
|
|
13908
13070
|
* Retrieves the contents of the log with the specified filename.
|
|
13909
13071
|
* @param options A object that id defined by the GetLogRequestType interface
|
|
@@ -13918,7 +13080,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13918
13080
|
* getLog().then(log => console.log(log)).catch(err => console.log(err));
|
|
13919
13081
|
* ```
|
|
13920
13082
|
*/
|
|
13921
|
-
getLog(options:
|
|
13083
|
+
getLog(options: GetLogRequestType): Promise<string>;
|
|
13922
13084
|
/**
|
|
13923
13085
|
* Returns a unique identifier (UUID) provided by the machine.
|
|
13924
13086
|
*
|
|
@@ -13936,7 +13098,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13936
13098
|
* fin.System.getMinLogLevel().then(level => console.log(level)).catch(err => console.log(err));
|
|
13937
13099
|
* ```
|
|
13938
13100
|
*/
|
|
13939
|
-
getMinLogLevel(): Promise<
|
|
13101
|
+
getMinLogLevel(): Promise<LogLevel>;
|
|
13940
13102
|
/**
|
|
13941
13103
|
* Retrieves an array containing information for each log file.
|
|
13942
13104
|
*
|
|
@@ -13945,7 +13107,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13945
13107
|
* fin.System.getLogList().then(logList => console.log(logList)).catch(err => console.log(err));
|
|
13946
13108
|
* ```
|
|
13947
13109
|
*/
|
|
13948
|
-
getLogList(): Promise<Array<
|
|
13110
|
+
getLogList(): Promise<Array<LogInfo>>;
|
|
13949
13111
|
/**
|
|
13950
13112
|
* Retrieves an object that contains data about the monitor setup of the
|
|
13951
13113
|
* computer that the runtime is running on.
|
|
@@ -14016,7 +13178,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14016
13178
|
* }
|
|
14017
13179
|
* ```
|
|
14018
13180
|
*/
|
|
14019
|
-
getProxySettings(): Promise<
|
|
13181
|
+
getProxySettings(): Promise<ProxyInfo>;
|
|
14020
13182
|
/**
|
|
14021
13183
|
* Returns information about the running Runtime in an object.
|
|
14022
13184
|
*
|
|
@@ -14036,8 +13198,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14036
13198
|
*/
|
|
14037
13199
|
getRvmInfo(): Promise<OpenFin.RVMInfo>;
|
|
14038
13200
|
/**
|
|
14039
|
-
* Retrieves
|
|
14040
|
-
* OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
|
|
13201
|
+
* Retrieves system information.
|
|
14041
13202
|
*
|
|
14042
13203
|
* @example
|
|
14043
13204
|
* ```js
|
|
@@ -14045,15 +13206,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14045
13206
|
* ```
|
|
14046
13207
|
*/
|
|
14047
13208
|
getHostSpecs(): Promise<OpenFin.HostSpecs>;
|
|
14048
|
-
/**
|
|
14049
|
-
* Retrieves information about the OS and the currently logged in user.
|
|
14050
|
-
*
|
|
14051
|
-
* @example
|
|
14052
|
-
* ```js
|
|
14053
|
-
* fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
|
|
14054
|
-
* ```
|
|
14055
|
-
*/
|
|
14056
|
-
getOSInfo(): Promise<OpenFin.OSInfo>;
|
|
14057
13209
|
/**
|
|
14058
13210
|
* Runs an executable or batch file. A path to the file must be included in options.
|
|
14059
13211
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -14383,7 +13535,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14383
13535
|
* }
|
|
14384
13536
|
* ```
|
|
14385
13537
|
*/
|
|
14386
|
-
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<
|
|
13538
|
+
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<Identity_2>;
|
|
14387
13539
|
/**
|
|
14388
13540
|
* Monitors a running process. A pid for the process must be included in options.
|
|
14389
13541
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -14400,7 +13552,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14400
13552
|
* }).then(processIdentity => console.log(processIdentity)).catch(err => console.log(err));
|
|
14401
13553
|
* ```
|
|
14402
13554
|
*/
|
|
14403
|
-
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<
|
|
13555
|
+
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<Identity_2>;
|
|
14404
13556
|
/**
|
|
14405
13557
|
* Writes the passed message into both the log file and the console.
|
|
14406
13558
|
* @param level The log level for the entry. Can be either "info", "warning" or "error"
|
|
@@ -14534,7 +13686,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14534
13686
|
*
|
|
14535
13687
|
* @tutorial System.showDeveloperTools
|
|
14536
13688
|
*/
|
|
14537
|
-
showDeveloperTools(identity:
|
|
13689
|
+
showDeveloperTools(identity: Identity_2): Promise<void>;
|
|
14538
13690
|
/**
|
|
14539
13691
|
* Attempt to close an external process. The process will be terminated if it
|
|
14540
13692
|
* has not closed after the elapsed timeout in milliseconds.
|
|
@@ -14568,7 +13720,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14568
13720
|
* .catch(err => console.error(err));
|
|
14569
13721
|
* ```
|
|
14570
13722
|
*/
|
|
14571
|
-
updateProxySettings(options:
|
|
13723
|
+
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
14572
13724
|
/**
|
|
14573
13725
|
* Downloads the given application asset.
|
|
14574
13726
|
*
|
|
@@ -14660,7 +13812,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14660
13812
|
* .catch(err => console.log(err));
|
|
14661
13813
|
* ```
|
|
14662
13814
|
*/
|
|
14663
|
-
getAllExternalApplications(): Promise<Array<
|
|
13815
|
+
getAllExternalApplications(): Promise<Array<Identity_2>>;
|
|
14664
13816
|
/**
|
|
14665
13817
|
* Retrieves app asset information.
|
|
14666
13818
|
* @param options
|
|
@@ -14689,7 +13841,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14689
13841
|
* fin.System.setMinLogLevel("verbose").then(() => console.log("log level is set to verbose")).catch(err => console.log(err));
|
|
14690
13842
|
* ```
|
|
14691
13843
|
*/
|
|
14692
|
-
setMinLogLevel(level:
|
|
13844
|
+
setMinLogLevel(level: LogLevel): Promise<void>;
|
|
14693
13845
|
/**
|
|
14694
13846
|
* Retrieves the UUID of the computer on which the runtime is installed
|
|
14695
13847
|
* @param uuid The uuid of the running application
|
|
@@ -14699,7 +13851,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14699
13851
|
* fin.System.resolveUuid('OpenfinPOC').then(entity => console.log(entity)).catch(err => console.log(err));
|
|
14700
13852
|
* ```
|
|
14701
13853
|
*/
|
|
14702
|
-
resolveUuid(uuid: string): Promise<
|
|
13854
|
+
resolveUuid(uuid: string): Promise<Entity>;
|
|
14703
13855
|
/**
|
|
14704
13856
|
* Retrieves an array of data for all external applications
|
|
14705
13857
|
* @param requestingIdentity This object is described in the Identity typedef
|
|
@@ -14707,7 +13859,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14707
13859
|
*
|
|
14708
13860
|
* @ignore
|
|
14709
13861
|
*/
|
|
14710
|
-
executeOnRemote(requestingIdentity:
|
|
13862
|
+
executeOnRemote(requestingIdentity: Identity_2, data: any): Promise<any>;
|
|
14711
13863
|
/**
|
|
14712
13864
|
* Reads the specifed value from the registry.
|
|
14713
13865
|
* @remarks This method is restricted by default and must be enabled via
|
|
@@ -14800,7 +13952,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14800
13952
|
* }
|
|
14801
13953
|
* ```
|
|
14802
13954
|
*/
|
|
14803
|
-
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<
|
|
13955
|
+
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<RegistryInfo>;
|
|
14804
13956
|
/**
|
|
14805
13957
|
* This function call will register a unique id and produce a token.
|
|
14806
13958
|
* The token can be used to broker an external connection.
|
|
@@ -15015,7 +14167,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15015
14167
|
* });
|
|
15016
14168
|
* ```
|
|
15017
14169
|
*/
|
|
15018
|
-
getPrinters(): Promise<
|
|
14170
|
+
getPrinters(): Promise<PrinterInfo[]>;
|
|
15019
14171
|
/**
|
|
15020
14172
|
* Updates Process Logging values: periodic interval and outlier detection entries and interval.
|
|
15021
14173
|
* @param options Process Logging updatable options.
|
|
@@ -15133,16 +14285,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15133
14285
|
* ```
|
|
15134
14286
|
*/
|
|
15135
14287
|
setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
|
|
15136
|
-
/**
|
|
15137
|
-
* Attempts to install and enable extensions for the security realm. Users may want to call this function in response
|
|
15138
|
-
* to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
|
|
15139
|
-
* will be installed/enabled.
|
|
15140
|
-
*/
|
|
15141
|
-
refreshExtensions(): Promise<string[] | undefined>;
|
|
15142
|
-
/**
|
|
15143
|
-
* Gets the currently-installed
|
|
15144
|
-
*/
|
|
15145
|
-
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
15146
14288
|
}
|
|
15147
14289
|
|
|
15148
14290
|
/**
|
|
@@ -15173,19 +14315,11 @@ declare namespace SystemEvents {
|
|
|
15173
14315
|
ApplicationCreatedEvent,
|
|
15174
14316
|
DesktopIconClickedEvent,
|
|
15175
14317
|
SystemShutdownEvent,
|
|
15176
|
-
ExtensionsEnabledEvent,
|
|
15177
|
-
ExtensionsDisabledEvent,
|
|
15178
|
-
ExtensionsExcludedEvent,
|
|
15179
|
-
ExtensionsInstalledEvent,
|
|
15180
|
-
ExtensionInstalledEvent,
|
|
15181
|
-
ExtensionsInstallFailedEvent,
|
|
15182
|
-
ExtensionInstallFailedEvent,
|
|
15183
|
-
ExtensionsInitializationFailedEvent,
|
|
15184
14318
|
Event_11 as Event,
|
|
15185
14319
|
SystemEvent,
|
|
15186
14320
|
EventType_8 as EventType,
|
|
15187
14321
|
SystemEventType,
|
|
15188
|
-
|
|
14322
|
+
Payload_9 as Payload,
|
|
15189
14323
|
ByType_8 as ByType
|
|
15190
14324
|
}
|
|
15191
14325
|
}
|
|
@@ -15199,7 +14333,6 @@ declare type SystemEventType = EventType_8;
|
|
|
15199
14333
|
* @interface
|
|
15200
14334
|
*/
|
|
15201
14335
|
declare type SystemPermissions = {
|
|
15202
|
-
getOSInfo: boolean;
|
|
15203
14336
|
getAllExternalWindows: boolean;
|
|
15204
14337
|
launchExternalProcess: boolean | {
|
|
15205
14338
|
enabled: boolean;
|
|
@@ -15467,8 +14600,6 @@ declare type Time = {
|
|
|
15467
14600
|
irq: number;
|
|
15468
14601
|
};
|
|
15469
14602
|
|
|
15470
|
-
declare type TimeZones = 'utc' | 'local';
|
|
15471
|
-
|
|
15472
14603
|
/**
|
|
15473
14604
|
* @interface
|
|
15474
14605
|
*/
|
|
@@ -15652,11 +14783,14 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
15652
14783
|
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
|
15653
14784
|
|
|
15654
14785
|
/**
|
|
15655
|
-
*
|
|
15656
|
-
*
|
|
14786
|
+
* A general user bounds change event without event type.
|
|
15657
14787
|
* @interface
|
|
15658
14788
|
*/
|
|
15659
|
-
declare type UserBoundsChangeEvent =
|
|
14789
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
|
14790
|
+
height: number;
|
|
14791
|
+
left: number;
|
|
14792
|
+
top: number;
|
|
14793
|
+
width: number;
|
|
15660
14794
|
windowState: 'minimized' | 'normal' | 'maximized';
|
|
15661
14795
|
};
|
|
15662
14796
|
|
|
@@ -15938,8 +15072,6 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
15938
15072
|
* left: 100,
|
|
15939
15073
|
* width: 300,
|
|
15940
15074
|
* height: 300
|
|
15941
|
-
* }, {
|
|
15942
|
-
* bringToFront : true
|
|
15943
15075
|
* });
|
|
15944
15076
|
* }
|
|
15945
15077
|
*
|
|
@@ -15949,15 +15081,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
15949
15081
|
* ```
|
|
15950
15082
|
* @experimental
|
|
15951
15083
|
*/
|
|
15952
|
-
showAt: (bounds: OpenFin.Bounds
|
|
15953
|
-
/**
|
|
15954
|
-
* Brings the specified view to the front of its current window. This ensures the view will be visible on top of any other views
|
|
15955
|
-
* which have overlapping bounds with it.
|
|
15956
|
-
*
|
|
15957
|
-
* 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
|
|
15958
|
-
* in the window that share bounds with it.
|
|
15959
|
-
*/
|
|
15960
|
-
bringToFront: () => Promise<void>;
|
|
15084
|
+
showAt: (bounds: OpenFin.Bounds) => Promise<void>;
|
|
15961
15085
|
/**
|
|
15962
15086
|
* Hides the current view if it is currently visible.
|
|
15963
15087
|
*
|
|
@@ -16255,24 +15379,6 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
16255
15379
|
options?: Partial<ViewOptions>;
|
|
16256
15380
|
};
|
|
16257
15381
|
|
|
16258
|
-
/**
|
|
16259
|
-
* @interface
|
|
16260
|
-
*/
|
|
16261
|
-
declare type ViewCreationFailure = {
|
|
16262
|
-
/**
|
|
16263
|
-
* The identity of the created view
|
|
16264
|
-
*/
|
|
16265
|
-
identity: Identity_4;
|
|
16266
|
-
/**
|
|
16267
|
-
* Whether the view was created with errors
|
|
16268
|
-
*/
|
|
16269
|
-
success: false;
|
|
16270
|
-
/**
|
|
16271
|
-
* Error thrown during view creation
|
|
16272
|
-
*/
|
|
16273
|
-
error: Error;
|
|
16274
|
-
};
|
|
16275
|
-
|
|
16276
15382
|
/**
|
|
16277
15383
|
* The options object required by {@link View.ViewModule.create View.create}.
|
|
16278
15384
|
*
|
|
@@ -16283,30 +15389,11 @@ declare type ViewCreationFailure = {
|
|
|
16283
15389
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
16284
15390
|
name: string;
|
|
16285
15391
|
url: string;
|
|
16286
|
-
target:
|
|
15392
|
+
target: Identity_5;
|
|
16287
15393
|
};
|
|
16288
15394
|
|
|
16289
15395
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
|
16290
15396
|
|
|
16291
|
-
/**
|
|
16292
|
-
* A view creation state
|
|
16293
|
-
*/
|
|
16294
|
-
declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
|
|
16295
|
-
|
|
16296
|
-
/**
|
|
16297
|
-
* @interface
|
|
16298
|
-
*/
|
|
16299
|
-
declare type ViewCreationSuccess = {
|
|
16300
|
-
/**
|
|
16301
|
-
* The identity of the created view
|
|
16302
|
-
*/
|
|
16303
|
-
identity: Identity_4;
|
|
16304
|
-
/**
|
|
16305
|
-
* Whether the view was created without errors
|
|
16306
|
-
*/
|
|
16307
|
-
success: true;
|
|
16308
|
-
};
|
|
16309
|
-
|
|
16310
15397
|
/**
|
|
16311
15398
|
* Generated when a window has a view detached from it.
|
|
16312
15399
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
@@ -16331,8 +15418,6 @@ declare namespace ViewEvents {
|
|
|
16331
15418
|
BaseEvent_4 as BaseEvent,
|
|
16332
15419
|
BaseViewEvent,
|
|
16333
15420
|
TargetChangedEvent,
|
|
16334
|
-
AddedToLayoutEvent,
|
|
16335
|
-
RemovedFromLayoutEvent,
|
|
16336
15421
|
NonPropagatedViewEvent,
|
|
16337
15422
|
CreatedEvent,
|
|
16338
15423
|
DestroyedEvent,
|
|
@@ -16349,7 +15434,7 @@ declare namespace ViewEvents {
|
|
|
16349
15434
|
PropagatedViewEvent,
|
|
16350
15435
|
PropagatedEventType_2 as PropagatedEventType,
|
|
16351
15436
|
PropagatedViewEventType,
|
|
16352
|
-
|
|
15437
|
+
Payload_2 as Payload,
|
|
16353
15438
|
ByType
|
|
16354
15439
|
}
|
|
16355
15440
|
}
|
|
@@ -16468,17 +15553,6 @@ declare class ViewModule extends Base {
|
|
|
16468
15553
|
*/
|
|
16469
15554
|
declare type ViewOptions = ConstViewOptions & MutableViewOptions;
|
|
16470
15555
|
|
|
16471
|
-
/**
|
|
16472
|
-
* @interface
|
|
16473
|
-
*/
|
|
16474
|
-
declare type ViewShowAtOptions = {
|
|
16475
|
-
/**
|
|
16476
|
-
* Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
|
|
16477
|
-
* @default false
|
|
16478
|
-
*/
|
|
16479
|
-
bringToFront?: true;
|
|
16480
|
-
};
|
|
16481
|
-
|
|
16482
15556
|
/**
|
|
16483
15557
|
* Represents the payload shape for Views that are trying to prevent an unload.
|
|
16484
15558
|
* @interface
|
|
@@ -16491,15 +15565,15 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
16491
15565
|
/**
|
|
16492
15566
|
* Identity of the Window.
|
|
16493
15567
|
*/
|
|
16494
|
-
windowId:
|
|
15568
|
+
windowId: Identity_5;
|
|
16495
15569
|
/**
|
|
16496
15570
|
* Identities of the Views that are preventing an unload
|
|
16497
15571
|
*/
|
|
16498
|
-
viewsPreventingUnload:
|
|
15572
|
+
viewsPreventingUnload: Identity_5[];
|
|
16499
15573
|
/**
|
|
16500
15574
|
* Identities of the Views that are not preventing an unload
|
|
16501
15575
|
*/
|
|
16502
|
-
viewsNotPreventingUnload:
|
|
15576
|
+
viewsNotPreventingUnload: Identity_5[];
|
|
16503
15577
|
/**
|
|
16504
15578
|
* Source of the close action.
|
|
16505
15579
|
*/
|
|
@@ -16510,6 +15584,7 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
16510
15584
|
* @interface
|
|
16511
15585
|
*/
|
|
16512
15586
|
declare type ViewState = ViewCreationOptions & {
|
|
15587
|
+
backgroundThrottling: boolean;
|
|
16513
15588
|
componentName: 'view';
|
|
16514
15589
|
initialUrl: string;
|
|
16515
15590
|
minWidth?: number;
|
|
@@ -16524,21 +15599,13 @@ declare interface ViewStatuses {
|
|
|
16524
15599
|
/**
|
|
16525
15600
|
* Identities of the Views that are preventing an unload.
|
|
16526
15601
|
*/
|
|
16527
|
-
viewsPreventingUnload:
|
|
15602
|
+
viewsPreventingUnload: Identity_5[];
|
|
16528
15603
|
/**
|
|
16529
15604
|
* Identities of the Views that are not preventing an unload.
|
|
16530
15605
|
*/
|
|
16531
|
-
viewsNotPreventingUnload:
|
|
15606
|
+
viewsNotPreventingUnload: Identity_5[];
|
|
16532
15607
|
}
|
|
16533
15608
|
|
|
16534
|
-
/**
|
|
16535
|
-
* View throttling state.
|
|
16536
|
-
*
|
|
16537
|
-
* * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
|
|
16538
|
-
* * `scheduler-disabled`: background throttling is true, but scheduler throttling is disabled.
|
|
16539
|
-
*/
|
|
16540
|
-
declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
16541
|
-
|
|
16542
15609
|
/**
|
|
16543
15610
|
* Configuration for view visibility settings
|
|
16544
15611
|
*
|
|
@@ -17033,7 +16100,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17033
16100
|
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
17034
16101
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
17035
16102
|
*/
|
|
17036
|
-
stopFindInPage(action:
|
|
16103
|
+
stopFindInPage(action: string): Promise<void>;
|
|
17037
16104
|
/**
|
|
17038
16105
|
* Returns an array with all system printers
|
|
17039
16106
|
* @deprecated use System.getPrinters instead
|
|
@@ -17172,7 +16239,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17172
16239
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17173
16240
|
* });
|
|
17174
16241
|
*
|
|
17175
|
-
* await view.navigate('
|
|
16242
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17176
16243
|
*
|
|
17177
16244
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17178
16245
|
* ```
|
|
@@ -17183,7 +16250,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17183
16250
|
* name:'child',
|
|
17184
16251
|
* defaultWidth: 300,
|
|
17185
16252
|
* defaultHeight: 300,
|
|
17186
|
-
* url: '
|
|
16253
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17187
16254
|
* frame: true,
|
|
17188
16255
|
* autoShow: true
|
|
17189
16256
|
* };
|
|
@@ -17208,7 +16275,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17208
16275
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17209
16276
|
* });
|
|
17210
16277
|
*
|
|
17211
|
-
* await view.navigate('
|
|
16278
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17212
16279
|
*
|
|
17213
16280
|
* await view.inspectSharedWorker();
|
|
17214
16281
|
* ```
|
|
@@ -17219,7 +16286,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17219
16286
|
* name:'child',
|
|
17220
16287
|
* defaultWidth: 300,
|
|
17221
16288
|
* defaultHeight: 300,
|
|
17222
|
-
* url: '
|
|
16289
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17223
16290
|
* frame: true,
|
|
17224
16291
|
* autoShow: true
|
|
17225
16292
|
* };
|
|
@@ -17245,7 +16312,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17245
16312
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17246
16313
|
* });
|
|
17247
16314
|
*
|
|
17248
|
-
* await view.navigate('
|
|
16315
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17249
16316
|
*
|
|
17250
16317
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17251
16318
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -17257,7 +16324,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17257
16324
|
* name:'child',
|
|
17258
16325
|
* defaultWidth: 300,
|
|
17259
16326
|
* defaultHeight: 300,
|
|
17260
|
-
* url: '
|
|
16327
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17261
16328
|
* frame: true,
|
|
17262
16329
|
* autoShow: true
|
|
17263
16330
|
* };
|
|
@@ -17626,7 +16693,11 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
17626
16693
|
* A general will-move or will-resize event without event type.
|
|
17627
16694
|
* @interface
|
|
17628
16695
|
*/
|
|
17629
|
-
declare type WillMoveOrResizeEvent =
|
|
16696
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
|
16697
|
+
height: number;
|
|
16698
|
+
left: number;
|
|
16699
|
+
top: number;
|
|
16700
|
+
width: number;
|
|
17630
16701
|
monitorScaleFactor: number;
|
|
17631
16702
|
};
|
|
17632
16703
|
|
|
@@ -18818,21 +17889,16 @@ declare namespace WindowEvents {
|
|
|
18818
17889
|
PreloadScriptInfoRunning,
|
|
18819
17890
|
PreloadScriptInfo,
|
|
18820
17891
|
PreloadScriptsStateChangeEvent,
|
|
18821
|
-
|
|
17892
|
+
UserBoundsChangeEvent,
|
|
18822
17893
|
BoundsChangeEvent,
|
|
18823
17894
|
WillMoveOrResizeEvent,
|
|
18824
|
-
BoundsDidChangeEvent,
|
|
18825
|
-
BoundsChangedEvent,
|
|
18826
|
-
BoundsChangingEvent,
|
|
18827
|
-
DisabledMovementBoundsChangedEvent,
|
|
18828
|
-
DisabledMovementBoundsChangingEvent,
|
|
18829
|
-
UserBoundsChangeEvent,
|
|
18830
|
-
BeginUserBoundsChangingEvent,
|
|
18831
|
-
EndUserBoundsChangingEvent,
|
|
18832
17895
|
PerformanceReportEvent,
|
|
18833
17896
|
InputEvent_2 as InputEvent,
|
|
18834
17897
|
LayoutInitializedEvent,
|
|
18835
17898
|
LayoutReadyEvent,
|
|
17899
|
+
BeginUserBoundsChangingEvent,
|
|
17900
|
+
BoundsChangedEvent,
|
|
17901
|
+
BoundsChangingEvent,
|
|
18836
17902
|
CloseRequestedEvent,
|
|
18837
17903
|
WindowCloseRequestedEvent,
|
|
18838
17904
|
ContextChangedEvent,
|
|
@@ -18840,7 +17906,10 @@ declare namespace WindowEvents {
|
|
|
18840
17906
|
WindowClosedEvent,
|
|
18841
17907
|
ClosingEvent,
|
|
18842
17908
|
WindowClosingEvent,
|
|
17909
|
+
DisabledMovementBoundsChangedEvent,
|
|
17910
|
+
DisabledMovementBoundsChangingEvent,
|
|
18843
17911
|
EmbeddedEvent,
|
|
17912
|
+
EndUserBoundsChangingEvent,
|
|
18844
17913
|
HotkeyEvent_2 as HotkeyEvent,
|
|
18845
17914
|
WindowHotkeyEvent,
|
|
18846
17915
|
InitializedEvent_2 as InitializedEvent,
|
|
@@ -18871,7 +17940,7 @@ declare namespace WindowEvents {
|
|
|
18871
17940
|
PropagatedEvent_3 as PropagatedEvent,
|
|
18872
17941
|
PropagatedWindowEvent,
|
|
18873
17942
|
PropagatedWindowEventType,
|
|
18874
|
-
|
|
17943
|
+
Payload_3 as Payload,
|
|
18875
17944
|
ByType_2 as ByType
|
|
18876
17945
|
}
|
|
18877
17946
|
}
|
|
@@ -19080,16 +18149,6 @@ declare type WindowStartLoadEvent = BaseEvent_3 & {
|
|
|
19080
18149
|
*/
|
|
19081
18150
|
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
|
19082
18151
|
|
|
19083
|
-
/**
|
|
19084
|
-
*
|
|
19085
|
-
* Window throttling state.
|
|
19086
|
-
*
|
|
19087
|
-
* * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
|
|
19088
|
-
* * `scheduler-disabled`: The background throttling is true, but scheduler throttling is disabled.
|
|
19089
|
-
* * `disabled`: The background throttling is false. The throttling is fully disabled.
|
|
19090
|
-
*/
|
|
19091
|
-
declare type WindowThrottling = 'enabled' | 'scheduler-disabled' | 'disabled';
|
|
19092
|
-
|
|
19093
18152
|
/**
|
|
19094
18153
|
* A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
|
|
19095
18154
|
* to the `Application` level, with the name pattern `window-view-eventname`.
|