@openfin/node-adapter 34.78.10 → 34.78.12
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/node-adapter-alpha.d.ts +571 -130
- package/out/node-adapter-beta.d.ts +571 -130
- package/out/node-adapter-public.d.ts +571 -130
- package/out/node-adapter.d.ts +579 -109
- package/out/node-adapter.js +163 -601
- package/package.json +4 -4
package/out/node-adapter.d.ts
CHANGED
@@ -7,6 +7,8 @@ import { EventEmitter } from 'events';
|
|
7
7
|
|
8
8
|
/**
|
9
9
|
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
10
|
+
*
|
11
|
+
* @interface
|
10
12
|
*/
|
11
13
|
declare type Accelerator = {
|
12
14
|
/**
|
@@ -43,6 +45,9 @@ declare type Accelerator = {
|
|
43
45
|
zoom: boolean;
|
44
46
|
};
|
45
47
|
|
48
|
+
/**
|
49
|
+
* @interface
|
50
|
+
*/
|
46
51
|
declare type AddViewToStackOptions = {
|
47
52
|
/**
|
48
53
|
* Optional index within the stack to insert the view. Defaults to 0
|
@@ -66,6 +71,8 @@ declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<Payl
|
|
66
71
|
|
67
72
|
/**
|
68
73
|
* Configurations for API injection.
|
74
|
+
*
|
75
|
+
* @interface
|
69
76
|
*/
|
70
77
|
declare type Api = {
|
71
78
|
/**
|
@@ -93,6 +100,9 @@ declare type ApiClient<T extends Record<any, any>> = {
|
|
93
100
|
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
94
101
|
};
|
95
102
|
|
103
|
+
/**
|
104
|
+
* @interface
|
105
|
+
*/
|
96
106
|
declare type AppAssetInfo = {
|
97
107
|
/**
|
98
108
|
* The URL to a zip file containing the package files (executables, dlls, etc…)
|
@@ -121,6 +131,9 @@ declare type AppAssetInfo = {
|
|
121
131
|
mandatory?: boolean;
|
122
132
|
};
|
123
133
|
|
134
|
+
/**
|
135
|
+
* @interface
|
136
|
+
*/
|
124
137
|
declare type AppAssetRequest = {
|
125
138
|
alias: string;
|
126
139
|
};
|
@@ -897,10 +910,16 @@ declare type ApplicationEventType = ApplicationEvent['type'];
|
|
897
910
|
|
898
911
|
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
899
912
|
|
913
|
+
/**
|
914
|
+
* @interface
|
915
|
+
*/
|
900
916
|
declare type ApplicationIdentity_2 = {
|
901
917
|
uuid: string;
|
902
918
|
};
|
903
919
|
|
920
|
+
/**
|
921
|
+
* @interface
|
922
|
+
*/
|
904
923
|
declare type ApplicationInfo = {
|
905
924
|
initialOptions: ApplicationCreationOptions;
|
906
925
|
launchMode: string;
|
@@ -1194,6 +1213,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1194
1213
|
enableBeforeUnload: boolean;
|
1195
1214
|
};
|
1196
1215
|
|
1216
|
+
/**
|
1217
|
+
* @interface
|
1218
|
+
*/
|
1197
1219
|
declare type ApplicationPermissions = {
|
1198
1220
|
setFileDownloadLocation: boolean;
|
1199
1221
|
getFileDownloadLocation: boolean;
|
@@ -1201,6 +1223,9 @@ declare type ApplicationPermissions = {
|
|
1201
1223
|
|
1202
1224
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1203
1225
|
|
1226
|
+
/**
|
1227
|
+
* @interface
|
1228
|
+
*/
|
1204
1229
|
declare type ApplicationState_2 = {
|
1205
1230
|
/**
|
1206
1231
|
* True when the application is a Platform controller
|
@@ -1220,6 +1245,9 @@ declare type ApplicationState_2 = {
|
|
1220
1245
|
parentUuid?: string;
|
1221
1246
|
};
|
1222
1247
|
|
1248
|
+
/**
|
1249
|
+
* @interface
|
1250
|
+
*/
|
1223
1251
|
declare type ApplicationType = {
|
1224
1252
|
type: 'application' | 'external-app';
|
1225
1253
|
uuid: string;
|
@@ -1232,6 +1260,9 @@ declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedE
|
|
1232
1260
|
|
1233
1261
|
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
1234
1262
|
|
1263
|
+
/**
|
1264
|
+
* @interface
|
1265
|
+
*/
|
1235
1266
|
declare type ApplicationWindowInfo_2 = {
|
1236
1267
|
childWindows: Array<WindowDetail>;
|
1237
1268
|
mainWindow: WindowDetail;
|
@@ -1241,6 +1272,9 @@ declare type ApplicationWindowInfo_2 = {
|
|
1241
1272
|
uuid: string;
|
1242
1273
|
};
|
1243
1274
|
|
1275
|
+
/**
|
1276
|
+
* @interface
|
1277
|
+
*/
|
1244
1278
|
declare type ApplySnapshotOptions = {
|
1245
1279
|
/**
|
1246
1280
|
* @defaultValue false
|
@@ -1268,6 +1302,8 @@ declare type ApplySnapshotOptions = {
|
|
1268
1302
|
|
1269
1303
|
/**
|
1270
1304
|
* Payload sent to Platform Provider when {@link Platform#applySnapshot Platform.applySnapshot} is called.
|
1305
|
+
*
|
1306
|
+
* @interface
|
1271
1307
|
*/
|
1272
1308
|
declare type ApplySnapshotPayload = {
|
1273
1309
|
/**
|
@@ -1280,6 +1316,9 @@ declare type ApplySnapshotPayload = {
|
|
1280
1316
|
options?: ApplySnapshotOptions;
|
1281
1317
|
};
|
1282
1318
|
|
1319
|
+
/**
|
1320
|
+
* @interface
|
1321
|
+
*/
|
1283
1322
|
declare type AppProcessInfo = {
|
1284
1323
|
/**
|
1285
1324
|
* The uuid of the application.
|
@@ -1299,6 +1338,9 @@ declare type AppVersionCompleteEvent = {
|
|
1299
1338
|
type: 'app-version-complete';
|
1300
1339
|
} & AppVersionProgress;
|
1301
1340
|
|
1341
|
+
/**
|
1342
|
+
* @interface
|
1343
|
+
*/
|
1302
1344
|
declare type AppVersionError = {
|
1303
1345
|
error: string;
|
1304
1346
|
srcManifest: string;
|
@@ -1327,6 +1369,9 @@ declare type AppVersionEventType = AppVersionEvent['type'];
|
|
1327
1369
|
*/
|
1328
1370
|
declare type AppVersionEventWithId = EventWithId<AppVersionEvent>;
|
1329
1371
|
|
1372
|
+
/**
|
1373
|
+
* @interface
|
1374
|
+
*/
|
1330
1375
|
declare type AppVersionProgress = {
|
1331
1376
|
manifest: string | null;
|
1332
1377
|
srcManifest: string;
|
@@ -1340,6 +1385,9 @@ declare type AppVersionProgressEvent = {
|
|
1340
1385
|
type: 'app-version-progress';
|
1341
1386
|
} & AppVersionProgress;
|
1342
1387
|
|
1388
|
+
/**
|
1389
|
+
* @interface
|
1390
|
+
*/
|
1343
1391
|
declare type AppVersionRuntimeInfo = {
|
1344
1392
|
version: string | null;
|
1345
1393
|
exists: boolean | null;
|
@@ -1459,6 +1507,9 @@ declare type AuthRequestedEvent = NamedEvent & {
|
|
1459
1507
|
*/
|
1460
1508
|
declare type AutoplayPolicyOptions = 'no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required';
|
1461
1509
|
|
1510
|
+
/**
|
1511
|
+
* @interface
|
1512
|
+
*/
|
1462
1513
|
declare type AutoResizeOptions = {
|
1463
1514
|
/**
|
1464
1515
|
* If true, the view's width will grow and shrink together with the window. false
|
@@ -1483,6 +1534,9 @@ declare type AutoResizeOptions = {
|
|
1483
1534
|
};
|
1484
1535
|
|
1485
1536
|
declare class Base {
|
1537
|
+
/**
|
1538
|
+
* @internal
|
1539
|
+
*/
|
1486
1540
|
wire: Transport;
|
1487
1541
|
/**
|
1488
1542
|
* @internal
|
@@ -1504,6 +1558,9 @@ declare type BaseChannelEvent = NamedEvent & {
|
|
1504
1558
|
channelId: string;
|
1505
1559
|
};
|
1506
1560
|
|
1561
|
+
/**
|
1562
|
+
* @interface
|
1563
|
+
*/
|
1507
1564
|
declare type BaseClipboardRequest = {
|
1508
1565
|
/**
|
1509
1566
|
* The type of clipboard to write to, can be 'clipboard' or 'selection'.
|
@@ -1594,8 +1651,9 @@ declare type BaseViewEvent = NamedEvent & {
|
|
1594
1651
|
|
1595
1652
|
/**
|
1596
1653
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
1654
|
+
* @interface
|
1597
1655
|
*/
|
1598
|
-
declare
|
1656
|
+
declare type BeforeUnloadUserDecision = {
|
1599
1657
|
/**
|
1600
1658
|
* Specifies if the Window should close.
|
1601
1659
|
*/
|
@@ -1604,7 +1662,7 @@ declare interface BeforeUnloadUserDecision {
|
|
1604
1662
|
* Array of views that will close.
|
1605
1663
|
*/
|
1606
1664
|
viewsToClose: Identity_5[];
|
1607
|
-
}
|
1665
|
+
};
|
1608
1666
|
|
1609
1667
|
/**
|
1610
1668
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
@@ -1622,6 +1680,9 @@ declare type BlurredEvent = NamedEvent & {
|
|
1622
1680
|
type: 'blurred';
|
1623
1681
|
};
|
1624
1682
|
|
1683
|
+
/**
|
1684
|
+
* @interface
|
1685
|
+
*/
|
1625
1686
|
declare type Bounds = {
|
1626
1687
|
top: number;
|
1627
1688
|
left: number;
|
@@ -1660,8 +1721,10 @@ declare type BoundsChangingEvent = BoundsChangeEvent & {
|
|
1660
1721
|
|
1661
1722
|
/**
|
1662
1723
|
* Configuration for page capture.
|
1724
|
+
*
|
1725
|
+
* @interface
|
1663
1726
|
*/
|
1664
|
-
declare
|
1727
|
+
declare type CapturePageOptions = {
|
1665
1728
|
/**
|
1666
1729
|
* The area of the window to be captured.
|
1667
1730
|
*/
|
@@ -1678,8 +1741,11 @@ declare interface CapturePageOptions {
|
|
1678
1741
|
* Quality of JPEG image. Between 0 - 100.
|
1679
1742
|
*/
|
1680
1743
|
quality?: number;
|
1681
|
-
}
|
1744
|
+
};
|
1682
1745
|
|
1746
|
+
/**
|
1747
|
+
* @interface
|
1748
|
+
*/
|
1683
1749
|
declare type Certificate = {
|
1684
1750
|
data: string;
|
1685
1751
|
fingerprint: string;
|
@@ -1704,6 +1770,9 @@ declare type CertificateErrorEvent = NamedEvent & {
|
|
1704
1770
|
certificate: OpenFin.Certificate;
|
1705
1771
|
};
|
1706
1772
|
|
1773
|
+
/**
|
1774
|
+
* @interface
|
1775
|
+
*/
|
1707
1776
|
declare type CertificatePrincipal = {
|
1708
1777
|
commonName: string;
|
1709
1778
|
country: string;
|
@@ -1723,6 +1792,9 @@ declare type CertificateSelectionShownEvent = NamedEvent & {
|
|
1723
1792
|
certificates: OpenFin.Certificate[];
|
1724
1793
|
};
|
1725
1794
|
|
1795
|
+
/**
|
1796
|
+
* @interface
|
1797
|
+
*/
|
1726
1798
|
declare type CertificationInfo = {
|
1727
1799
|
serial?: string;
|
1728
1800
|
subject?: string;
|
@@ -1731,6 +1803,9 @@ declare type CertificationInfo = {
|
|
1731
1803
|
trusted?: boolean;
|
1732
1804
|
};
|
1733
1805
|
|
1806
|
+
/**
|
1807
|
+
* @interface
|
1808
|
+
*/
|
1734
1809
|
declare type CertifiedAppInfo = {
|
1735
1810
|
isRunning: boolean;
|
1736
1811
|
isOptedIntoCertfiedApp?: boolean;
|
@@ -1920,7 +1995,7 @@ declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
|
|
1920
1995
|
|
1921
1996
|
declare type ChannelAction = OpenFin.ChannelAction;
|
1922
1997
|
|
1923
|
-
declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 |
|
1998
|
+
declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity) => unknown;
|
1924
1999
|
|
1925
2000
|
declare class ChannelBase {
|
1926
2001
|
protected subscriptions: Map<string, ChannelAction>;
|
@@ -2233,7 +2308,7 @@ declare class ChannelClient extends ChannelBase {
|
|
2233
2308
|
/**
|
2234
2309
|
* @internal
|
2235
2310
|
*/
|
2236
|
-
constructor(routingInfo: RoutingInfo, wire: Transport, strategy: AnyStrategy);
|
2311
|
+
constructor(routingInfo: OpenFin.RoutingInfo, wire: Transport, strategy: AnyStrategy);
|
2237
2312
|
protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
|
2238
2313
|
/**
|
2239
2314
|
* a read-only provider identity
|
@@ -2283,7 +2358,7 @@ declare class ChannelClient extends ChannelBase {
|
|
2283
2358
|
* })();
|
2284
2359
|
* ```
|
2285
2360
|
*/
|
2286
|
-
onDisconnection(listener:
|
2361
|
+
onDisconnection(listener: OpenFin.ChannelProviderDisconnectionListener): void;
|
2287
2362
|
/**
|
2288
2363
|
* Disconnects the client from the channel.
|
2289
2364
|
*
|
@@ -2303,6 +2378,10 @@ declare class ChannelClient extends ChannelBase {
|
|
2303
2378
|
|
2304
2379
|
declare type ChannelClient_2 = OpenFin.ChannelClient;
|
2305
2380
|
|
2381
|
+
declare type ChannelClientConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
|
2382
|
+
|
2383
|
+
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
2384
|
+
|
2306
2385
|
/**
|
2307
2386
|
* Generated when a Channel client is connected.
|
2308
2387
|
* @interface
|
@@ -2331,6 +2410,8 @@ declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2331
2410
|
|
2332
2411
|
/**
|
2333
2412
|
* Channel provider creation options.
|
2413
|
+
*
|
2414
|
+
* @interface
|
2334
2415
|
*/
|
2335
2416
|
declare type ChannelCreateOptions = {
|
2336
2417
|
/**
|
@@ -2354,28 +2435,9 @@ declare type ChannelEvent = {
|
|
2354
2435
|
topic: 'channel';
|
2355
2436
|
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
2356
2437
|
|
2357
|
-
declare type ChannelEvent_2 = ChannelEvents.ChannelEvent;
|
2358
|
-
|
2359
|
-
declare namespace ChannelEvents {
|
2360
|
-
export {
|
2361
|
-
BaseChannelEvent,
|
2362
|
-
ChannelConnectedEvent,
|
2363
|
-
ChannelDisconnectedEvent,
|
2364
|
-
ChannelEvent,
|
2365
|
-
ChannelEventType
|
2366
|
-
}
|
2367
|
-
}
|
2368
|
-
|
2369
|
-
/**
|
2370
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
2371
|
-
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
2372
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
2373
|
-
*/
|
2374
|
-
declare type ChannelEventType = ChannelEvent['type'];
|
2375
|
-
|
2376
2438
|
declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
|
2377
2439
|
|
2378
|
-
declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 |
|
2440
|
+
declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity) => Promise<unknown> | unknown;
|
2379
2441
|
|
2380
2442
|
/**
|
2381
2443
|
* Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
|
@@ -2501,7 +2563,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
2501
2563
|
* ```
|
2502
2564
|
* @param listener
|
2503
2565
|
*/
|
2504
|
-
onConnection(listener:
|
2566
|
+
onConnection(listener: OpenFin.ChannelClientConnectionListener): void;
|
2505
2567
|
/**
|
2506
2568
|
* Register a listener that is called on client disconnection. It is passed the disconnection event of the disconnecting
|
2507
2569
|
* client.
|
@@ -2520,7 +2582,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
2520
2582
|
* })();
|
2521
2583
|
* ```
|
2522
2584
|
*/
|
2523
|
-
onDisconnection(listener:
|
2585
|
+
onDisconnection(listener: OpenFin.ChannelClientDisconnectionListener): void;
|
2524
2586
|
/**
|
2525
2587
|
* Destroy the channel, raises `disconnected` events on all connected channel clients.
|
2526
2588
|
*
|
@@ -2575,6 +2637,8 @@ declare class ChannelProvider extends ChannelBase {
|
|
2575
2637
|
private static clientIsMultiRuntime;
|
2576
2638
|
}
|
2577
2639
|
|
2640
|
+
declare type ChannelProviderDisconnectionListener = (identity: ProviderIdentity_7) => any;
|
2641
|
+
|
2578
2642
|
declare interface ChannelStrategy<T extends unknown> {
|
2579
2643
|
onEndpointDisconnect(endpointId: string, listener: () => void): void;
|
2580
2644
|
receive(listener: (action: string, payload: any, identity: any) => Promise<any>): void;
|
@@ -2604,7 +2668,7 @@ declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
|
|
2604
2668
|
|
2605
2669
|
declare interface ChildContentOptions {
|
2606
2670
|
options: any;
|
2607
|
-
entityType:
|
2671
|
+
entityType: EntityType_4;
|
2608
2672
|
}
|
2609
2673
|
|
2610
2674
|
/**
|
@@ -2657,6 +2721,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
|
|
2657
2721
|
isValidEndpointPayload(payload: any): payload is EndpointPayload;
|
2658
2722
|
}
|
2659
2723
|
|
2724
|
+
/**
|
2725
|
+
* @interface
|
2726
|
+
*/
|
2660
2727
|
declare type ClearCacheOption = {
|
2661
2728
|
/**
|
2662
2729
|
* html5 application cache
|
@@ -2676,6 +2743,9 @@ declare type ClearCacheOption = {
|
|
2676
2743
|
localStorage?: boolean;
|
2677
2744
|
};
|
2678
2745
|
|
2746
|
+
/**
|
2747
|
+
* @interface
|
2748
|
+
*/
|
2679
2749
|
declare type ClickedMenuResult<T extends unknown = unknown> = {
|
2680
2750
|
result: 'clicked';
|
2681
2751
|
data: T;
|
@@ -2684,15 +2754,13 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
|
|
2684
2754
|
/**
|
2685
2755
|
* @interface
|
2686
2756
|
*/
|
2687
|
-
declare type ClientConnectionPayload =
|
2688
|
-
|
2689
|
-
declare type ClientIdentity = OpenFin.ClientIdentity;
|
2757
|
+
declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
2690
2758
|
|
2691
2759
|
/**
|
2692
2760
|
* Identity of a channel client
|
2693
2761
|
* @interface
|
2694
2762
|
*/
|
2695
|
-
declare type
|
2763
|
+
declare type ClientIdentity = Identity_5 & {
|
2696
2764
|
/**
|
2697
2765
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
2698
2766
|
*/
|
@@ -2703,7 +2771,7 @@ declare type ClientIdentity_2 = Identity_5 & {
|
|
2703
2771
|
/**
|
2704
2772
|
* @interface
|
2705
2773
|
*/
|
2706
|
-
declare type ClientIdentityMultiRuntime =
|
2774
|
+
declare type ClientIdentityMultiRuntime = ClientIdentity & {
|
2707
2775
|
runtimeUuid: string;
|
2708
2776
|
};
|
2709
2777
|
|
@@ -2711,11 +2779,11 @@ declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
|
|
2711
2779
|
* Extended channel client information
|
2712
2780
|
* @interface
|
2713
2781
|
*/
|
2714
|
-
declare type ClientInfo = Omit<
|
2782
|
+
declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
2715
2783
|
/**
|
2716
2784
|
* Indicates if the client belongs to a Window, View or IFrame
|
2717
2785
|
*/
|
2718
|
-
entityType:
|
2786
|
+
entityType: EntityType_5;
|
2719
2787
|
/**
|
2720
2788
|
* URL of the Window, View or IFrame at the time of connection to the Channel Provider.
|
2721
2789
|
*/
|
@@ -2907,10 +2975,16 @@ declare type ClosedEvent = IdentityEvent & {
|
|
2907
2975
|
type: 'closed';
|
2908
2976
|
};
|
2909
2977
|
|
2978
|
+
/**
|
2979
|
+
* @interface
|
2980
|
+
*/
|
2910
2981
|
declare type ClosedMenuResult = {
|
2911
2982
|
result: 'closed';
|
2912
2983
|
};
|
2913
2984
|
|
2985
|
+
/**
|
2986
|
+
* @interface
|
2987
|
+
*/
|
2914
2988
|
declare type CloseViewPayload = {
|
2915
2989
|
/**
|
2916
2990
|
*View to be closed.
|
@@ -2919,6 +2993,8 @@ declare type CloseViewPayload = {
|
|
2919
2993
|
};
|
2920
2994
|
|
2921
2995
|
/**
|
2996
|
+
* @interface
|
2997
|
+
*
|
2922
2998
|
* Represents the shape of payload that contains the Window Identity and related options.
|
2923
2999
|
*/
|
2924
3000
|
declare interface CloseWindowPayload {
|
@@ -3049,14 +3125,14 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
|
|
3049
3125
|
|
3050
3126
|
declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
|
3051
3127
|
|
3052
|
-
declare type ConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
|
3053
|
-
|
3054
3128
|
declare type Constructor<T = {}> = new () => T;
|
3055
3129
|
|
3056
3130
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
3057
3131
|
|
3058
3132
|
/**
|
3059
3133
|
* View options that cannot be updated after creation.
|
3134
|
+
*
|
3135
|
+
* @interface
|
3060
3136
|
*/
|
3061
3137
|
declare type ConstViewOptions = {
|
3062
3138
|
/**
|
@@ -3124,6 +3200,8 @@ declare type ConstViewOptions = {
|
|
3124
3200
|
|
3125
3201
|
/**
|
3126
3202
|
* Window options that cannot be changed after creation.
|
3203
|
+
*
|
3204
|
+
* @interface
|
3127
3205
|
*/
|
3128
3206
|
declare type ConstWindowOptions = {
|
3129
3207
|
/**
|
@@ -3325,6 +3403,8 @@ declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'brows
|
|
3325
3403
|
|
3326
3404
|
/**
|
3327
3405
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
3406
|
+
*
|
3407
|
+
* @interface
|
3328
3408
|
*/
|
3329
3409
|
declare type ContentCreationOptions = {
|
3330
3410
|
/**
|
@@ -3340,6 +3420,8 @@ declare type ContentCreationOptions = {
|
|
3340
3420
|
* @property { string } behavior 'view' | 'window' | 'browser' | 'block'
|
3341
3421
|
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
3342
3422
|
* @property { object } options Window creation options or View creation options.
|
3423
|
+
*
|
3424
|
+
* @interface
|
3343
3425
|
*/
|
3344
3426
|
declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
3345
3427
|
/**
|
@@ -3392,6 +3474,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
3392
3474
|
* Restrict navigation to URLs that match an allowed pattern.
|
3393
3475
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
3394
3476
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
3477
|
+
*
|
3478
|
+
* @interface
|
3395
3479
|
*/
|
3396
3480
|
declare type ContentNavigation = NavigationRules;
|
3397
3481
|
|
@@ -3399,11 +3483,15 @@ declare type ContentNavigation = NavigationRules;
|
|
3399
3483
|
* Restrict redirects to URLs that match an allowed pattern.
|
3400
3484
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
3401
3485
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
3486
|
+
*
|
3487
|
+
* @interface
|
3402
3488
|
*/
|
3403
3489
|
declare type ContentRedirect = NavigationRules;
|
3404
3490
|
|
3405
3491
|
/**
|
3406
3492
|
* Data passed between entities and applications.
|
3493
|
+
*
|
3494
|
+
* @interface
|
3407
3495
|
*/
|
3408
3496
|
declare type Context = {
|
3409
3497
|
/**
|
@@ -3429,6 +3517,9 @@ declare type ContextForIntent<MetadataType = any> = Context & {
|
|
3429
3517
|
metadata?: MetadataType;
|
3430
3518
|
};
|
3431
3519
|
|
3520
|
+
/**
|
3521
|
+
* @interface
|
3522
|
+
*/
|
3432
3523
|
declare type ContextGroupInfo = {
|
3433
3524
|
/**
|
3434
3525
|
* Unique identifier of the context group.
|
@@ -3450,6 +3541,8 @@ declare type ContextHandler = (context: Context) => void;
|
|
3450
3541
|
|
3451
3542
|
/**
|
3452
3543
|
* Configure the context menu when right-clicking on a window.
|
3544
|
+
*
|
3545
|
+
* @interface
|
3453
3546
|
*/
|
3454
3547
|
declare type ContextMenuOptions = {
|
3455
3548
|
/**
|
@@ -3465,6 +3558,8 @@ declare type ContextMenuOptions = {
|
|
3465
3558
|
/**
|
3466
3559
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
3467
3560
|
* Configure the context menu when right-clicking on a window.
|
3561
|
+
*
|
3562
|
+
* @interface
|
3468
3563
|
*/
|
3469
3564
|
declare type ContextMenuSettings = {
|
3470
3565
|
/**
|
@@ -3481,12 +3576,18 @@ declare type ContextMenuSettings = {
|
|
3481
3576
|
reload?: boolean;
|
3482
3577
|
};
|
3483
3578
|
|
3579
|
+
/**
|
3580
|
+
* @interface
|
3581
|
+
*/
|
3484
3582
|
declare type CookieInfo = {
|
3485
3583
|
name: string;
|
3486
3584
|
domain: string;
|
3487
3585
|
path: string;
|
3488
3586
|
};
|
3489
3587
|
|
3588
|
+
/**
|
3589
|
+
* @interface
|
3590
|
+
*/
|
3490
3591
|
declare type CookieOption = {
|
3491
3592
|
name: string;
|
3492
3593
|
};
|
@@ -3494,6 +3595,8 @@ declare type CookieOption = {
|
|
3494
3595
|
/**
|
3495
3596
|
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
3496
3597
|
* average of _height_ and _width_.
|
3598
|
+
*
|
3599
|
+
* @interface
|
3497
3600
|
*/
|
3498
3601
|
declare type CornerRounding = {
|
3499
3602
|
/**
|
@@ -3510,6 +3613,9 @@ declare type CornerRounding = {
|
|
3510
3613
|
width: number;
|
3511
3614
|
};
|
3512
3615
|
|
3616
|
+
/**
|
3617
|
+
* @interface
|
3618
|
+
*/
|
3513
3619
|
declare type CpuInfo = {
|
3514
3620
|
/**
|
3515
3621
|
* The model of the cpu
|
@@ -3539,6 +3645,9 @@ declare type CrashedEvent = NamedEvent & {
|
|
3539
3645
|
};
|
3540
3646
|
};
|
3541
3647
|
|
3648
|
+
/**
|
3649
|
+
* @interface
|
3650
|
+
*/
|
3542
3651
|
declare type CrashReporterOptions = {
|
3543
3652
|
/**
|
3544
3653
|
* In diagnostics mode the crash reporter will send diagnostic logs to
|
@@ -3566,6 +3675,9 @@ declare type CreatedEvent = BaseViewEvent & {
|
|
3566
3675
|
type: 'created';
|
3567
3676
|
};
|
3568
3677
|
|
3678
|
+
/**
|
3679
|
+
* @interface
|
3680
|
+
*/
|
3569
3681
|
declare type CreateViewPayload = {
|
3570
3682
|
/**
|
3571
3683
|
* Options for the view to be added.
|
@@ -3594,6 +3706,8 @@ declare type CreateViewTarget = Identity_5 & {
|
|
3594
3706
|
|
3595
3707
|
/**
|
3596
3708
|
* Custom headers for requests sent by the window.
|
3709
|
+
*
|
3710
|
+
* @interface
|
3597
3711
|
*/
|
3598
3712
|
declare type CustomRequestHeaders = {
|
3599
3713
|
/**
|
@@ -3607,10 +3721,16 @@ declare type CustomRequestHeaders = {
|
|
3607
3721
|
headers: WebRequestHeader[];
|
3608
3722
|
};
|
3609
3723
|
|
3724
|
+
/**
|
3725
|
+
* @interface
|
3726
|
+
*/
|
3610
3727
|
declare type DefaultDomainSettings = {
|
3611
3728
|
rules: DefaultDomainSettingsRule[];
|
3612
3729
|
};
|
3613
3730
|
|
3731
|
+
/**
|
3732
|
+
* @interface
|
3733
|
+
*/
|
3614
3734
|
declare type DefaultDomainSettingsRule = {
|
3615
3735
|
match: string[];
|
3616
3736
|
options: {
|
@@ -3666,6 +3786,9 @@ declare type DipRect = RectangleByEdgePositions & {
|
|
3666
3786
|
scaledRect: RectangleByEdgePositions;
|
3667
3787
|
};
|
3668
3788
|
|
3789
|
+
/**
|
3790
|
+
* @interface
|
3791
|
+
*/
|
3669
3792
|
declare type DipScaleRects = {
|
3670
3793
|
dipRect: RectangleByEdgePositions;
|
3671
3794
|
scaledRect: RectangleByEdgePositions;
|
@@ -3687,12 +3810,10 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
3687
3810
|
type: 'disabled-movement-bounds-changing';
|
3688
3811
|
};
|
3689
3812
|
|
3690
|
-
declare type DisconnectionListener = (providerIdentity: OpenFin.ProviderIdentity) => any;
|
3691
|
-
|
3692
|
-
declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
|
3693
|
-
|
3694
3813
|
/**
|
3695
3814
|
* The display data for a context group.
|
3815
|
+
*
|
3816
|
+
* @interface
|
3696
3817
|
*/
|
3697
3818
|
declare type DisplayMetadata = {
|
3698
3819
|
/**
|
@@ -3711,6 +3832,8 @@ declare type DisplayMetadata = {
|
|
3711
3832
|
|
3712
3833
|
/**
|
3713
3834
|
* Metadata returned from a preload script download request.
|
3835
|
+
*
|
3836
|
+
* @interface
|
3714
3837
|
*/
|
3715
3838
|
declare type DownloadPreloadInfo = {
|
3716
3839
|
/**
|
@@ -3729,6 +3852,8 @@ declare type DownloadPreloadInfo = {
|
|
3729
3852
|
|
3730
3853
|
/**
|
3731
3854
|
* Options for downloading a preload script.
|
3855
|
+
*
|
3856
|
+
* @interface
|
3732
3857
|
*/
|
3733
3858
|
declare type DownloadPreloadOption = {
|
3734
3859
|
/**
|
@@ -3737,6 +3862,9 @@ declare type DownloadPreloadOption = {
|
|
3737
3862
|
url: string;
|
3738
3863
|
};
|
3739
3864
|
|
3865
|
+
/**
|
3866
|
+
* @interface
|
3867
|
+
*/
|
3740
3868
|
declare type DownloadRule = {
|
3741
3869
|
behavior: FileDownloadBehaviorNames;
|
3742
3870
|
match: string[];
|
@@ -3744,6 +3872,8 @@ declare type DownloadRule = {
|
|
3744
3872
|
|
3745
3873
|
/**
|
3746
3874
|
* DPI (dots per inch) configuration for printing.
|
3875
|
+
*
|
3876
|
+
* @interface
|
3747
3877
|
*/
|
3748
3878
|
declare type Dpi = {
|
3749
3879
|
/**
|
@@ -3806,53 +3936,35 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
3806
3936
|
protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
|
3807
3937
|
/**
|
3808
3938
|
* Adds a listener to the end of the listeners array for the specified event.
|
3809
|
-
*
|
3810
|
-
* @param eventType
|
3811
|
-
* @param listener
|
3812
|
-
* @param options
|
3813
3939
|
*/
|
3814
3940
|
on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3815
|
-
|
3941
|
+
/**
|
3942
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
3943
|
+
*/
|
3944
|
+
addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3816
3945
|
/**
|
3817
3946
|
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
3818
|
-
*
|
3819
|
-
* @param eventType
|
3820
|
-
* @param listener
|
3821
|
-
* @param options
|
3822
3947
|
*/
|
3823
3948
|
once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3824
3949
|
/**
|
3825
3950
|
* Adds a listener to the beginning of the listeners array for the specified event.
|
3826
|
-
*
|
3827
|
-
* @param eventType
|
3828
|
-
* @param listener
|
3829
|
-
* @param options
|
3830
3951
|
*/
|
3831
3952
|
prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3832
3953
|
/**
|
3833
3954
|
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
|
3834
3955
|
* after which it is removed. The listener is added to the beginning of the listeners array.
|
3835
|
-
*
|
3836
|
-
* @param eventType
|
3837
|
-
* @param listener
|
3838
|
-
* @param options
|
3839
3956
|
*/
|
3840
3957
|
prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3841
3958
|
/**
|
3842
3959
|
* Remove a listener from the listener array for the specified event.
|
3843
3960
|
*
|
3844
3961
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
3845
|
-
*
|
3846
|
-
* @param eventType
|
3847
|
-
* @param listener
|
3848
|
-
* @param options
|
3849
3962
|
*/
|
3850
3963
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3851
3964
|
protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
|
3852
3965
|
/**
|
3853
3966
|
* Removes all listeners, or those of the specified event.
|
3854
3967
|
*
|
3855
|
-
* @param eventType
|
3856
3968
|
*/
|
3857
3969
|
removeAllListeners(eventType?: EmitterEventType): Promise<this>;
|
3858
3970
|
private deleteEmitterIfNothingRegistered;
|
@@ -3895,10 +4007,13 @@ declare type Entity = OpenFin.ApplicationType;
|
|
3895
4007
|
|
3896
4008
|
declare type EntityInfo = OpenFin.EntityInfo;
|
3897
4009
|
|
4010
|
+
/**
|
4011
|
+
* @interface
|
4012
|
+
*/
|
3898
4013
|
declare type EntityInfo_2 = {
|
3899
4014
|
uuid: string;
|
3900
4015
|
name: string;
|
3901
|
-
entityType:
|
4016
|
+
entityType: EntityType_5;
|
3902
4017
|
};
|
3903
4018
|
|
3904
4019
|
/**
|
@@ -3912,15 +4027,15 @@ declare type EntityProcessDetails = FrameProcessDetails & {
|
|
3912
4027
|
|
3913
4028
|
declare type EntityType = OpenFin.EntityType;
|
3914
4029
|
|
3915
|
-
declare type EntityType_2 =
|
4030
|
+
declare type EntityType_2 = OpenFin.EntityType;
|
3916
4031
|
|
3917
4032
|
declare type EntityType_3 = OpenFin.EntityType;
|
3918
4033
|
|
3919
4034
|
declare type EntityType_4 = OpenFin.EntityType;
|
3920
4035
|
|
3921
|
-
declare type EntityType_5 =
|
4036
|
+
declare type EntityType_5 = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
|
3922
4037
|
|
3923
|
-
declare type EntityTypeHelpers<T extends
|
4038
|
+
declare type EntityTypeHelpers<T extends EntityType_3> = T extends 'view' ? {
|
3924
4039
|
isView: true;
|
3925
4040
|
isWindow: false;
|
3926
4041
|
isExternal: false;
|
@@ -3958,7 +4073,7 @@ declare interface Environment {
|
|
3958
4073
|
createChildContent(options: ChildContentOptions): Promise<any>;
|
3959
4074
|
getWebWindow(identity: OpenFin.Identity): globalThis.Window;
|
3960
4075
|
getCurrentEntityIdentity(): OpenFin.EntityInfo;
|
3961
|
-
getCurrentEntityType():
|
4076
|
+
getCurrentEntityType(): EntityType_4;
|
3962
4077
|
raiseEvent(eventName: string, eventArgs: any): void;
|
3963
4078
|
childViews: boolean;
|
3964
4079
|
getUrl(): string;
|
@@ -3973,7 +4088,7 @@ declare interface Environment {
|
|
3973
4088
|
|
3974
4089
|
declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
|
3975
4090
|
|
3976
|
-
declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 |
|
4091
|
+
declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
|
3977
4092
|
|
3978
4093
|
/**
|
3979
4094
|
* This function converts JS errors into plain objects
|
@@ -4022,6 +4137,9 @@ declare type ExistingConnectConfig = ConfigWithUuid & {
|
|
4022
4137
|
address: string;
|
4023
4138
|
};
|
4024
4139
|
|
4140
|
+
/**
|
4141
|
+
* @interface
|
4142
|
+
*/
|
4025
4143
|
declare type ExitCode = {
|
4026
4144
|
topic: string;
|
4027
4145
|
uuid: string;
|
@@ -4171,6 +4289,9 @@ declare namespace ExternalApplicationEvents {
|
|
4171
4289
|
}
|
4172
4290
|
}
|
4173
4291
|
|
4292
|
+
/**
|
4293
|
+
* @interface
|
4294
|
+
*/
|
4174
4295
|
declare type ExternalApplicationInfo = {
|
4175
4296
|
parent: Identity_5;
|
4176
4297
|
};
|
@@ -4213,6 +4334,9 @@ declare type ExternalConfig = BaseConfig & {
|
|
4213
4334
|
manifestUrl: string;
|
4214
4335
|
};
|
4215
4336
|
|
4337
|
+
/**
|
4338
|
+
* @interface
|
4339
|
+
*/
|
4216
4340
|
declare type ExternalConnection = {
|
4217
4341
|
/**
|
4218
4342
|
* The token to broker an external connection.
|
@@ -4234,11 +4358,17 @@ declare type ExternalProcessExitedEvent = NamedEvent & {
|
|
4234
4358
|
exitCode: number;
|
4235
4359
|
};
|
4236
4360
|
|
4361
|
+
/**
|
4362
|
+
* @interface
|
4363
|
+
*/
|
4237
4364
|
declare type ExternalProcessInfo = {
|
4238
4365
|
pid: number;
|
4239
4366
|
listener?: LaunchExternalProcessListener;
|
4240
4367
|
};
|
4241
4368
|
|
4369
|
+
/**
|
4370
|
+
* @interface
|
4371
|
+
*/
|
4242
4372
|
declare type ExternalProcessRequestType = {
|
4243
4373
|
/**
|
4244
4374
|
* The file path to where the running application resides.
|
@@ -4281,6 +4411,9 @@ declare type FaviconUpdatedEvent = NamedEvent & {
|
|
4281
4411
|
favicons: string[];
|
4282
4412
|
};
|
4283
4413
|
|
4414
|
+
/**
|
4415
|
+
* @interface
|
4416
|
+
*/
|
4284
4417
|
declare type FetchManifestPayload = {
|
4285
4418
|
/**
|
4286
4419
|
* The URL of the manifest to fetch.
|
@@ -4369,6 +4502,9 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
4369
4502
|
state: 'progressing' | 'interrupted';
|
4370
4503
|
};
|
4371
4504
|
|
4505
|
+
/**
|
4506
|
+
* @interface
|
4507
|
+
*/
|
4372
4508
|
declare type FileDownloadSettings = {
|
4373
4509
|
rules: DownloadRule[];
|
4374
4510
|
};
|
@@ -4382,6 +4518,9 @@ declare type FileDownloadStartedEvent = FileDownloadEvent & {
|
|
4382
4518
|
state: 'started';
|
4383
4519
|
};
|
4384
4520
|
|
4521
|
+
/**
|
4522
|
+
* @internal
|
4523
|
+
*/
|
4385
4524
|
declare class Fin<MeType extends EntityType = EntityType> extends EventEmitter implements FinApi<MeType> {
|
4386
4525
|
private wire;
|
4387
4526
|
System: System;
|
@@ -4403,8 +4542,11 @@ declare class Fin<MeType extends EntityType = EntityType> extends EventEmitter i
|
|
4403
4542
|
constructor(wire: Transport<MeType>);
|
4404
4543
|
}
|
4405
4544
|
|
4406
|
-
declare type Fin_2<MeType extends
|
4545
|
+
declare type Fin_2<MeType extends EntityType_5 = 'window' | 'view'> = FinApi<MeType>;
|
4407
4546
|
|
4547
|
+
/**
|
4548
|
+
* Type of the global `fin` entry point for the OpenFin API.
|
4549
|
+
*/
|
4408
4550
|
declare interface FinApi<MeType extends EntityType> {
|
4409
4551
|
readonly System: System;
|
4410
4552
|
readonly Window: _WindowModule;
|
@@ -4423,6 +4565,8 @@ declare interface FinApi<MeType extends EntityType> {
|
|
4423
4565
|
|
4424
4566
|
/**
|
4425
4567
|
* Configuration for find-in-page requests.
|
4568
|
+
*
|
4569
|
+
* @interface
|
4426
4570
|
*/
|
4427
4571
|
declare type FindInPageOptions = {
|
4428
4572
|
/**
|
@@ -4458,6 +4602,9 @@ declare type FindInPageOptions = {
|
|
4458
4602
|
medialCapitalAsWordStart?: boolean;
|
4459
4603
|
};
|
4460
4604
|
|
4605
|
+
/**
|
4606
|
+
* @interface
|
4607
|
+
*/
|
4461
4608
|
declare type FindInPageResult = {
|
4462
4609
|
requestId: number;
|
4463
4610
|
/**
|
@@ -4475,6 +4622,9 @@ declare type FindInPageResult = {
|
|
4475
4622
|
finalUpdate: boolean;
|
4476
4623
|
};
|
4477
4624
|
|
4625
|
+
/**
|
4626
|
+
* @interface
|
4627
|
+
*/
|
4478
4628
|
declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
4479
4629
|
context: Context;
|
4480
4630
|
metadata?: MetadataType;
|
@@ -4672,11 +4822,14 @@ declare namespace FrameEvents {
|
|
4672
4822
|
*/
|
4673
4823
|
declare type FrameEventType = FrameEvent['type'];
|
4674
4824
|
|
4825
|
+
/**
|
4826
|
+
* @interface
|
4827
|
+
*/
|
4675
4828
|
declare type FrameInfo = {
|
4676
4829
|
name: string;
|
4677
4830
|
uuid: string;
|
4678
4831
|
url: string;
|
4679
|
-
entityType:
|
4832
|
+
entityType: EntityType_5;
|
4680
4833
|
parent: Identity_5;
|
4681
4834
|
};
|
4682
4835
|
|
@@ -4748,6 +4901,9 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
4748
4901
|
|
4749
4902
|
declare type GetLogRequestType = OpenFin.GetLogRequestType;
|
4750
4903
|
|
4904
|
+
/**
|
4905
|
+
* @interface
|
4906
|
+
*/
|
4751
4907
|
declare type GetLogRequestType_2 = {
|
4752
4908
|
/**
|
4753
4909
|
* The name of the running application
|
@@ -4765,11 +4921,14 @@ declare type GetLogRequestType_2 = {
|
|
4765
4921
|
|
4766
4922
|
declare type GetterCall<T> = ApiCall<void, T>;
|
4767
4923
|
|
4924
|
+
/**
|
4925
|
+
* @interface
|
4926
|
+
*/
|
4768
4927
|
declare type GetWindowContextPayload = {
|
4769
4928
|
/**
|
4770
4929
|
* Entity type of the target of the context update ('view' or 'window').
|
4771
4930
|
*/
|
4772
|
-
entityType:
|
4931
|
+
entityType: EntityType_5;
|
4773
4932
|
/**
|
4774
4933
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
4775
4934
|
*/
|
@@ -4900,6 +5059,9 @@ declare namespace GlobalHotkeyEvents {
|
|
4900
5059
|
}
|
4901
5060
|
}
|
4902
5061
|
|
5062
|
+
/**
|
5063
|
+
* @interface
|
5064
|
+
*/
|
4903
5065
|
declare type GpuInfo = {
|
4904
5066
|
name: string;
|
4905
5067
|
};
|
@@ -4912,6 +5074,9 @@ declare type HiddenEvent = BaseViewEvent & {
|
|
4912
5074
|
type: 'hidden';
|
4913
5075
|
};
|
4914
5076
|
|
5077
|
+
/**
|
5078
|
+
* @interface
|
5079
|
+
*/
|
4915
5080
|
declare type HostContextChangedPayload = {
|
4916
5081
|
/**
|
4917
5082
|
* The new context object
|
@@ -4925,6 +5090,9 @@ declare type HostContextChangedPayload = {
|
|
4925
5090
|
|
4926
5091
|
declare type HostContextChangedReasons = 'updated' | 'reparented';
|
4927
5092
|
|
5093
|
+
/**
|
5094
|
+
* @interface
|
5095
|
+
*/
|
4928
5096
|
declare type HostSpecs = {
|
4929
5097
|
/**
|
4930
5098
|
* True if Aero Glass theme is supported on Windows platforms
|
@@ -4958,6 +5126,8 @@ declare type HostSpecs = {
|
|
4958
5126
|
|
4959
5127
|
/**
|
4960
5128
|
* A hotkey binding.
|
5129
|
+
*
|
5130
|
+
* @interface
|
4961
5131
|
*/
|
4962
5132
|
declare type Hotkey = {
|
4963
5133
|
/**
|
@@ -4994,6 +5164,8 @@ declare type Identity_4 = OpenFin.Identity;
|
|
4994
5164
|
*
|
4995
5165
|
* @remarks The `uuid` property refers the application that owns the entity, not to the entity itself.
|
4996
5166
|
* The `name` property identifies the entity itself, and must be unique within the application.
|
5167
|
+
*
|
5168
|
+
* @interface
|
4997
5169
|
*/
|
4998
5170
|
declare type Identity_5 = {
|
4999
5171
|
/**
|
@@ -5044,6 +5216,9 @@ declare type ImageFormatOptions = {
|
|
5044
5216
|
quality?: number;
|
5045
5217
|
};
|
5046
5218
|
|
5219
|
+
/**
|
5220
|
+
* @interface
|
5221
|
+
*/
|
5047
5222
|
declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
5048
5223
|
/**
|
5049
5224
|
* Name of the intent to get info for.
|
@@ -5065,6 +5240,9 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
|
|
5065
5240
|
|
5066
5241
|
declare type InitLayoutOptions_2 = OpenFin.InitLayoutOptions;
|
5067
5242
|
|
5243
|
+
/**
|
5244
|
+
* @interface
|
5245
|
+
*/
|
5068
5246
|
declare type InitLayoutOptions_3 = {
|
5069
5247
|
/**
|
5070
5248
|
* The id attribute of the container where the window's Layout should be initialized. If not provided
|
@@ -5073,6 +5251,9 @@ declare type InitLayoutOptions_3 = {
|
|
5073
5251
|
containerId?: string;
|
5074
5252
|
};
|
5075
5253
|
|
5254
|
+
/**
|
5255
|
+
* @interface
|
5256
|
+
*/
|
5076
5257
|
declare type InitPlatformOptions = {
|
5077
5258
|
/**
|
5078
5259
|
* A callback function or an array of constructor callbacks that can be used to extend or replace default Provider behavior.
|
@@ -5100,12 +5281,18 @@ declare type InputEvent_2 = {
|
|
5100
5281
|
command?: string;
|
5101
5282
|
};
|
5102
5283
|
|
5284
|
+
/**
|
5285
|
+
* @interface
|
5286
|
+
*/
|
5103
5287
|
declare type InstallationInfo = {
|
5104
5288
|
cachedManifest: any;
|
5105
5289
|
};
|
5106
5290
|
|
5107
5291
|
declare type InstalledApps = OpenFin.InstalledApps;
|
5108
5292
|
|
5293
|
+
/**
|
5294
|
+
* @interface
|
5295
|
+
*/
|
5109
5296
|
declare type InstalledApps_2 = {
|
5110
5297
|
[key: string]: InstallationInfo;
|
5111
5298
|
};
|
@@ -5127,6 +5314,9 @@ declare type Intent<MetadataType = IntentMetadata> = {
|
|
5127
5314
|
|
5128
5315
|
declare type IntentHandler = (intent: Intent) => void;
|
5129
5316
|
|
5317
|
+
/**
|
5318
|
+
* @interface
|
5319
|
+
*/
|
5130
5320
|
declare type IntentMetadata<TargetType = any> = {
|
5131
5321
|
target?: TargetType;
|
5132
5322
|
resultType?: string;
|
@@ -5254,10 +5444,11 @@ declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
|
|
5254
5444
|
|
5255
5445
|
/**
|
5256
5446
|
* Define whether to enable interop action logging.
|
5447
|
+
*
|
5257
5448
|
*/
|
5258
|
-
declare
|
5449
|
+
declare type InteropActionLoggingOption = {
|
5259
5450
|
enabled: boolean;
|
5260
|
-
}
|
5451
|
+
};
|
5261
5452
|
|
5262
5453
|
/**
|
5263
5454
|
* {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
|
@@ -5926,12 +6117,18 @@ declare class InteropBroker extends Base {
|
|
5926
6117
|
isActionAuthorized(_action: string, _payload: any, _identity: OpenFin.ClientIdentity): Promise<boolean> | boolean;
|
5927
6118
|
}
|
5928
6119
|
|
6120
|
+
/**
|
6121
|
+
* @interface
|
6122
|
+
*/
|
5929
6123
|
declare type InteropBrokerDisconnectionEvent = {
|
5930
6124
|
type: string;
|
5931
6125
|
topic: string;
|
5932
6126
|
brokerName: string;
|
5933
6127
|
};
|
5934
6128
|
|
6129
|
+
/**
|
6130
|
+
* @interface
|
6131
|
+
*/
|
5935
6132
|
declare type InteropBrokerOptions = {
|
5936
6133
|
contextGroups?: ContextGroupInfo;
|
5937
6134
|
logging?: InteropLoggingOptions;
|
@@ -6437,8 +6634,14 @@ declare class InteropClient extends Base {
|
|
6437
6634
|
static ferryFdc3Call(interopClient: OpenFin.InteropClient, action: string, payload?: any): Promise<any>;
|
6438
6635
|
}
|
6439
6636
|
|
6637
|
+
/**
|
6638
|
+
* @interface
|
6639
|
+
*/
|
6440
6640
|
declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
|
6441
6641
|
|
6642
|
+
/**
|
6643
|
+
* @interface
|
6644
|
+
*/
|
6442
6645
|
declare type InteropConfig = {
|
6443
6646
|
/**
|
6444
6647
|
* Context Group for the client. (green, yellow, red, etc.).
|
@@ -6452,6 +6655,9 @@ declare type InteropConfig = {
|
|
6452
6655
|
|
6453
6656
|
declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
6454
6657
|
|
6658
|
+
/**
|
6659
|
+
* @interface
|
6660
|
+
*/
|
6455
6661
|
declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
6456
6662
|
|
6457
6663
|
/**
|
@@ -6506,6 +6712,9 @@ declare class InteropModule extends Base {
|
|
6506
6712
|
connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
|
6507
6713
|
}
|
6508
6714
|
|
6715
|
+
/**
|
6716
|
+
* @interface
|
6717
|
+
*/
|
6509
6718
|
declare type JumpListCategory = {
|
6510
6719
|
/**
|
6511
6720
|
* The display title for the category.
|
@@ -6522,10 +6731,16 @@ declare type JumpListCategory = {
|
|
6522
6731
|
|
6523
6732
|
declare type JumpListItem = JumpListTask | JumpListSeparator;
|
6524
6733
|
|
6734
|
+
/**
|
6735
|
+
* @interface
|
6736
|
+
*/
|
6525
6737
|
declare type JumpListSeparator = {
|
6526
6738
|
type: 'separator';
|
6527
6739
|
};
|
6528
6740
|
|
6741
|
+
/**
|
6742
|
+
* @interface
|
6743
|
+
*/
|
6529
6744
|
declare type JumpListTask = {
|
6530
6745
|
type: 'task';
|
6531
6746
|
/**
|
@@ -6619,15 +6834,19 @@ export declare function launch(config: ConnectConfig): Promise<number>;
|
|
6619
6834
|
*/
|
6620
6835
|
declare type LaunchEmitter = TypedEventEmitter<AppVersionEvent>;
|
6621
6836
|
|
6622
|
-
declare type LaunchExternalProcessListener =
|
6623
|
-
(code: ExitCode): void;
|
6624
|
-
};
|
6837
|
+
declare type LaunchExternalProcessListener = (code: ExitCode) => void;
|
6625
6838
|
|
6839
|
+
/**
|
6840
|
+
* @interface
|
6841
|
+
*/
|
6626
6842
|
declare type LaunchExternalProcessRule = {
|
6627
6843
|
behavior: 'allow' | 'block';
|
6628
6844
|
match: string[];
|
6629
6845
|
};
|
6630
6846
|
|
6847
|
+
/**
|
6848
|
+
* @interface
|
6849
|
+
*/
|
6631
6850
|
declare type LaunchIntoPlatformPayload = {
|
6632
6851
|
manifest: any;
|
6633
6852
|
};
|
@@ -6916,14 +7135,20 @@ declare class Layout extends Base {
|
|
6916
7135
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
6917
7136
|
}
|
6918
7137
|
|
6919
|
-
|
7138
|
+
/**
|
7139
|
+
* @interface
|
7140
|
+
*/
|
7141
|
+
declare type LayoutColumn = LayoutItemConfig & {
|
6920
7142
|
type: 'column';
|
6921
|
-
}
|
7143
|
+
};
|
6922
7144
|
|
6923
|
-
|
7145
|
+
/**
|
7146
|
+
* @interface
|
7147
|
+
*/
|
7148
|
+
declare type LayoutComponent = LayoutItemConfig & {
|
6924
7149
|
componentName: 'view';
|
6925
7150
|
componentState?: Partial<ViewCreationOptions>;
|
6926
|
-
}
|
7151
|
+
};
|
6927
7152
|
|
6928
7153
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
6929
7154
|
|
@@ -7055,6 +7280,9 @@ declare class LayoutEntitiesController {
|
|
7055
7280
|
setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
|
7056
7281
|
}
|
7057
7282
|
|
7283
|
+
/**
|
7284
|
+
* @interface
|
7285
|
+
*/
|
7058
7286
|
declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes = LayoutEntityTypes> = {
|
7059
7287
|
type: TLayoutEntityType;
|
7060
7288
|
entityId: string;
|
@@ -7077,6 +7305,8 @@ declare type LayoutInitializedEvent = NamedEvent & {
|
|
7077
7305
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
7078
7306
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
|
7079
7307
|
* {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
|
7308
|
+
*
|
7309
|
+
* @interface
|
7080
7310
|
*/
|
7081
7311
|
declare type LayoutItemConfig = {
|
7082
7312
|
/**
|
@@ -7458,6 +7688,9 @@ declare abstract class LayoutNode {
|
|
7458
7688
|
getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
|
7459
7689
|
}
|
7460
7690
|
|
7691
|
+
/**
|
7692
|
+
* @interface
|
7693
|
+
*/
|
7461
7694
|
declare type LayoutOptions = {
|
7462
7695
|
/**
|
7463
7696
|
* Represents a potential ways to customize behavior of your Layout
|
@@ -7538,6 +7771,9 @@ declare type LayoutOptions = {
|
|
7538
7771
|
|
7539
7772
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
7540
7773
|
|
7774
|
+
/**
|
7775
|
+
* @interface
|
7776
|
+
*/
|
7541
7777
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
7542
7778
|
|
7543
7779
|
/**
|
@@ -7551,10 +7787,16 @@ declare type LayoutReadyEvent = NamedEvent & {
|
|
7551
7787
|
})[];
|
7552
7788
|
};
|
7553
7789
|
|
7554
|
-
|
7790
|
+
/**
|
7791
|
+
* @interface
|
7792
|
+
*/
|
7793
|
+
declare type LayoutRow = LayoutItemConfig & {
|
7555
7794
|
type: 'row';
|
7556
|
-
}
|
7795
|
+
};
|
7557
7796
|
|
7797
|
+
/**
|
7798
|
+
* @interface
|
7799
|
+
*/
|
7558
7800
|
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
|
7559
7801
|
|
7560
7802
|
declare type Listener<T extends {
|
@@ -7563,6 +7805,9 @@ declare type Listener<T extends {
|
|
7563
7805
|
|
7564
7806
|
declare type LogInfo = OpenFin.LogInfo;
|
7565
7807
|
|
7808
|
+
/**
|
7809
|
+
* @interface
|
7810
|
+
*/
|
7566
7811
|
declare type LogInfo_2 = {
|
7567
7812
|
/**
|
7568
7813
|
* The filename of the log
|
@@ -7591,6 +7836,9 @@ declare type LogLevel = OpenFin.LogLevel;
|
|
7591
7836
|
*/
|
7592
7837
|
declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
7593
7838
|
|
7839
|
+
/**
|
7840
|
+
* @interface
|
7841
|
+
*/
|
7594
7842
|
declare type Manifest = {
|
7595
7843
|
appAssets?: {
|
7596
7844
|
alias: string;
|
@@ -7656,6 +7904,9 @@ declare type ManifestChangedEvent = IdentityEvent & {
|
|
7656
7904
|
type: 'manifest-changed';
|
7657
7905
|
};
|
7658
7906
|
|
7907
|
+
/**
|
7908
|
+
* @interface
|
7909
|
+
*/
|
7659
7910
|
declare type ManifestInfo = {
|
7660
7911
|
/**
|
7661
7912
|
* The uuid of the application.
|
@@ -7669,6 +7920,8 @@ declare type ManifestInfo = {
|
|
7669
7920
|
|
7670
7921
|
/**
|
7671
7922
|
* Margins configuration for printing.
|
7923
|
+
*
|
7924
|
+
* @interface
|
7672
7925
|
*/
|
7673
7926
|
declare type Margins = {
|
7674
7927
|
marginType?: 'default' | 'none' | 'printableArea' | 'custom';
|
@@ -7700,10 +7953,13 @@ declare type MaximizedEvent = NamedEvent & {
|
|
7700
7953
|
type: 'maximized';
|
7701
7954
|
};
|
7702
7955
|
|
7703
|
-
declare type Me<MeType extends
|
7956
|
+
declare type Me<MeType extends EntityType_3> = OpenFin.EntityInfo & (MeType extends 'view' ? EntityTypeHelpers<'view'> & OpenFin.View & WithInterop : MeType extends 'window' ? EntityTypeHelpers<'window'> & OpenFin.Window & WithInterop : MeType extends 'iframe' ? EntityTypeHelpers<'iframe'> & OpenFin.Frame & WithInterop : MeType extends 'external connection' ? EntityTypeHelpers<'external connection'> & OpenFin.ExternalApplication & WithInterop : EntityTypeHelpers<MeType> & WithInterop) & {
|
7704
7957
|
isOpenFin: boolean;
|
7705
7958
|
};
|
7706
7959
|
|
7960
|
+
/**
|
7961
|
+
* @interface
|
7962
|
+
*/
|
7707
7963
|
declare type MenuItemTemplate<T extends unknown = unknown> = {
|
7708
7964
|
/**
|
7709
7965
|
* Can be `normal`, `separator`, `submenu`, or `checkbox`.
|
@@ -7773,6 +8029,9 @@ declare type MinimizedEvent = NamedEvent & {
|
|
7773
8029
|
type: 'minimized';
|
7774
8030
|
};
|
7775
8031
|
|
8032
|
+
/**
|
8033
|
+
* @interface
|
8034
|
+
*/
|
7776
8035
|
declare type MonitorDetails = {
|
7777
8036
|
/**
|
7778
8037
|
* The available DIP scale coordinates.
|
@@ -7819,6 +8078,9 @@ declare type MonitorEvent = OpenFin.MonitorInfo & {
|
|
7819
8078
|
type: 'monitor-info-changed';
|
7820
8079
|
};
|
7821
8080
|
|
8081
|
+
/**
|
8082
|
+
* @interface
|
8083
|
+
*/
|
7822
8084
|
declare type MonitorInfo = {
|
7823
8085
|
/**
|
7824
8086
|
* The device scale factor.
|
@@ -7838,6 +8100,9 @@ declare type MonitorInfo = {
|
|
7838
8100
|
virtualScreen: DipRect;
|
7839
8101
|
};
|
7840
8102
|
|
8103
|
+
/**
|
8104
|
+
* @interface
|
8105
|
+
*/
|
7841
8106
|
declare type MutableViewOptions = {
|
7842
8107
|
autoResize: AutoResizeOptions;
|
7843
8108
|
/**
|
@@ -7923,6 +8188,8 @@ declare type MutableViewOptions = {
|
|
7923
8188
|
|
7924
8189
|
/**
|
7925
8190
|
* Window options that can be changed after window creation.
|
8191
|
+
*
|
8192
|
+
* @interface
|
7926
8193
|
*/
|
7927
8194
|
declare type MutableWindowOptions = {
|
7928
8195
|
/**
|
@@ -8175,6 +8442,9 @@ declare type NamedEvent = IdentityEvent & {
|
|
8175
8442
|
name: string;
|
8176
8443
|
};
|
8177
8444
|
|
8445
|
+
/**
|
8446
|
+
* @interface
|
8447
|
+
*/
|
8178
8448
|
declare type NativeWindowIntegrationProviderAuthorization = {
|
8179
8449
|
authorizedUuid: string;
|
8180
8450
|
};
|
@@ -8189,6 +8459,9 @@ declare type NavigationRejectedEvent = NamedEvent & {
|
|
8189
8459
|
url: string;
|
8190
8460
|
};
|
8191
8461
|
|
8462
|
+
/**
|
8463
|
+
* @interface
|
8464
|
+
*/
|
8192
8465
|
declare type NavigationRules = {
|
8193
8466
|
/** @deprecated Use allowlist property instead. */
|
8194
8467
|
whitelist?: string[];
|
@@ -8251,21 +8524,32 @@ declare type Opacity = TransitionBase & {
|
|
8251
8524
|
|
8252
8525
|
declare namespace OpenFin {
|
8253
8526
|
export {
|
8527
|
+
FinApi,
|
8254
8528
|
Fin_2 as Fin,
|
8255
8529
|
Application,
|
8530
|
+
ApplicationModule,
|
8256
8531
|
ExternalApplication,
|
8532
|
+
ExternalApplicationModule,
|
8257
8533
|
_Frame as Frame,
|
8534
|
+
_FrameModule,
|
8535
|
+
Channel,
|
8258
8536
|
ChannelClient,
|
8259
8537
|
ChannelProvider,
|
8260
8538
|
Platform,
|
8539
|
+
PlatformModule,
|
8261
8540
|
Layout,
|
8541
|
+
LayoutModule,
|
8262
8542
|
View_2 as View,
|
8543
|
+
ViewModule,
|
8263
8544
|
ColumnOrRow,
|
8264
8545
|
TabStack,
|
8265
8546
|
_Window as Window,
|
8547
|
+
_WindowModule,
|
8266
8548
|
InteropClient,
|
8267
8549
|
InteropBroker,
|
8550
|
+
InteropModule,
|
8268
8551
|
SnapshotSource,
|
8552
|
+
SnapshotSourceModule,
|
8269
8553
|
LayoutEntityDefinition,
|
8270
8554
|
LayoutEntityTypes,
|
8271
8555
|
LayoutPosition,
|
@@ -8273,12 +8557,12 @@ declare namespace OpenFin {
|
|
8273
8557
|
PlatformProvider,
|
8274
8558
|
ApplicationIdentity_2 as ApplicationIdentity,
|
8275
8559
|
Identity_5 as Identity,
|
8276
|
-
|
8560
|
+
ClientIdentity,
|
8277
8561
|
ClientInfo,
|
8278
8562
|
ClientIdentityMultiRuntime,
|
8279
8563
|
ClientConnectionPayload,
|
8280
8564
|
EntityInfo_2 as EntityInfo,
|
8281
|
-
|
8565
|
+
EntityType_5 as EntityType,
|
8282
8566
|
Bounds,
|
8283
8567
|
WindowBounds,
|
8284
8568
|
Rectangle,
|
@@ -8518,7 +8802,6 @@ declare namespace OpenFin {
|
|
8518
8802
|
AppVersionCompleteEvent,
|
8519
8803
|
AppVersionRuntimeStatusEvent,
|
8520
8804
|
BaseEvents,
|
8521
|
-
ChannelEvents,
|
8522
8805
|
WebContentsEvents,
|
8523
8806
|
SystemEvents,
|
8524
8807
|
ApplicationEvents,
|
@@ -8529,7 +8812,6 @@ declare namespace OpenFin {
|
|
8529
8812
|
PlatformEvents,
|
8530
8813
|
ExternalApplicationEvents,
|
8531
8814
|
BaseEvent_2 as BaseEvent,
|
8532
|
-
ChannelEvent_2 as ChannelEvent,
|
8533
8815
|
WebContentsEvent_2 as WebContentsEvent,
|
8534
8816
|
SystemEvent_2 as SystemEvent,
|
8535
8817
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -8549,7 +8831,11 @@ declare namespace OpenFin {
|
|
8549
8831
|
Me,
|
8550
8832
|
CapturePageOptions,
|
8551
8833
|
ProcessLoggingOptions,
|
8552
|
-
PositioningOptions
|
8834
|
+
PositioningOptions,
|
8835
|
+
ChannelClientConnectionListener,
|
8836
|
+
ChannelClientDisconnectionListener,
|
8837
|
+
ChannelProviderDisconnectionListener,
|
8838
|
+
RoutingInfo
|
8553
8839
|
}
|
8554
8840
|
}
|
8555
8841
|
export default OpenFin;
|
@@ -8589,6 +8875,9 @@ declare type PerformanceReportEvent = Performance & NamedEvent & {
|
|
8589
8875
|
type: 'performance-report';
|
8590
8876
|
};
|
8591
8877
|
|
8878
|
+
/**
|
8879
|
+
* @interface
|
8880
|
+
*/
|
8592
8881
|
declare type Permissions_2 = {
|
8593
8882
|
Application?: Partial<ApplicationPermissions>;
|
8594
8883
|
System?: Partial<SystemPermissions>;
|
@@ -9989,6 +10278,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
|
|
9989
10278
|
type: 'platform-snapshot-applied';
|
9990
10279
|
};
|
9991
10280
|
|
10281
|
+
/**
|
10282
|
+
* @interface
|
10283
|
+
*/
|
9992
10284
|
declare type PlatformViewCreationOptions = Partial<ViewOptions>;
|
9993
10285
|
|
9994
10286
|
/**
|
@@ -10015,6 +10307,9 @@ declare type PlatformWindowOptions = WindowCreationOptions & {
|
|
10015
10307
|
stylesheetUrl: string;
|
10016
10308
|
};
|
10017
10309
|
|
10310
|
+
/**
|
10311
|
+
* @interface
|
10312
|
+
*/
|
10018
10313
|
declare type Point = {
|
10019
10314
|
/**
|
10020
10315
|
* The mouse x position
|
@@ -10026,6 +10321,9 @@ declare type Point = {
|
|
10026
10321
|
y: number;
|
10027
10322
|
};
|
10028
10323
|
|
10324
|
+
/**
|
10325
|
+
* @interface
|
10326
|
+
*/
|
10029
10327
|
declare type PointTopLeft = {
|
10030
10328
|
/**
|
10031
10329
|
* The mouse top position in virtual screen coordinates
|
@@ -10045,8 +10343,10 @@ declare type PopupInteraction = 'clicked' | 'dismissed';
|
|
10045
10343
|
|
10046
10344
|
/**
|
10047
10345
|
* Popup window options.
|
10346
|
+
*
|
10347
|
+
* @interface
|
10048
10348
|
*/
|
10049
|
-
declare
|
10349
|
+
declare type PopupOptions = {
|
10050
10350
|
/**
|
10051
10351
|
* Window creation options when using `showPopupWindow` to create a new window.
|
10052
10352
|
*/
|
@@ -10120,14 +10420,15 @@ declare interface PopupOptions {
|
|
10120
10420
|
* <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
|
10121
10421
|
*/
|
10122
10422
|
onPopupResult?: (payload: PopupResult) => any;
|
10123
|
-
}
|
10423
|
+
};
|
10124
10424
|
|
10125
10425
|
/**
|
10126
10426
|
* The Popup result.
|
10127
10427
|
*
|
10128
10428
|
* @typeParam T - Type of data the Popup result contains
|
10429
|
+
* @interface
|
10129
10430
|
*/
|
10130
|
-
declare
|
10431
|
+
declare type PopupResult<T = any> = {
|
10131
10432
|
/**
|
10132
10433
|
* `name` and `uuid` of the popup window that called dispatched this result.
|
10133
10434
|
*/
|
@@ -10147,7 +10448,7 @@ declare interface PopupResult<T = any> {
|
|
10147
10448
|
* The last dispatch result.
|
10148
10449
|
*/
|
10149
10450
|
lastDispatchResult?: PopupResult;
|
10150
|
-
}
|
10451
|
+
};
|
10151
10452
|
|
10152
10453
|
declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
|
10153
10454
|
|
@@ -10176,14 +10477,17 @@ declare type Position = TransitionBase & {
|
|
10176
10477
|
fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
|
10177
10478
|
```
|
10178
10479
|
*/
|
10179
|
-
|
10480
|
+
/**
|
10481
|
+
* @interface
|
10482
|
+
*/
|
10483
|
+
declare type PositioningOptions = {
|
10180
10484
|
/**
|
10181
10485
|
* Windows Only.
|
10182
10486
|
* If set to true, will not restore a maximized window before setting the bounds.
|
10183
10487
|
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
10184
10488
|
*/
|
10185
10489
|
skipRestore?: boolean;
|
10186
|
-
}
|
10490
|
+
};
|
10187
10491
|
|
10188
10492
|
/**
|
10189
10493
|
* Context menu item with an implementation provided by OpenFin.
|
@@ -10192,6 +10496,8 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
10192
10496
|
|
10193
10497
|
/**
|
10194
10498
|
* A script that is run before page load.
|
10499
|
+
*
|
10500
|
+
* @interface
|
10195
10501
|
*/
|
10196
10502
|
declare type PreloadScript = {
|
10197
10503
|
/**
|
@@ -10252,6 +10558,9 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
|
|
10252
10558
|
|
10253
10559
|
declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
10254
10560
|
|
10561
|
+
/**
|
10562
|
+
* @interface
|
10563
|
+
*/
|
10255
10564
|
declare type PresetLayoutOptions_2 = {
|
10256
10565
|
/**
|
10257
10566
|
* Which preset layout arrangement to use.
|
@@ -10262,6 +10571,9 @@ declare type PresetLayoutOptions_2 = {
|
|
10262
10571
|
|
10263
10572
|
declare type PrinterInfo = OpenFin.PrinterInfo;
|
10264
10573
|
|
10574
|
+
/**
|
10575
|
+
* @interface
|
10576
|
+
*/
|
10265
10577
|
declare type PrinterInfo_2 = {
|
10266
10578
|
name: string;
|
10267
10579
|
description: string;
|
@@ -10271,6 +10583,8 @@ declare type PrinterInfo_2 = {
|
|
10271
10583
|
|
10272
10584
|
/**
|
10273
10585
|
* Options for printing a webpage in OpenFin.
|
10586
|
+
*
|
10587
|
+
* @interface
|
10274
10588
|
*/
|
10275
10589
|
declare type PrintOptions = {
|
10276
10590
|
content?: 'self';
|
@@ -10336,6 +10650,9 @@ declare type PrintOptions = {
|
|
10336
10650
|
*/
|
10337
10651
|
declare type ProcessAffinityStrategy = 'same' | 'different';
|
10338
10652
|
|
10653
|
+
/**
|
10654
|
+
* @interface
|
10655
|
+
*/
|
10339
10656
|
declare type ProcessDetails = {
|
10340
10657
|
/**
|
10341
10658
|
* The percentage of total CPU usage.
|
@@ -10383,8 +10700,10 @@ declare type ProcessDetails = {
|
|
10383
10700
|
|
10384
10701
|
/**
|
10385
10702
|
* Process logging options
|
10703
|
+
*
|
10704
|
+
* @interface
|
10386
10705
|
*/
|
10387
|
-
declare
|
10706
|
+
declare type ProcessLoggingOptions = {
|
10388
10707
|
/**
|
10389
10708
|
* Periodic Logging Interval (in seconds)
|
10390
10709
|
*/
|
@@ -10402,7 +10721,7 @@ declare interface ProcessLoggingOptions {
|
|
10402
10721
|
*/
|
10403
10722
|
entries?: number;
|
10404
10723
|
};
|
10405
|
-
}
|
10724
|
+
};
|
10406
10725
|
|
10407
10726
|
/**
|
10408
10727
|
* A propagated Application event.
|
@@ -10709,6 +11028,9 @@ declare type ProviderIdentity_7 = Identity_5 & {
|
|
10709
11028
|
|
10710
11029
|
declare type ProxyConfig = OpenFin.ProxyConfig;
|
10711
11030
|
|
11031
|
+
/**
|
11032
|
+
* @interface
|
11033
|
+
*/
|
10712
11034
|
declare type ProxyConfig_2 = {
|
10713
11035
|
/**
|
10714
11036
|
* The configured proxy address.
|
@@ -10723,11 +11045,17 @@ declare type ProxyConfig_2 = {
|
|
10723
11045
|
|
10724
11046
|
declare type ProxyInfo = OpenFin.ProxyInfo;
|
10725
11047
|
|
11048
|
+
/**
|
11049
|
+
* @interface
|
11050
|
+
*/
|
10726
11051
|
declare type ProxyInfo_2 = {
|
10727
11052
|
config: ProxyConfig_2;
|
10728
11053
|
system: ProxySystemInfo;
|
10729
11054
|
};
|
10730
11055
|
|
11056
|
+
/**
|
11057
|
+
* @interface
|
11058
|
+
*/
|
10731
11059
|
declare type ProxySystemInfo = {
|
10732
11060
|
/**
|
10733
11061
|
* The auto configuration url.
|
@@ -10747,6 +11075,9 @@ declare type ProxySystemInfo = {
|
|
10747
11075
|
proxy: string;
|
10748
11076
|
};
|
10749
11077
|
|
11078
|
+
/**
|
11079
|
+
* @interface
|
11080
|
+
*/
|
10750
11081
|
declare type QueryPermissionResult = {
|
10751
11082
|
/**
|
10752
11083
|
* The full name of a secured API.
|
@@ -10772,6 +11103,8 @@ declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptio
|
|
10772
11103
|
* A rectangular area on the screen.
|
10773
11104
|
*
|
10774
11105
|
* @remarks Origin is top-left. All numbers are in pixels.
|
11106
|
+
*
|
11107
|
+
* @interface
|
10775
11108
|
*/
|
10776
11109
|
declare type Rectangle = {
|
10777
11110
|
/**
|
@@ -10792,6 +11125,9 @@ declare type Rectangle = {
|
|
10792
11125
|
height: number;
|
10793
11126
|
};
|
10794
11127
|
|
11128
|
+
/**
|
11129
|
+
* @interface
|
11130
|
+
*/
|
10795
11131
|
declare type RectangleByEdgePositions = {
|
10796
11132
|
top: number;
|
10797
11133
|
left: number;
|
@@ -10807,6 +11143,9 @@ declare type RegisteredEvent = BaseEvent & {
|
|
10807
11143
|
type: 'registered';
|
10808
11144
|
};
|
10809
11145
|
|
11146
|
+
/**
|
11147
|
+
* @interface
|
11148
|
+
*/
|
10810
11149
|
declare type RegisterUsageData = {
|
10811
11150
|
data: unknown;
|
10812
11151
|
type: string;
|
@@ -10814,6 +11153,9 @@ declare type RegisterUsageData = {
|
|
10814
11153
|
|
10815
11154
|
declare type RegistryInfo = OpenFin.RegistryInfo;
|
10816
11155
|
|
11156
|
+
/**
|
11157
|
+
* @interface
|
11158
|
+
*/
|
10817
11159
|
declare type RegistryInfo_2 = {
|
10818
11160
|
data: any;
|
10819
11161
|
rootKey: string;
|
@@ -10835,6 +11177,9 @@ declare interface RemoteConfig extends ExistingConnectConfig {
|
|
10835
11177
|
token: string;
|
10836
11178
|
}
|
10837
11179
|
|
11180
|
+
/**
|
11181
|
+
* @interface
|
11182
|
+
*/
|
10838
11183
|
declare type ReplaceLayoutOpts = {
|
10839
11184
|
/**
|
10840
11185
|
* Layout config to be applied.
|
@@ -10842,6 +11187,9 @@ declare type ReplaceLayoutOpts = {
|
|
10842
11187
|
layout: LayoutOptions;
|
10843
11188
|
};
|
10844
11189
|
|
11190
|
+
/**
|
11191
|
+
* @interface
|
11192
|
+
*/
|
10845
11193
|
declare type ReplaceLayoutPayload = {
|
10846
11194
|
/**
|
10847
11195
|
* Object containing the layout to be applied.
|
@@ -10853,6 +11201,9 @@ declare type ReplaceLayoutPayload = {
|
|
10853
11201
|
target: Identity_5;
|
10854
11202
|
};
|
10855
11203
|
|
11204
|
+
/**
|
11205
|
+
* @interface
|
11206
|
+
*/
|
10856
11207
|
declare type ReplaceViewPayload = {
|
10857
11208
|
opts: {
|
10858
11209
|
viewToReplace: Identity_5;
|
@@ -10863,6 +11214,8 @@ declare type ReplaceViewPayload = {
|
|
10863
11214
|
|
10864
11215
|
/**
|
10865
11216
|
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
11217
|
+
*
|
11218
|
+
* @interface
|
10866
11219
|
*/
|
10867
11220
|
declare type ResizeRegion = {
|
10868
11221
|
/**
|
@@ -10942,6 +11295,9 @@ declare type RespondingEvent = IdentityEvent & {
|
|
10942
11295
|
|
10943
11296
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
10944
11297
|
|
11298
|
+
/**
|
11299
|
+
* @interface
|
11300
|
+
*/
|
10945
11301
|
declare type RGB = {
|
10946
11302
|
red: number;
|
10947
11303
|
blue: number;
|
@@ -10951,7 +11307,7 @@ declare type RGB = {
|
|
10951
11307
|
/**
|
10952
11308
|
* @interface
|
10953
11309
|
*/
|
10954
|
-
declare type RoutingInfo =
|
11310
|
+
declare type RoutingInfo = ProviderIdentity_7 & {
|
10955
11311
|
endpointId: string;
|
10956
11312
|
};
|
10957
11313
|
|
@@ -11016,6 +11372,8 @@ declare type RuntimeConfig = {
|
|
11016
11372
|
|
11017
11373
|
/**
|
11018
11374
|
* The options object required by the downloadRuntime function.
|
11375
|
+
*
|
11376
|
+
* @interface
|
11019
11377
|
*/
|
11020
11378
|
declare type RuntimeDownloadOptions = {
|
11021
11379
|
/**
|
@@ -11024,6 +11382,9 @@ declare type RuntimeDownloadOptions = {
|
|
11024
11382
|
version: string;
|
11025
11383
|
};
|
11026
11384
|
|
11385
|
+
/**
|
11386
|
+
* @interface
|
11387
|
+
*/
|
11027
11388
|
declare type RuntimeDownloadProgress = {
|
11028
11389
|
/**
|
11029
11390
|
* @property { string } alias The name of the asset
|
@@ -11037,6 +11398,9 @@ declare type RuntimeErrorPayload = {
|
|
11037
11398
|
error?: ErrorPlainObject;
|
11038
11399
|
};
|
11039
11400
|
|
11401
|
+
/**
|
11402
|
+
* @interface
|
11403
|
+
*/
|
11040
11404
|
declare type RuntimeInfo = {
|
11041
11405
|
/**
|
11042
11406
|
* The runtime build architecture.
|
@@ -11067,6 +11431,9 @@ declare type RuntimeInfo = {
|
|
11067
11431
|
devtoolsPort?: number;
|
11068
11432
|
};
|
11069
11433
|
|
11434
|
+
/**
|
11435
|
+
* @interface
|
11436
|
+
*/
|
11070
11437
|
declare type RVMInfo = {
|
11071
11438
|
/**
|
11072
11439
|
* The name of action: "get-rvm-info".
|
@@ -11094,6 +11461,9 @@ declare type RVMInfo = {
|
|
11094
11461
|
'working-dir': string;
|
11095
11462
|
};
|
11096
11463
|
|
11464
|
+
/**
|
11465
|
+
* @interface
|
11466
|
+
*/
|
11097
11467
|
declare type RvmLaunchOptions = {
|
11098
11468
|
/**
|
11099
11469
|
* True if no UI when launching
|
@@ -11110,6 +11480,9 @@ declare type RvmLaunchOptions = {
|
|
11110
11480
|
subscribe?: (launch: LaunchEmitter) => void;
|
11111
11481
|
};
|
11112
11482
|
|
11483
|
+
/**
|
11484
|
+
* @interface
|
11485
|
+
*/
|
11113
11486
|
declare type ScreenshotPrintOptions = {
|
11114
11487
|
content: 'screenshot';
|
11115
11488
|
};
|
@@ -11118,6 +11491,9 @@ declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
11118
11491
|
data: ProtocolMap[T]['response'];
|
11119
11492
|
} & ProtocolMap[T]['specialResponse']>;
|
11120
11493
|
|
11494
|
+
/**
|
11495
|
+
* @interface
|
11496
|
+
*/
|
11121
11497
|
declare type SendApplicationLogResponse = {
|
11122
11498
|
logId: string;
|
11123
11499
|
};
|
@@ -11132,6 +11508,9 @@ declare type ServiceConfig = {
|
|
11132
11508
|
manifestUrl: string;
|
11133
11509
|
};
|
11134
11510
|
|
11511
|
+
/**
|
11512
|
+
* @interface
|
11513
|
+
*/
|
11135
11514
|
declare type ServiceConfiguration = {
|
11136
11515
|
config: object;
|
11137
11516
|
/**
|
@@ -11140,6 +11519,9 @@ declare type ServiceConfiguration = {
|
|
11140
11519
|
name: string;
|
11141
11520
|
};
|
11142
11521
|
|
11522
|
+
/**
|
11523
|
+
* @interface
|
11524
|
+
*/
|
11143
11525
|
declare type ServiceIdentifier = {
|
11144
11526
|
/**
|
11145
11527
|
* The name of the service.
|
@@ -11156,6 +11538,9 @@ declare type SessionChangedEvent = {
|
|
11156
11538
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
11157
11539
|
};
|
11158
11540
|
|
11541
|
+
/**
|
11542
|
+
* @interface
|
11543
|
+
*/
|
11159
11544
|
declare type SessionContextGroup = {
|
11160
11545
|
id: string;
|
11161
11546
|
setContext: (context: Context) => Promise<void>;
|
@@ -11165,6 +11550,9 @@ declare type SessionContextGroup = {
|
|
11165
11550
|
}>;
|
11166
11551
|
};
|
11167
11552
|
|
11553
|
+
/**
|
11554
|
+
* @interface
|
11555
|
+
*/
|
11168
11556
|
declare type SetWindowContextPayload = {
|
11169
11557
|
/**
|
11170
11558
|
* The requested context update.
|
@@ -11173,18 +11561,24 @@ declare type SetWindowContextPayload = {
|
|
11173
11561
|
/**
|
11174
11562
|
* Entity type of the target of the context update ('view' or 'window').
|
11175
11563
|
*/
|
11176
|
-
entityType:
|
11564
|
+
entityType: EntityType_5;
|
11177
11565
|
/**
|
11178
11566
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
11179
11567
|
*/
|
11180
11568
|
target: Identity_5;
|
11181
11569
|
};
|
11182
11570
|
|
11571
|
+
/**
|
11572
|
+
* @interface
|
11573
|
+
*/
|
11183
11574
|
declare type SharedWorkerInfo = {
|
11184
11575
|
id: string;
|
11185
11576
|
url: string;
|
11186
11577
|
};
|
11187
11578
|
|
11579
|
+
/**
|
11580
|
+
* @interface
|
11581
|
+
*/
|
11188
11582
|
declare type ShortCutConfig = {
|
11189
11583
|
/**
|
11190
11584
|
* True if application has a shortcut on the desktop.
|
@@ -11215,6 +11609,9 @@ declare type ShownEvent = BaseViewEvent & {
|
|
11215
11609
|
type: 'shown';
|
11216
11610
|
};
|
11217
11611
|
|
11612
|
+
/**
|
11613
|
+
* @interface
|
11614
|
+
*/
|
11218
11615
|
declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
|
11219
11616
|
template: MenuItemTemplate<T>[];
|
11220
11617
|
x?: number;
|
@@ -11223,6 +11620,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
|
|
11223
11620
|
|
11224
11621
|
/**
|
11225
11622
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
11623
|
+
*
|
11226
11624
|
* @interface
|
11227
11625
|
*/
|
11228
11626
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
@@ -11254,6 +11652,9 @@ declare type Size = TransitionBase & {
|
|
11254
11652
|
height: number;
|
11255
11653
|
};
|
11256
11654
|
|
11655
|
+
/**
|
11656
|
+
* @interface
|
11657
|
+
*/
|
11257
11658
|
declare type Snapshot = {
|
11258
11659
|
windows: WindowCreationOptions[];
|
11259
11660
|
snapshotDetails?: {
|
@@ -11266,16 +11667,21 @@ declare type Snapshot = {
|
|
11266
11667
|
};
|
11267
11668
|
};
|
11268
11669
|
|
11269
|
-
|
11270
|
-
|
11271
|
-
|
11670
|
+
/**
|
11671
|
+
* @interface
|
11672
|
+
*/
|
11673
|
+
declare type SnapshotProvider<Snapshot = unknown> = {
|
11674
|
+
getSnapshot: () => Promise<Snapshot>;
|
11675
|
+
applySnapshot: (snapshot: Snapshot) => Promise<void>;
|
11272
11676
|
};
|
11273
11677
|
|
11274
11678
|
/**
|
11275
11679
|
* Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
|
11276
11680
|
*
|
11681
|
+
* @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
|
11682
|
+
* custom snapshot implementations for legacy applications to define their own snapshot format.
|
11277
11683
|
*/
|
11278
|
-
declare class SnapshotSource<
|
11684
|
+
declare class SnapshotSource<Snapshot = unknown> extends Base {
|
11279
11685
|
#private;
|
11280
11686
|
/**
|
11281
11687
|
* @internal
|
@@ -11314,12 +11720,12 @@ declare class SnapshotSource<T = any> extends Base {
|
|
11314
11720
|
* Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
|
11315
11721
|
*
|
11316
11722
|
*/
|
11317
|
-
getSnapshot(): Promise<
|
11723
|
+
getSnapshot(): Promise<Snapshot>;
|
11318
11724
|
/**
|
11319
11725
|
* Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
|
11320
11726
|
*
|
11321
11727
|
*/
|
11322
|
-
applySnapshot(snapshot:
|
11728
|
+
applySnapshot(snapshot: Snapshot): Promise<void>;
|
11323
11729
|
}
|
11324
11730
|
|
11325
11731
|
/**
|
@@ -11329,6 +11735,9 @@ declare class SnapshotSourceModule extends Base {
|
|
11329
11735
|
/**
|
11330
11736
|
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
11331
11737
|
*
|
11738
|
+
* @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
|
11739
|
+
* custom snapshot implementations for legacy applications to define their own snapshot format.
|
11740
|
+
*
|
11332
11741
|
* @example
|
11333
11742
|
* ```js
|
11334
11743
|
* const snapshotProvider = {
|
@@ -11344,8 +11753,9 @@ declare class SnapshotSourceModule extends Base {
|
|
11344
11753
|
*
|
11345
11754
|
* await fin.SnapshotSource.init(snapshotProvider);
|
11346
11755
|
* ```
|
11756
|
+
*
|
11347
11757
|
*/
|
11348
|
-
init<
|
11758
|
+
init<Snapshot = unknown>(provider: OpenFin.SnapshotProvider<Snapshot>): Promise<void>;
|
11349
11759
|
/**
|
11350
11760
|
* Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
11351
11761
|
*
|
@@ -11409,6 +11819,9 @@ declare type StartedEvent = IdentityEvent & {
|
|
11409
11819
|
type: 'started';
|
11410
11820
|
};
|
11411
11821
|
|
11822
|
+
/**
|
11823
|
+
* @interface
|
11824
|
+
*/
|
11412
11825
|
declare type SubscriptionOptions = {
|
11413
11826
|
/**
|
11414
11827
|
* The event timestamp.
|
@@ -12904,6 +13317,9 @@ declare namespace SystemEvents {
|
|
12904
13317
|
*/
|
12905
13318
|
declare type SystemEventType = SystemEvent['type'];
|
12906
13319
|
|
13320
|
+
/**
|
13321
|
+
* @interface
|
13322
|
+
*/
|
12907
13323
|
declare type SystemPermissions = {
|
12908
13324
|
getAllExternalWindows: boolean;
|
12909
13325
|
launchExternalProcess: boolean | {
|
@@ -12931,6 +13347,9 @@ declare type SystemPermissions = {
|
|
12931
13347
|
};
|
12932
13348
|
};
|
12933
13349
|
|
13350
|
+
/**
|
13351
|
+
* @interface
|
13352
|
+
*/
|
12934
13353
|
declare type SystemProcessInfo = {
|
12935
13354
|
apps: AppProcessInfo[];
|
12936
13355
|
browserProcess: NonAppProcessDetails;
|
@@ -13216,6 +13635,9 @@ declare type TaskBar = DipScaleRects & {
|
|
13216
13635
|
rect: RectangleByEdgePositions;
|
13217
13636
|
};
|
13218
13637
|
|
13638
|
+
/**
|
13639
|
+
* @interface
|
13640
|
+
*/
|
13219
13641
|
declare type TerminateExternalRequestType = {
|
13220
13642
|
/**
|
13221
13643
|
* The uuid of the running application.
|
@@ -13231,6 +13653,9 @@ declare type TerminateExternalRequestType = {
|
|
13231
13653
|
killTree: boolean;
|
13232
13654
|
};
|
13233
13655
|
|
13656
|
+
/**
|
13657
|
+
* @interface
|
13658
|
+
*/
|
13234
13659
|
declare type Time = {
|
13235
13660
|
/**
|
13236
13661
|
* The number of milliseconds the CPU has spent in user mode.
|
@@ -13254,6 +13679,9 @@ declare type Time = {
|
|
13254
13679
|
irq: number;
|
13255
13680
|
};
|
13256
13681
|
|
13682
|
+
/**
|
13683
|
+
* @interface
|
13684
|
+
*/
|
13257
13685
|
declare type Transition = {
|
13258
13686
|
opacity?: Opacity;
|
13259
13687
|
position?: Position;
|
@@ -13262,6 +13690,8 @@ declare type Transition = {
|
|
13262
13690
|
|
13263
13691
|
/**
|
13264
13692
|
* Base configuration options needed for all types of transitions.
|
13693
|
+
*
|
13694
|
+
* @interface
|
13265
13695
|
*/
|
13266
13696
|
declare type TransitionBase = {
|
13267
13697
|
/**
|
@@ -13278,6 +13708,8 @@ declare type TransitionBase = {
|
|
13278
13708
|
|
13279
13709
|
/**
|
13280
13710
|
* Configuration for transition between windows.
|
13711
|
+
*
|
13712
|
+
* @interface
|
13281
13713
|
*/
|
13282
13714
|
declare type TransitionOptions = {
|
13283
13715
|
/**
|
@@ -13293,7 +13725,7 @@ declare type TransitionOptions = {
|
|
13293
13725
|
tween?: tween;
|
13294
13726
|
};
|
13295
13727
|
|
13296
|
-
declare class Transport<MeType extends
|
13728
|
+
declare class Transport<MeType extends EntityType_2 = EntityType_2> extends EventEmitter {
|
13297
13729
|
#private;
|
13298
13730
|
protected wireListeners: Map<number, {
|
13299
13731
|
resolve: Function;
|
@@ -13338,6 +13770,9 @@ declare type TrayIconClickedEvent = IdentityEvent & {
|
|
13338
13770
|
monitorInfo: any;
|
13339
13771
|
};
|
13340
13772
|
|
13773
|
+
/**
|
13774
|
+
* @interface
|
13775
|
+
*/
|
13341
13776
|
declare type TrayInfo = {
|
13342
13777
|
/**
|
13343
13778
|
* The bound of tray icon in virtual screen pixels.
|
@@ -13387,9 +13822,14 @@ declare type UnregisteredEvent = BaseEvent & {
|
|
13387
13822
|
|
13388
13823
|
/**
|
13389
13824
|
* View options that can be updated after creation.
|
13825
|
+
*
|
13826
|
+
* @interface
|
13390
13827
|
*/
|
13391
13828
|
declare type UpdatableViewOptions = Partial<MutableViewOptions>;
|
13392
13829
|
|
13830
|
+
/**
|
13831
|
+
* @interface
|
13832
|
+
*/
|
13393
13833
|
declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
|
13394
13834
|
|
13395
13835
|
/**
|
@@ -14093,6 +14533,9 @@ declare namespace ViewEvents {
|
|
14093
14533
|
*/
|
14094
14534
|
declare type ViewEventType = ViewEvent['type'];
|
14095
14535
|
|
14536
|
+
/**
|
14537
|
+
* @interface
|
14538
|
+
*/
|
14096
14539
|
declare type ViewInfo = {
|
14097
14540
|
canNavigateBack: boolean;
|
14098
14541
|
canNavigateForward: boolean;
|
@@ -14227,6 +14670,7 @@ declare class ViewOverlay {
|
|
14227
14670
|
|
14228
14671
|
/**
|
14229
14672
|
* Represents the payload shape for Views that are trying to prevent an unload.
|
14673
|
+
* @interface
|
14230
14674
|
*/
|
14231
14675
|
declare interface ViewsPreventingUnloadPayload {
|
14232
14676
|
/**
|
@@ -14262,6 +14706,8 @@ declare type ViewState = ViewCreationOptions & {
|
|
14262
14706
|
};
|
14263
14707
|
|
14264
14708
|
/**
|
14709
|
+
* @interface
|
14710
|
+
*
|
14265
14711
|
* The statuses of views specifying which of them are trying to prevent an unload and which are not.
|
14266
14712
|
*/
|
14267
14713
|
declare interface ViewStatuses {
|
@@ -14277,6 +14723,8 @@ declare interface ViewStatuses {
|
|
14277
14723
|
|
14278
14724
|
/**
|
14279
14725
|
* Configuration for view visibility settings
|
14726
|
+
*
|
14727
|
+
* @interface
|
14280
14728
|
*/
|
14281
14729
|
declare type ViewVisibilityOption = {
|
14282
14730
|
enabled?: boolean;
|
@@ -14284,6 +14732,8 @@ declare type ViewVisibilityOption = {
|
|
14284
14732
|
|
14285
14733
|
/**
|
14286
14734
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
14735
|
+
*
|
14736
|
+
* @interface
|
14287
14737
|
*/
|
14288
14738
|
declare type ViewVisibilityOptions = {
|
14289
14739
|
/**
|
@@ -16950,6 +17400,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16950
17400
|
|
16951
17401
|
declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
16952
17402
|
|
17403
|
+
/**
|
17404
|
+
* @interface
|
17405
|
+
*/
|
16953
17406
|
declare type WindowDetail = {
|
16954
17407
|
/**
|
16955
17408
|
* The bottom-most coordinate of the window.
|
@@ -17080,6 +17533,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
17080
17533
|
type: 'hotkey';
|
17081
17534
|
};
|
17082
17535
|
|
17536
|
+
/**
|
17537
|
+
* @interface
|
17538
|
+
*/
|
17083
17539
|
declare type WindowInfo = {
|
17084
17540
|
canNavigateBack: boolean;
|
17085
17541
|
canNavigateForward: boolean;
|
@@ -17195,6 +17651,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
17195
17651
|
type: 'window-not-responding';
|
17196
17652
|
};
|
17197
17653
|
|
17654
|
+
/**
|
17655
|
+
* @interface
|
17656
|
+
*/
|
17198
17657
|
declare type WindowOptionDiff = {
|
17199
17658
|
[key in keyof WindowOptions]: {
|
17200
17659
|
oldVal: WindowOptions[key];
|
@@ -17268,6 +17727,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
17268
17727
|
*/
|
17269
17728
|
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
17270
17729
|
|
17730
|
+
/**
|
17731
|
+
* @interface
|
17732
|
+
*/
|
17271
17733
|
declare type WindowViewsPrintOptions = {
|
17272
17734
|
content: 'views';
|
17273
17735
|
includeSelf?: boolean;
|
@@ -17303,6 +17765,10 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
17303
17765
|
positioningOptions?: OpenFin.PositioningOptions;
|
17304
17766
|
};
|
17305
17767
|
|
17768
|
+
/**
|
17769
|
+
* @internal
|
17770
|
+
* @interface
|
17771
|
+
*/
|
17306
17772
|
declare type WorkspacePlatformOptions = {
|
17307
17773
|
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
17308
17774
|
[key: string]: any;
|
@@ -17324,6 +17790,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
17324
17790
|
* @deprecated - instead use WriteAnyClipboardRequest
|
17325
17791
|
*
|
17326
17792
|
* A generic request to write any supported data to the clipboard.
|
17793
|
+
*
|
17794
|
+
* @interface
|
17327
17795
|
*/
|
17328
17796
|
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
17329
17797
|
|
@@ -17354,6 +17822,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
17354
17822
|
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
17355
17823
|
*
|
17356
17824
|
* A request to write data to the clipboard.
|
17825
|
+
*
|
17826
|
+
* @interface
|
17357
17827
|
*/
|
17358
17828
|
declare type WriteRequestType = WriteClipboardRequest;
|
17359
17829
|
|