@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
@@ -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
|
};
|
@@ -891,10 +904,16 @@ declare type ApplicationEventType = ApplicationEvent['type'];
|
|
891
904
|
|
892
905
|
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
893
906
|
|
907
|
+
/**
|
908
|
+
* @interface
|
909
|
+
*/
|
894
910
|
declare type ApplicationIdentity_2 = {
|
895
911
|
uuid: string;
|
896
912
|
};
|
897
913
|
|
914
|
+
/**
|
915
|
+
* @interface
|
916
|
+
*/
|
898
917
|
declare type ApplicationInfo = {
|
899
918
|
initialOptions: ApplicationCreationOptions;
|
900
919
|
launchMode: string;
|
@@ -1188,6 +1207,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1188
1207
|
enableBeforeUnload: boolean;
|
1189
1208
|
};
|
1190
1209
|
|
1210
|
+
/**
|
1211
|
+
* @interface
|
1212
|
+
*/
|
1191
1213
|
declare type ApplicationPermissions = {
|
1192
1214
|
setFileDownloadLocation: boolean;
|
1193
1215
|
getFileDownloadLocation: boolean;
|
@@ -1195,6 +1217,9 @@ declare type ApplicationPermissions = {
|
|
1195
1217
|
|
1196
1218
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1197
1219
|
|
1220
|
+
/**
|
1221
|
+
* @interface
|
1222
|
+
*/
|
1198
1223
|
declare type ApplicationState_2 = {
|
1199
1224
|
/**
|
1200
1225
|
* True when the application is a Platform controller
|
@@ -1214,6 +1239,9 @@ declare type ApplicationState_2 = {
|
|
1214
1239
|
parentUuid?: string;
|
1215
1240
|
};
|
1216
1241
|
|
1242
|
+
/**
|
1243
|
+
* @interface
|
1244
|
+
*/
|
1217
1245
|
declare type ApplicationType = {
|
1218
1246
|
type: 'application' | 'external-app';
|
1219
1247
|
uuid: string;
|
@@ -1226,6 +1254,9 @@ declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedE
|
|
1226
1254
|
|
1227
1255
|
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
1228
1256
|
|
1257
|
+
/**
|
1258
|
+
* @interface
|
1259
|
+
*/
|
1229
1260
|
declare type ApplicationWindowInfo_2 = {
|
1230
1261
|
childWindows: Array<WindowDetail>;
|
1231
1262
|
mainWindow: WindowDetail;
|
@@ -1235,6 +1266,9 @@ declare type ApplicationWindowInfo_2 = {
|
|
1235
1266
|
uuid: string;
|
1236
1267
|
};
|
1237
1268
|
|
1269
|
+
/**
|
1270
|
+
* @interface
|
1271
|
+
*/
|
1238
1272
|
declare type ApplySnapshotOptions = {
|
1239
1273
|
/**
|
1240
1274
|
* @defaultValue false
|
@@ -1262,6 +1296,8 @@ declare type ApplySnapshotOptions = {
|
|
1262
1296
|
|
1263
1297
|
/**
|
1264
1298
|
* Payload sent to Platform Provider when {@link Platform#applySnapshot Platform.applySnapshot} is called.
|
1299
|
+
*
|
1300
|
+
* @interface
|
1265
1301
|
*/
|
1266
1302
|
declare type ApplySnapshotPayload = {
|
1267
1303
|
/**
|
@@ -1274,6 +1310,9 @@ declare type ApplySnapshotPayload = {
|
|
1274
1310
|
options?: ApplySnapshotOptions;
|
1275
1311
|
};
|
1276
1312
|
|
1313
|
+
/**
|
1314
|
+
* @interface
|
1315
|
+
*/
|
1277
1316
|
declare type AppProcessInfo = {
|
1278
1317
|
/**
|
1279
1318
|
* The uuid of the application.
|
@@ -1293,6 +1332,9 @@ declare type AppVersionCompleteEvent = {
|
|
1293
1332
|
type: 'app-version-complete';
|
1294
1333
|
} & AppVersionProgress;
|
1295
1334
|
|
1335
|
+
/**
|
1336
|
+
* @interface
|
1337
|
+
*/
|
1296
1338
|
declare type AppVersionError = {
|
1297
1339
|
error: string;
|
1298
1340
|
srcManifest: string;
|
@@ -1318,6 +1360,9 @@ declare type AppVersionEventType = AppVersionEvent['type'];
|
|
1318
1360
|
|
1319
1361
|
/* Excluded from this release type: AppVersionEventWithId */
|
1320
1362
|
|
1363
|
+
/**
|
1364
|
+
* @interface
|
1365
|
+
*/
|
1321
1366
|
declare type AppVersionProgress = {
|
1322
1367
|
manifest: string | null;
|
1323
1368
|
srcManifest: string;
|
@@ -1331,6 +1376,9 @@ declare type AppVersionProgressEvent = {
|
|
1331
1376
|
type: 'app-version-progress';
|
1332
1377
|
} & AppVersionProgress;
|
1333
1378
|
|
1379
|
+
/**
|
1380
|
+
* @interface
|
1381
|
+
*/
|
1334
1382
|
declare type AppVersionRuntimeInfo = {
|
1335
1383
|
version: string | null;
|
1336
1384
|
exists: boolean | null;
|
@@ -1445,6 +1493,9 @@ declare type AuthRequestedEvent = NamedEvent & {
|
|
1445
1493
|
*/
|
1446
1494
|
declare type AutoplayPolicyOptions = 'no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required';
|
1447
1495
|
|
1496
|
+
/**
|
1497
|
+
* @interface
|
1498
|
+
*/
|
1448
1499
|
declare type AutoResizeOptions = {
|
1449
1500
|
/**
|
1450
1501
|
* If true, the view's width will grow and shrink together with the window. false
|
@@ -1469,7 +1520,7 @@ declare type AutoResizeOptions = {
|
|
1469
1520
|
};
|
1470
1521
|
|
1471
1522
|
declare class Base {
|
1472
|
-
|
1523
|
+
/* Excluded from this release type: wire */
|
1473
1524
|
/* Excluded from this release type: __constructor */
|
1474
1525
|
protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
|
1475
1526
|
get me(): Identity;
|
@@ -1487,6 +1538,9 @@ declare type BaseChannelEvent = NamedEvent & {
|
|
1487
1538
|
channelId: string;
|
1488
1539
|
};
|
1489
1540
|
|
1541
|
+
/**
|
1542
|
+
* @interface
|
1543
|
+
*/
|
1490
1544
|
declare type BaseClipboardRequest = {
|
1491
1545
|
/**
|
1492
1546
|
* The type of clipboard to write to, can be 'clipboard' or 'selection'.
|
@@ -1577,8 +1631,9 @@ declare type BaseViewEvent = NamedEvent & {
|
|
1577
1631
|
|
1578
1632
|
/**
|
1579
1633
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
1634
|
+
* @interface
|
1580
1635
|
*/
|
1581
|
-
declare
|
1636
|
+
declare type BeforeUnloadUserDecision = {
|
1582
1637
|
/**
|
1583
1638
|
* Specifies if the Window should close.
|
1584
1639
|
*/
|
@@ -1587,7 +1642,7 @@ declare interface BeforeUnloadUserDecision {
|
|
1587
1642
|
* Array of views that will close.
|
1588
1643
|
*/
|
1589
1644
|
viewsToClose: Identity_5[];
|
1590
|
-
}
|
1645
|
+
};
|
1591
1646
|
|
1592
1647
|
/**
|
1593
1648
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
@@ -1605,6 +1660,9 @@ declare type BlurredEvent = NamedEvent & {
|
|
1605
1660
|
type: 'blurred';
|
1606
1661
|
};
|
1607
1662
|
|
1663
|
+
/**
|
1664
|
+
* @interface
|
1665
|
+
*/
|
1608
1666
|
declare type Bounds = {
|
1609
1667
|
top: number;
|
1610
1668
|
left: number;
|
@@ -1643,8 +1701,10 @@ declare type BoundsChangingEvent = BoundsChangeEvent & {
|
|
1643
1701
|
|
1644
1702
|
/**
|
1645
1703
|
* Configuration for page capture.
|
1704
|
+
*
|
1705
|
+
* @interface
|
1646
1706
|
*/
|
1647
|
-
declare
|
1707
|
+
declare type CapturePageOptions = {
|
1648
1708
|
/**
|
1649
1709
|
* The area of the window to be captured.
|
1650
1710
|
*/
|
@@ -1661,8 +1721,11 @@ declare interface CapturePageOptions {
|
|
1661
1721
|
* Quality of JPEG image. Between 0 - 100.
|
1662
1722
|
*/
|
1663
1723
|
quality?: number;
|
1664
|
-
}
|
1724
|
+
};
|
1665
1725
|
|
1726
|
+
/**
|
1727
|
+
* @interface
|
1728
|
+
*/
|
1666
1729
|
declare type Certificate = {
|
1667
1730
|
data: string;
|
1668
1731
|
fingerprint: string;
|
@@ -1687,6 +1750,9 @@ declare type CertificateErrorEvent = NamedEvent & {
|
|
1687
1750
|
certificate: OpenFin.Certificate;
|
1688
1751
|
};
|
1689
1752
|
|
1753
|
+
/**
|
1754
|
+
* @interface
|
1755
|
+
*/
|
1690
1756
|
declare type CertificatePrincipal = {
|
1691
1757
|
commonName: string;
|
1692
1758
|
country: string;
|
@@ -1706,6 +1772,9 @@ declare type CertificateSelectionShownEvent = NamedEvent & {
|
|
1706
1772
|
certificates: OpenFin.Certificate[];
|
1707
1773
|
};
|
1708
1774
|
|
1775
|
+
/**
|
1776
|
+
* @interface
|
1777
|
+
*/
|
1709
1778
|
declare type CertificationInfo = {
|
1710
1779
|
serial?: string;
|
1711
1780
|
subject?: string;
|
@@ -1714,6 +1783,9 @@ declare type CertificationInfo = {
|
|
1714
1783
|
trusted?: boolean;
|
1715
1784
|
};
|
1716
1785
|
|
1786
|
+
/**
|
1787
|
+
* @interface
|
1788
|
+
*/
|
1717
1789
|
declare type CertifiedAppInfo = {
|
1718
1790
|
isRunning: boolean;
|
1719
1791
|
isOptedIntoCertfiedApp?: boolean;
|
@@ -1896,7 +1968,7 @@ declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
|
|
1896
1968
|
|
1897
1969
|
declare type ChannelAction = OpenFin.ChannelAction;
|
1898
1970
|
|
1899
|
-
declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 |
|
1971
|
+
declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity) => unknown;
|
1900
1972
|
|
1901
1973
|
declare class ChannelBase {
|
1902
1974
|
protected subscriptions: Map<string, ChannelAction>;
|
@@ -2249,7 +2321,7 @@ declare class ChannelClient extends ChannelBase {
|
|
2249
2321
|
* })();
|
2250
2322
|
* ```
|
2251
2323
|
*/
|
2252
|
-
onDisconnection(listener:
|
2324
|
+
onDisconnection(listener: OpenFin.ChannelProviderDisconnectionListener): void;
|
2253
2325
|
/**
|
2254
2326
|
* Disconnects the client from the channel.
|
2255
2327
|
*
|
@@ -2269,6 +2341,10 @@ declare class ChannelClient extends ChannelBase {
|
|
2269
2341
|
|
2270
2342
|
declare type ChannelClient_2 = OpenFin.ChannelClient;
|
2271
2343
|
|
2344
|
+
declare type ChannelClientConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
|
2345
|
+
|
2346
|
+
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
2347
|
+
|
2272
2348
|
/**
|
2273
2349
|
* Generated when a Channel client is connected.
|
2274
2350
|
* @interface
|
@@ -2297,6 +2373,8 @@ declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2297
2373
|
|
2298
2374
|
/**
|
2299
2375
|
* Channel provider creation options.
|
2376
|
+
*
|
2377
|
+
* @interface
|
2300
2378
|
*/
|
2301
2379
|
declare type ChannelCreateOptions = {
|
2302
2380
|
/**
|
@@ -2320,28 +2398,9 @@ declare type ChannelEvent = {
|
|
2320
2398
|
topic: 'channel';
|
2321
2399
|
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
2322
2400
|
|
2323
|
-
declare type ChannelEvent_2 = ChannelEvents.ChannelEvent;
|
2324
|
-
|
2325
|
-
declare namespace ChannelEvents {
|
2326
|
-
export {
|
2327
|
-
BaseChannelEvent,
|
2328
|
-
ChannelConnectedEvent,
|
2329
|
-
ChannelDisconnectedEvent,
|
2330
|
-
ChannelEvent,
|
2331
|
-
ChannelEventType
|
2332
|
-
}
|
2333
|
-
}
|
2334
|
-
|
2335
|
-
/**
|
2336
|
-
* [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
|
2337
|
-
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
2338
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
2339
|
-
*/
|
2340
|
-
declare type ChannelEventType = ChannelEvent['type'];
|
2341
|
-
|
2342
2401
|
declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
|
2343
2402
|
|
2344
|
-
declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 |
|
2403
|
+
declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity) => Promise<unknown> | unknown;
|
2345
2404
|
|
2346
2405
|
/**
|
2347
2406
|
* Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
|
@@ -2464,7 +2523,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
2464
2523
|
* ```
|
2465
2524
|
* @param listener
|
2466
2525
|
*/
|
2467
|
-
onConnection(listener:
|
2526
|
+
onConnection(listener: OpenFin.ChannelClientConnectionListener): void;
|
2468
2527
|
/**
|
2469
2528
|
* Register a listener that is called on client disconnection. It is passed the disconnection event of the disconnecting
|
2470
2529
|
* client.
|
@@ -2483,7 +2542,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
2483
2542
|
* })();
|
2484
2543
|
* ```
|
2485
2544
|
*/
|
2486
|
-
onDisconnection(listener:
|
2545
|
+
onDisconnection(listener: OpenFin.ChannelClientDisconnectionListener): void;
|
2487
2546
|
/**
|
2488
2547
|
* Destroy the channel, raises `disconnected` events on all connected channel clients.
|
2489
2548
|
*
|
@@ -2538,6 +2597,8 @@ declare class ChannelProvider extends ChannelBase {
|
|
2538
2597
|
private static clientIsMultiRuntime;
|
2539
2598
|
}
|
2540
2599
|
|
2600
|
+
declare type ChannelProviderDisconnectionListener = (identity: ProviderIdentity_7) => any;
|
2601
|
+
|
2541
2602
|
declare interface ChannelStrategy<T extends unknown> {
|
2542
2603
|
onEndpointDisconnect(endpointId: string, listener: () => void): void;
|
2543
2604
|
receive(listener: (action: string, payload: any, identity: any) => Promise<any>): void;
|
@@ -2567,7 +2628,7 @@ declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
|
|
2567
2628
|
|
2568
2629
|
declare interface ChildContentOptions {
|
2569
2630
|
options: any;
|
2570
|
-
entityType:
|
2631
|
+
entityType: EntityType_4;
|
2571
2632
|
}
|
2572
2633
|
|
2573
2634
|
/**
|
@@ -2620,6 +2681,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
|
|
2620
2681
|
isValidEndpointPayload(payload: any): payload is EndpointPayload;
|
2621
2682
|
}
|
2622
2683
|
|
2684
|
+
/**
|
2685
|
+
* @interface
|
2686
|
+
*/
|
2623
2687
|
declare type ClearCacheOption = {
|
2624
2688
|
/**
|
2625
2689
|
* html5 application cache
|
@@ -2639,6 +2703,9 @@ declare type ClearCacheOption = {
|
|
2639
2703
|
localStorage?: boolean;
|
2640
2704
|
};
|
2641
2705
|
|
2706
|
+
/**
|
2707
|
+
* @interface
|
2708
|
+
*/
|
2642
2709
|
declare type ClickedMenuResult<T extends unknown = unknown> = {
|
2643
2710
|
result: 'clicked';
|
2644
2711
|
data: T;
|
@@ -2647,15 +2714,13 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
|
|
2647
2714
|
/**
|
2648
2715
|
* @interface
|
2649
2716
|
*/
|
2650
|
-
declare type ClientConnectionPayload =
|
2651
|
-
|
2652
|
-
declare type ClientIdentity = OpenFin.ClientIdentity;
|
2717
|
+
declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
2653
2718
|
|
2654
2719
|
/**
|
2655
2720
|
* Identity of a channel client
|
2656
2721
|
* @interface
|
2657
2722
|
*/
|
2658
|
-
declare type
|
2723
|
+
declare type ClientIdentity = Identity_5 & {
|
2659
2724
|
/**
|
2660
2725
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
2661
2726
|
*/
|
@@ -2666,7 +2731,7 @@ declare type ClientIdentity_2 = Identity_5 & {
|
|
2666
2731
|
/**
|
2667
2732
|
* @interface
|
2668
2733
|
*/
|
2669
|
-
declare type ClientIdentityMultiRuntime =
|
2734
|
+
declare type ClientIdentityMultiRuntime = ClientIdentity & {
|
2670
2735
|
runtimeUuid: string;
|
2671
2736
|
};
|
2672
2737
|
|
@@ -2674,11 +2739,11 @@ declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
|
|
2674
2739
|
* Extended channel client information
|
2675
2740
|
* @interface
|
2676
2741
|
*/
|
2677
|
-
declare type ClientInfo = Omit<
|
2742
|
+
declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
2678
2743
|
/**
|
2679
2744
|
* Indicates if the client belongs to a Window, View or IFrame
|
2680
2745
|
*/
|
2681
|
-
entityType:
|
2746
|
+
entityType: EntityType_5;
|
2682
2747
|
/**
|
2683
2748
|
* URL of the Window, View or IFrame at the time of connection to the Channel Provider.
|
2684
2749
|
*/
|
@@ -2870,10 +2935,16 @@ declare type ClosedEvent = IdentityEvent & {
|
|
2870
2935
|
type: 'closed';
|
2871
2936
|
};
|
2872
2937
|
|
2938
|
+
/**
|
2939
|
+
* @interface
|
2940
|
+
*/
|
2873
2941
|
declare type ClosedMenuResult = {
|
2874
2942
|
result: 'closed';
|
2875
2943
|
};
|
2876
2944
|
|
2945
|
+
/**
|
2946
|
+
* @interface
|
2947
|
+
*/
|
2877
2948
|
declare type CloseViewPayload = {
|
2878
2949
|
/**
|
2879
2950
|
*View to be closed.
|
@@ -2882,6 +2953,8 @@ declare type CloseViewPayload = {
|
|
2882
2953
|
};
|
2883
2954
|
|
2884
2955
|
/**
|
2956
|
+
* @interface
|
2957
|
+
*
|
2885
2958
|
* Represents the shape of payload that contains the Window Identity and related options.
|
2886
2959
|
*/
|
2887
2960
|
declare interface CloseWindowPayload {
|
@@ -2958,14 +3031,14 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
|
|
2958
3031
|
|
2959
3032
|
declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
|
2960
3033
|
|
2961
|
-
declare type ConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
|
2962
|
-
|
2963
3034
|
declare type Constructor<T = {}> = new () => T;
|
2964
3035
|
|
2965
3036
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
2966
3037
|
|
2967
3038
|
/**
|
2968
3039
|
* View options that cannot be updated after creation.
|
3040
|
+
*
|
3041
|
+
* @interface
|
2969
3042
|
*/
|
2970
3043
|
declare type ConstViewOptions = {
|
2971
3044
|
/**
|
@@ -3033,6 +3106,8 @@ declare type ConstViewOptions = {
|
|
3033
3106
|
|
3034
3107
|
/**
|
3035
3108
|
* Window options that cannot be changed after creation.
|
3109
|
+
*
|
3110
|
+
* @interface
|
3036
3111
|
*/
|
3037
3112
|
declare type ConstWindowOptions = {
|
3038
3113
|
/**
|
@@ -3234,6 +3309,8 @@ declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'brows
|
|
3234
3309
|
|
3235
3310
|
/**
|
3236
3311
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
3312
|
+
*
|
3313
|
+
* @interface
|
3237
3314
|
*/
|
3238
3315
|
declare type ContentCreationOptions = {
|
3239
3316
|
/**
|
@@ -3249,6 +3326,8 @@ declare type ContentCreationOptions = {
|
|
3249
3326
|
* @property { string } behavior 'view' | 'window' | 'browser' | 'block'
|
3250
3327
|
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
3251
3328
|
* @property { object } options Window creation options or View creation options.
|
3329
|
+
*
|
3330
|
+
* @interface
|
3252
3331
|
*/
|
3253
3332
|
declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
3254
3333
|
/**
|
@@ -3301,6 +3380,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
3301
3380
|
* Restrict navigation to URLs that match an allowed pattern.
|
3302
3381
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
3303
3382
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
3383
|
+
*
|
3384
|
+
* @interface
|
3304
3385
|
*/
|
3305
3386
|
declare type ContentNavigation = NavigationRules;
|
3306
3387
|
|
@@ -3308,11 +3389,15 @@ declare type ContentNavigation = NavigationRules;
|
|
3308
3389
|
* Restrict redirects to URLs that match an allowed pattern.
|
3309
3390
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
3310
3391
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
3392
|
+
*
|
3393
|
+
* @interface
|
3311
3394
|
*/
|
3312
3395
|
declare type ContentRedirect = NavigationRules;
|
3313
3396
|
|
3314
3397
|
/**
|
3315
3398
|
* Data passed between entities and applications.
|
3399
|
+
*
|
3400
|
+
* @interface
|
3316
3401
|
*/
|
3317
3402
|
declare type Context = {
|
3318
3403
|
/**
|
@@ -3338,6 +3423,9 @@ declare type ContextForIntent<MetadataType = any> = Context & {
|
|
3338
3423
|
metadata?: MetadataType;
|
3339
3424
|
};
|
3340
3425
|
|
3426
|
+
/**
|
3427
|
+
* @interface
|
3428
|
+
*/
|
3341
3429
|
declare type ContextGroupInfo = {
|
3342
3430
|
/**
|
3343
3431
|
* Unique identifier of the context group.
|
@@ -3359,6 +3447,8 @@ declare type ContextHandler = (context: Context) => void;
|
|
3359
3447
|
|
3360
3448
|
/**
|
3361
3449
|
* Configure the context menu when right-clicking on a window.
|
3450
|
+
*
|
3451
|
+
* @interface
|
3362
3452
|
*/
|
3363
3453
|
declare type ContextMenuOptions = {
|
3364
3454
|
/**
|
@@ -3374,6 +3464,8 @@ declare type ContextMenuOptions = {
|
|
3374
3464
|
/**
|
3375
3465
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
3376
3466
|
* Configure the context menu when right-clicking on a window.
|
3467
|
+
*
|
3468
|
+
* @interface
|
3377
3469
|
*/
|
3378
3470
|
declare type ContextMenuSettings = {
|
3379
3471
|
/**
|
@@ -3390,12 +3482,18 @@ declare type ContextMenuSettings = {
|
|
3390
3482
|
reload?: boolean;
|
3391
3483
|
};
|
3392
3484
|
|
3485
|
+
/**
|
3486
|
+
* @interface
|
3487
|
+
*/
|
3393
3488
|
declare type CookieInfo = {
|
3394
3489
|
name: string;
|
3395
3490
|
domain: string;
|
3396
3491
|
path: string;
|
3397
3492
|
};
|
3398
3493
|
|
3494
|
+
/**
|
3495
|
+
* @interface
|
3496
|
+
*/
|
3399
3497
|
declare type CookieOption = {
|
3400
3498
|
name: string;
|
3401
3499
|
};
|
@@ -3403,6 +3501,8 @@ declare type CookieOption = {
|
|
3403
3501
|
/**
|
3404
3502
|
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
3405
3503
|
* average of _height_ and _width_.
|
3504
|
+
*
|
3505
|
+
* @interface
|
3406
3506
|
*/
|
3407
3507
|
declare type CornerRounding = {
|
3408
3508
|
/**
|
@@ -3419,6 +3519,9 @@ declare type CornerRounding = {
|
|
3419
3519
|
width: number;
|
3420
3520
|
};
|
3421
3521
|
|
3522
|
+
/**
|
3523
|
+
* @interface
|
3524
|
+
*/
|
3422
3525
|
declare type CpuInfo = {
|
3423
3526
|
/**
|
3424
3527
|
* The model of the cpu
|
@@ -3448,6 +3551,9 @@ declare type CrashedEvent = NamedEvent & {
|
|
3448
3551
|
};
|
3449
3552
|
};
|
3450
3553
|
|
3554
|
+
/**
|
3555
|
+
* @interface
|
3556
|
+
*/
|
3451
3557
|
declare type CrashReporterOptions = {
|
3452
3558
|
/**
|
3453
3559
|
* In diagnostics mode the crash reporter will send diagnostic logs to
|
@@ -3475,6 +3581,9 @@ declare type CreatedEvent = BaseViewEvent & {
|
|
3475
3581
|
type: 'created';
|
3476
3582
|
};
|
3477
3583
|
|
3584
|
+
/**
|
3585
|
+
* @interface
|
3586
|
+
*/
|
3478
3587
|
declare type CreateViewPayload = {
|
3479
3588
|
/**
|
3480
3589
|
* Options for the view to be added.
|
@@ -3503,6 +3612,8 @@ declare type CreateViewTarget = Identity_5 & {
|
|
3503
3612
|
|
3504
3613
|
/**
|
3505
3614
|
* Custom headers for requests sent by the window.
|
3615
|
+
*
|
3616
|
+
* @interface
|
3506
3617
|
*/
|
3507
3618
|
declare type CustomRequestHeaders = {
|
3508
3619
|
/**
|
@@ -3516,10 +3627,16 @@ declare type CustomRequestHeaders = {
|
|
3516
3627
|
headers: WebRequestHeader[];
|
3517
3628
|
};
|
3518
3629
|
|
3630
|
+
/**
|
3631
|
+
* @interface
|
3632
|
+
*/
|
3519
3633
|
declare type DefaultDomainSettings = {
|
3520
3634
|
rules: DefaultDomainSettingsRule[];
|
3521
3635
|
};
|
3522
3636
|
|
3637
|
+
/**
|
3638
|
+
* @interface
|
3639
|
+
*/
|
3523
3640
|
declare type DefaultDomainSettingsRule = {
|
3524
3641
|
match: string[];
|
3525
3642
|
options: {
|
@@ -3575,6 +3692,9 @@ declare type DipRect = RectangleByEdgePositions & {
|
|
3575
3692
|
scaledRect: RectangleByEdgePositions;
|
3576
3693
|
};
|
3577
3694
|
|
3695
|
+
/**
|
3696
|
+
* @interface
|
3697
|
+
*/
|
3578
3698
|
declare type DipScaleRects = {
|
3579
3699
|
dipRect: RectangleByEdgePositions;
|
3580
3700
|
scaledRect: RectangleByEdgePositions;
|
@@ -3596,12 +3716,10 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
3596
3716
|
type: 'disabled-movement-bounds-changing';
|
3597
3717
|
};
|
3598
3718
|
|
3599
|
-
declare type DisconnectionListener = (providerIdentity: OpenFin.ProviderIdentity) => any;
|
3600
|
-
|
3601
|
-
declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
|
3602
|
-
|
3603
3719
|
/**
|
3604
3720
|
* The display data for a context group.
|
3721
|
+
*
|
3722
|
+
* @interface
|
3605
3723
|
*/
|
3606
3724
|
declare type DisplayMetadata = {
|
3607
3725
|
/**
|
@@ -3620,6 +3738,8 @@ declare type DisplayMetadata = {
|
|
3620
3738
|
|
3621
3739
|
/**
|
3622
3740
|
* Metadata returned from a preload script download request.
|
3741
|
+
*
|
3742
|
+
* @interface
|
3623
3743
|
*/
|
3624
3744
|
declare type DownloadPreloadInfo = {
|
3625
3745
|
/**
|
@@ -3638,6 +3758,8 @@ declare type DownloadPreloadInfo = {
|
|
3638
3758
|
|
3639
3759
|
/**
|
3640
3760
|
* Options for downloading a preload script.
|
3761
|
+
*
|
3762
|
+
* @interface
|
3641
3763
|
*/
|
3642
3764
|
declare type DownloadPreloadOption = {
|
3643
3765
|
/**
|
@@ -3646,6 +3768,9 @@ declare type DownloadPreloadOption = {
|
|
3646
3768
|
url: string;
|
3647
3769
|
};
|
3648
3770
|
|
3771
|
+
/**
|
3772
|
+
* @interface
|
3773
|
+
*/
|
3649
3774
|
declare type DownloadRule = {
|
3650
3775
|
behavior: FileDownloadBehaviorNames;
|
3651
3776
|
match: string[];
|
@@ -3653,6 +3778,8 @@ declare type DownloadRule = {
|
|
3653
3778
|
|
3654
3779
|
/**
|
3655
3780
|
* DPI (dots per inch) configuration for printing.
|
3781
|
+
*
|
3782
|
+
* @interface
|
3656
3783
|
*/
|
3657
3784
|
declare type Dpi = {
|
3658
3785
|
/**
|
@@ -3715,53 +3842,35 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
3715
3842
|
protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
|
3716
3843
|
/**
|
3717
3844
|
* Adds a listener to the end of the listeners array for the specified event.
|
3718
|
-
*
|
3719
|
-
* @param eventType
|
3720
|
-
* @param listener
|
3721
|
-
* @param options
|
3722
3845
|
*/
|
3723
3846
|
on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3724
|
-
|
3847
|
+
/**
|
3848
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
3849
|
+
*/
|
3850
|
+
addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3725
3851
|
/**
|
3726
3852
|
* 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.
|
3727
|
-
*
|
3728
|
-
* @param eventType
|
3729
|
-
* @param listener
|
3730
|
-
* @param options
|
3731
3853
|
*/
|
3732
3854
|
once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3733
3855
|
/**
|
3734
3856
|
* Adds a listener to the beginning of the listeners array for the specified event.
|
3735
|
-
*
|
3736
|
-
* @param eventType
|
3737
|
-
* @param listener
|
3738
|
-
* @param options
|
3739
3857
|
*/
|
3740
3858
|
prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3741
3859
|
/**
|
3742
3860
|
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
|
3743
3861
|
* after which it is removed. The listener is added to the beginning of the listeners array.
|
3744
|
-
*
|
3745
|
-
* @param eventType
|
3746
|
-
* @param listener
|
3747
|
-
* @param options
|
3748
3862
|
*/
|
3749
3863
|
prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3750
3864
|
/**
|
3751
3865
|
* Remove a listener from the listener array for the specified event.
|
3752
3866
|
*
|
3753
3867
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
3754
|
-
*
|
3755
|
-
* @param eventType
|
3756
|
-
* @param listener
|
3757
|
-
* @param options
|
3758
3868
|
*/
|
3759
3869
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3760
3870
|
protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
|
3761
3871
|
/**
|
3762
3872
|
* Removes all listeners, or those of the specified event.
|
3763
3873
|
*
|
3764
|
-
* @param eventType
|
3765
3874
|
*/
|
3766
3875
|
removeAllListeners(eventType?: EmitterEventType): Promise<this>;
|
3767
3876
|
private deleteEmitterIfNothingRegistered;
|
@@ -3804,10 +3913,13 @@ declare type Entity = OpenFin.ApplicationType;
|
|
3804
3913
|
|
3805
3914
|
declare type EntityInfo = OpenFin.EntityInfo;
|
3806
3915
|
|
3916
|
+
/**
|
3917
|
+
* @interface
|
3918
|
+
*/
|
3807
3919
|
declare type EntityInfo_2 = {
|
3808
3920
|
uuid: string;
|
3809
3921
|
name: string;
|
3810
|
-
entityType:
|
3922
|
+
entityType: EntityType_5;
|
3811
3923
|
};
|
3812
3924
|
|
3813
3925
|
/**
|
@@ -3821,15 +3933,15 @@ declare type EntityProcessDetails = FrameProcessDetails & {
|
|
3821
3933
|
|
3822
3934
|
declare type EntityType = OpenFin.EntityType;
|
3823
3935
|
|
3824
|
-
declare type EntityType_2 =
|
3936
|
+
declare type EntityType_2 = OpenFin.EntityType;
|
3825
3937
|
|
3826
3938
|
declare type EntityType_3 = OpenFin.EntityType;
|
3827
3939
|
|
3828
3940
|
declare type EntityType_4 = OpenFin.EntityType;
|
3829
3941
|
|
3830
|
-
declare type EntityType_5 =
|
3942
|
+
declare type EntityType_5 = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
|
3831
3943
|
|
3832
|
-
declare type EntityTypeHelpers<T extends
|
3944
|
+
declare type EntityTypeHelpers<T extends EntityType_3> = T extends 'view' ? {
|
3833
3945
|
isView: true;
|
3834
3946
|
isWindow: false;
|
3835
3947
|
isExternal: false;
|
@@ -3867,7 +3979,7 @@ declare interface Environment {
|
|
3867
3979
|
createChildContent(options: ChildContentOptions): Promise<any>;
|
3868
3980
|
getWebWindow(identity: OpenFin.Identity): globalThis.Window;
|
3869
3981
|
getCurrentEntityIdentity(): OpenFin.EntityInfo;
|
3870
|
-
getCurrentEntityType():
|
3982
|
+
getCurrentEntityType(): EntityType_4;
|
3871
3983
|
raiseEvent(eventName: string, eventArgs: any): void;
|
3872
3984
|
childViews: boolean;
|
3873
3985
|
getUrl(): string;
|
@@ -3882,7 +3994,7 @@ declare interface Environment {
|
|
3882
3994
|
|
3883
3995
|
declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
|
3884
3996
|
|
3885
|
-
declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 |
|
3997
|
+
declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
|
3886
3998
|
|
3887
3999
|
/**
|
3888
4000
|
* This function converts JS errors into plain objects
|
@@ -3915,6 +4027,9 @@ declare type ExistingConnectConfig = ConfigWithUuid & {
|
|
3915
4027
|
address: string;
|
3916
4028
|
};
|
3917
4029
|
|
4030
|
+
/**
|
4031
|
+
* @interface
|
4032
|
+
*/
|
3918
4033
|
declare type ExitCode = {
|
3919
4034
|
topic: string;
|
3920
4035
|
uuid: string;
|
@@ -4061,6 +4176,9 @@ declare namespace ExternalApplicationEvents {
|
|
4061
4176
|
}
|
4062
4177
|
}
|
4063
4178
|
|
4179
|
+
/**
|
4180
|
+
* @interface
|
4181
|
+
*/
|
4064
4182
|
declare type ExternalApplicationInfo = {
|
4065
4183
|
parent: Identity_5;
|
4066
4184
|
};
|
@@ -4103,6 +4221,9 @@ declare type ExternalConfig = BaseConfig & {
|
|
4103
4221
|
manifestUrl: string;
|
4104
4222
|
};
|
4105
4223
|
|
4224
|
+
/**
|
4225
|
+
* @interface
|
4226
|
+
*/
|
4106
4227
|
declare type ExternalConnection = {
|
4107
4228
|
/**
|
4108
4229
|
* The token to broker an external connection.
|
@@ -4124,11 +4245,17 @@ declare type ExternalProcessExitedEvent = NamedEvent & {
|
|
4124
4245
|
exitCode: number;
|
4125
4246
|
};
|
4126
4247
|
|
4248
|
+
/**
|
4249
|
+
* @interface
|
4250
|
+
*/
|
4127
4251
|
declare type ExternalProcessInfo = {
|
4128
4252
|
pid: number;
|
4129
4253
|
listener?: LaunchExternalProcessListener;
|
4130
4254
|
};
|
4131
4255
|
|
4256
|
+
/**
|
4257
|
+
* @interface
|
4258
|
+
*/
|
4132
4259
|
declare type ExternalProcessRequestType = {
|
4133
4260
|
/**
|
4134
4261
|
* The file path to where the running application resides.
|
@@ -4171,6 +4298,9 @@ declare type FaviconUpdatedEvent = NamedEvent & {
|
|
4171
4298
|
favicons: string[];
|
4172
4299
|
};
|
4173
4300
|
|
4301
|
+
/**
|
4302
|
+
* @interface
|
4303
|
+
*/
|
4174
4304
|
declare type FetchManifestPayload = {
|
4175
4305
|
/**
|
4176
4306
|
* The URL of the manifest to fetch.
|
@@ -4259,6 +4389,9 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
4259
4389
|
state: 'progressing' | 'interrupted';
|
4260
4390
|
};
|
4261
4391
|
|
4392
|
+
/**
|
4393
|
+
* @interface
|
4394
|
+
*/
|
4262
4395
|
declare type FileDownloadSettings = {
|
4263
4396
|
rules: DownloadRule[];
|
4264
4397
|
};
|
@@ -4272,26 +4405,13 @@ declare type FileDownloadStartedEvent = FileDownloadEvent & {
|
|
4272
4405
|
state: 'started';
|
4273
4406
|
};
|
4274
4407
|
|
4275
|
-
|
4276
|
-
private wire;
|
4277
|
-
System: System;
|
4278
|
-
Window: _WindowModule;
|
4279
|
-
Application: ApplicationModule;
|
4280
|
-
InterApplicationBus: InterApplicationBus;
|
4281
|
-
Clipboard: Clipboard_2;
|
4282
|
-
ExternalApplication: ExternalApplicationModule;
|
4283
|
-
Frame: _FrameModule;
|
4284
|
-
GlobalHotkey: GlobalHotkey;
|
4285
|
-
View: ViewModule;
|
4286
|
-
Platform: PlatformModule;
|
4287
|
-
Interop: InteropModule;
|
4288
|
-
SnapshotSource: SnapshotSourceModule;
|
4289
|
-
readonly me: Me<MeType>;
|
4290
|
-
/* Excluded from this release type: __constructor */
|
4291
|
-
}
|
4408
|
+
/* Excluded from this release type: Fin */
|
4292
4409
|
|
4293
|
-
declare type Fin_2<MeType extends
|
4410
|
+
declare type Fin_2<MeType extends EntityType_5 = 'window' | 'view'> = FinApi<MeType>;
|
4294
4411
|
|
4412
|
+
/**
|
4413
|
+
* Type of the global `fin` entry point for the OpenFin API.
|
4414
|
+
*/
|
4295
4415
|
declare interface FinApi<MeType extends EntityType> {
|
4296
4416
|
readonly System: System;
|
4297
4417
|
readonly Window: _WindowModule;
|
@@ -4310,6 +4430,8 @@ declare interface FinApi<MeType extends EntityType> {
|
|
4310
4430
|
|
4311
4431
|
/**
|
4312
4432
|
* Configuration for find-in-page requests.
|
4433
|
+
*
|
4434
|
+
* @interface
|
4313
4435
|
*/
|
4314
4436
|
declare type FindInPageOptions = {
|
4315
4437
|
/**
|
@@ -4345,6 +4467,9 @@ declare type FindInPageOptions = {
|
|
4345
4467
|
medialCapitalAsWordStart?: boolean;
|
4346
4468
|
};
|
4347
4469
|
|
4470
|
+
/**
|
4471
|
+
* @interface
|
4472
|
+
*/
|
4348
4473
|
declare type FindInPageResult = {
|
4349
4474
|
requestId: number;
|
4350
4475
|
/**
|
@@ -4362,6 +4487,9 @@ declare type FindInPageResult = {
|
|
4362
4487
|
finalUpdate: boolean;
|
4363
4488
|
};
|
4364
4489
|
|
4490
|
+
/**
|
4491
|
+
* @interface
|
4492
|
+
*/
|
4365
4493
|
declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
4366
4494
|
context: Context;
|
4367
4495
|
metadata?: MetadataType;
|
@@ -4556,11 +4684,14 @@ declare namespace FrameEvents {
|
|
4556
4684
|
*/
|
4557
4685
|
declare type FrameEventType = FrameEvent['type'];
|
4558
4686
|
|
4687
|
+
/**
|
4688
|
+
* @interface
|
4689
|
+
*/
|
4559
4690
|
declare type FrameInfo = {
|
4560
4691
|
name: string;
|
4561
4692
|
uuid: string;
|
4562
4693
|
url: string;
|
4563
|
-
entityType:
|
4694
|
+
entityType: EntityType_5;
|
4564
4695
|
parent: Identity_5;
|
4565
4696
|
};
|
4566
4697
|
|
@@ -4632,6 +4763,9 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
4632
4763
|
|
4633
4764
|
declare type GetLogRequestType = OpenFin.GetLogRequestType;
|
4634
4765
|
|
4766
|
+
/**
|
4767
|
+
* @interface
|
4768
|
+
*/
|
4635
4769
|
declare type GetLogRequestType_2 = {
|
4636
4770
|
/**
|
4637
4771
|
* The name of the running application
|
@@ -4649,11 +4783,14 @@ declare type GetLogRequestType_2 = {
|
|
4649
4783
|
|
4650
4784
|
declare type GetterCall<T> = ApiCall<void, T>;
|
4651
4785
|
|
4786
|
+
/**
|
4787
|
+
* @interface
|
4788
|
+
*/
|
4652
4789
|
declare type GetWindowContextPayload = {
|
4653
4790
|
/**
|
4654
4791
|
* Entity type of the target of the context update ('view' or 'window').
|
4655
4792
|
*/
|
4656
|
-
entityType:
|
4793
|
+
entityType: EntityType_5;
|
4657
4794
|
/**
|
4658
4795
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
4659
4796
|
*/
|
@@ -4781,6 +4918,9 @@ declare namespace GlobalHotkeyEvents {
|
|
4781
4918
|
}
|
4782
4919
|
}
|
4783
4920
|
|
4921
|
+
/**
|
4922
|
+
* @interface
|
4923
|
+
*/
|
4784
4924
|
declare type GpuInfo = {
|
4785
4925
|
name: string;
|
4786
4926
|
};
|
@@ -4793,6 +4933,9 @@ declare type HiddenEvent = BaseViewEvent & {
|
|
4793
4933
|
type: 'hidden';
|
4794
4934
|
};
|
4795
4935
|
|
4936
|
+
/**
|
4937
|
+
* @interface
|
4938
|
+
*/
|
4796
4939
|
declare type HostContextChangedPayload = {
|
4797
4940
|
/**
|
4798
4941
|
* The new context object
|
@@ -4806,6 +4949,9 @@ declare type HostContextChangedPayload = {
|
|
4806
4949
|
|
4807
4950
|
declare type HostContextChangedReasons = 'updated' | 'reparented';
|
4808
4951
|
|
4952
|
+
/**
|
4953
|
+
* @interface
|
4954
|
+
*/
|
4809
4955
|
declare type HostSpecs = {
|
4810
4956
|
/**
|
4811
4957
|
* True if Aero Glass theme is supported on Windows platforms
|
@@ -4839,6 +4985,8 @@ declare type HostSpecs = {
|
|
4839
4985
|
|
4840
4986
|
/**
|
4841
4987
|
* A hotkey binding.
|
4988
|
+
*
|
4989
|
+
* @interface
|
4842
4990
|
*/
|
4843
4991
|
declare type Hotkey = {
|
4844
4992
|
/**
|
@@ -4875,6 +5023,8 @@ declare type Identity_4 = OpenFin.Identity;
|
|
4875
5023
|
*
|
4876
5024
|
* @remarks The `uuid` property refers the application that owns the entity, not to the entity itself.
|
4877
5025
|
* The `name` property identifies the entity itself, and must be unique within the application.
|
5026
|
+
*
|
5027
|
+
* @interface
|
4878
5028
|
*/
|
4879
5029
|
declare type Identity_5 = {
|
4880
5030
|
/**
|
@@ -4922,6 +5072,9 @@ declare type ImageFormatOptions = {
|
|
4922
5072
|
quality?: number;
|
4923
5073
|
};
|
4924
5074
|
|
5075
|
+
/**
|
5076
|
+
* @interface
|
5077
|
+
*/
|
4925
5078
|
declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
4926
5079
|
/**
|
4927
5080
|
* Name of the intent to get info for.
|
@@ -4943,6 +5096,9 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
|
|
4943
5096
|
|
4944
5097
|
declare type InitLayoutOptions_2 = OpenFin.InitLayoutOptions;
|
4945
5098
|
|
5099
|
+
/**
|
5100
|
+
* @interface
|
5101
|
+
*/
|
4946
5102
|
declare type InitLayoutOptions_3 = {
|
4947
5103
|
/**
|
4948
5104
|
* The id attribute of the container where the window's Layout should be initialized. If not provided
|
@@ -4951,6 +5107,9 @@ declare type InitLayoutOptions_3 = {
|
|
4951
5107
|
containerId?: string;
|
4952
5108
|
};
|
4953
5109
|
|
5110
|
+
/**
|
5111
|
+
* @interface
|
5112
|
+
*/
|
4954
5113
|
declare type InitPlatformOptions = {
|
4955
5114
|
/**
|
4956
5115
|
* A callback function or an array of constructor callbacks that can be used to extend or replace default Provider behavior.
|
@@ -4978,12 +5137,18 @@ declare type InputEvent_2 = {
|
|
4978
5137
|
command?: string;
|
4979
5138
|
};
|
4980
5139
|
|
5140
|
+
/**
|
5141
|
+
* @interface
|
5142
|
+
*/
|
4981
5143
|
declare type InstallationInfo = {
|
4982
5144
|
cachedManifest: any;
|
4983
5145
|
};
|
4984
5146
|
|
4985
5147
|
declare type InstalledApps = OpenFin.InstalledApps;
|
4986
5148
|
|
5149
|
+
/**
|
5150
|
+
* @interface
|
5151
|
+
*/
|
4987
5152
|
declare type InstalledApps_2 = {
|
4988
5153
|
[key: string]: InstallationInfo;
|
4989
5154
|
};
|
@@ -5005,6 +5170,9 @@ declare type Intent<MetadataType = IntentMetadata> = {
|
|
5005
5170
|
|
5006
5171
|
declare type IntentHandler = (intent: Intent) => void;
|
5007
5172
|
|
5173
|
+
/**
|
5174
|
+
* @interface
|
5175
|
+
*/
|
5008
5176
|
declare type IntentMetadata<TargetType = any> = {
|
5009
5177
|
target?: TargetType;
|
5010
5178
|
resultType?: string;
|
@@ -5120,10 +5288,11 @@ declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
|
|
5120
5288
|
|
5121
5289
|
/**
|
5122
5290
|
* Define whether to enable interop action logging.
|
5291
|
+
*
|
5123
5292
|
*/
|
5124
|
-
declare
|
5293
|
+
declare type InteropActionLoggingOption = {
|
5125
5294
|
enabled: boolean;
|
5126
|
-
}
|
5295
|
+
};
|
5127
5296
|
|
5128
5297
|
/**
|
5129
5298
|
* {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
|
@@ -5789,12 +5958,18 @@ declare class InteropBroker extends Base {
|
|
5789
5958
|
isActionAuthorized(_action: string, _payload: any, _identity: OpenFin.ClientIdentity): Promise<boolean> | boolean;
|
5790
5959
|
}
|
5791
5960
|
|
5961
|
+
/**
|
5962
|
+
* @interface
|
5963
|
+
*/
|
5792
5964
|
declare type InteropBrokerDisconnectionEvent = {
|
5793
5965
|
type: string;
|
5794
5966
|
topic: string;
|
5795
5967
|
brokerName: string;
|
5796
5968
|
};
|
5797
5969
|
|
5970
|
+
/**
|
5971
|
+
* @interface
|
5972
|
+
*/
|
5798
5973
|
declare type InteropBrokerOptions = {
|
5799
5974
|
contextGroups?: ContextGroupInfo;
|
5800
5975
|
logging?: InteropLoggingOptions;
|
@@ -6297,8 +6472,14 @@ declare class InteropClient extends Base {
|
|
6297
6472
|
static ferryFdc3Call(interopClient: OpenFin.InteropClient, action: string, payload?: any): Promise<any>;
|
6298
6473
|
}
|
6299
6474
|
|
6475
|
+
/**
|
6476
|
+
* @interface
|
6477
|
+
*/
|
6300
6478
|
declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
|
6301
6479
|
|
6480
|
+
/**
|
6481
|
+
* @interface
|
6482
|
+
*/
|
6302
6483
|
declare type InteropConfig = {
|
6303
6484
|
/**
|
6304
6485
|
* Context Group for the client. (green, yellow, red, etc.).
|
@@ -6312,6 +6493,9 @@ declare type InteropConfig = {
|
|
6312
6493
|
|
6313
6494
|
declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
6314
6495
|
|
6496
|
+
/**
|
6497
|
+
* @interface
|
6498
|
+
*/
|
6315
6499
|
declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
6316
6500
|
|
6317
6501
|
/**
|
@@ -6366,6 +6550,9 @@ declare class InteropModule extends Base {
|
|
6366
6550
|
connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
|
6367
6551
|
}
|
6368
6552
|
|
6553
|
+
/**
|
6554
|
+
* @interface
|
6555
|
+
*/
|
6369
6556
|
declare type JumpListCategory = {
|
6370
6557
|
/**
|
6371
6558
|
* The display title for the category.
|
@@ -6382,10 +6569,16 @@ declare type JumpListCategory = {
|
|
6382
6569
|
|
6383
6570
|
declare type JumpListItem = JumpListTask | JumpListSeparator;
|
6384
6571
|
|
6572
|
+
/**
|
6573
|
+
* @interface
|
6574
|
+
*/
|
6385
6575
|
declare type JumpListSeparator = {
|
6386
6576
|
type: 'separator';
|
6387
6577
|
};
|
6388
6578
|
|
6579
|
+
/**
|
6580
|
+
* @interface
|
6581
|
+
*/
|
6389
6582
|
declare type JumpListTask = {
|
6390
6583
|
type: 'task';
|
6391
6584
|
/**
|
@@ -6479,15 +6672,19 @@ export declare function launch(config: ConnectConfig): Promise<number>;
|
|
6479
6672
|
*/
|
6480
6673
|
declare type LaunchEmitter = TypedEventEmitter<AppVersionEvent>;
|
6481
6674
|
|
6482
|
-
declare type LaunchExternalProcessListener =
|
6483
|
-
(code: ExitCode): void;
|
6484
|
-
};
|
6675
|
+
declare type LaunchExternalProcessListener = (code: ExitCode) => void;
|
6485
6676
|
|
6677
|
+
/**
|
6678
|
+
* @interface
|
6679
|
+
*/
|
6486
6680
|
declare type LaunchExternalProcessRule = {
|
6487
6681
|
behavior: 'allow' | 'block';
|
6488
6682
|
match: string[];
|
6489
6683
|
};
|
6490
6684
|
|
6685
|
+
/**
|
6686
|
+
* @interface
|
6687
|
+
*/
|
6491
6688
|
declare type LaunchIntoPlatformPayload = {
|
6492
6689
|
manifest: any;
|
6493
6690
|
};
|
@@ -6770,14 +6967,20 @@ declare class Layout extends Base {
|
|
6770
6967
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
6771
6968
|
}
|
6772
6969
|
|
6773
|
-
|
6970
|
+
/**
|
6971
|
+
* @interface
|
6972
|
+
*/
|
6973
|
+
declare type LayoutColumn = LayoutItemConfig & {
|
6774
6974
|
type: 'column';
|
6775
|
-
}
|
6975
|
+
};
|
6776
6976
|
|
6777
|
-
|
6977
|
+
/**
|
6978
|
+
* @interface
|
6979
|
+
*/
|
6980
|
+
declare type LayoutComponent = LayoutItemConfig & {
|
6778
6981
|
componentName: 'view';
|
6779
6982
|
componentState?: Partial<ViewCreationOptions>;
|
6780
|
-
}
|
6983
|
+
};
|
6781
6984
|
|
6782
6985
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
6783
6986
|
|
@@ -6795,6 +6998,9 @@ declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
|
|
6795
6998
|
|
6796
6999
|
/* Excluded from this release type: LayoutEntitiesController */
|
6797
7000
|
|
7001
|
+
/**
|
7002
|
+
* @interface
|
7003
|
+
*/
|
6798
7004
|
declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes = LayoutEntityTypes> = {
|
6799
7005
|
type: TLayoutEntityType;
|
6800
7006
|
entityId: string;
|
@@ -6817,6 +7023,8 @@ declare type LayoutInitializedEvent = NamedEvent & {
|
|
6817
7023
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
6818
7024
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
|
6819
7025
|
* {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
|
7026
|
+
*
|
7027
|
+
* @interface
|
6820
7028
|
*/
|
6821
7029
|
declare type LayoutItemConfig = {
|
6822
7030
|
/**
|
@@ -7037,6 +7245,9 @@ declare type LayoutModule_2 = OpenFin.Fin['Platform']['Layout'];
|
|
7037
7245
|
|
7038
7246
|
/* Excluded from this release type: LayoutNode */
|
7039
7247
|
|
7248
|
+
/**
|
7249
|
+
* @interface
|
7250
|
+
*/
|
7040
7251
|
declare type LayoutOptions = {
|
7041
7252
|
/**
|
7042
7253
|
* Represents a potential ways to customize behavior of your Layout
|
@@ -7117,6 +7328,9 @@ declare type LayoutOptions = {
|
|
7117
7328
|
|
7118
7329
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
7119
7330
|
|
7331
|
+
/**
|
7332
|
+
* @interface
|
7333
|
+
*/
|
7120
7334
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
7121
7335
|
|
7122
7336
|
/**
|
@@ -7130,10 +7344,16 @@ declare type LayoutReadyEvent = NamedEvent & {
|
|
7130
7344
|
})[];
|
7131
7345
|
};
|
7132
7346
|
|
7133
|
-
|
7347
|
+
/**
|
7348
|
+
* @interface
|
7349
|
+
*/
|
7350
|
+
declare type LayoutRow = LayoutItemConfig & {
|
7134
7351
|
type: 'row';
|
7135
|
-
}
|
7352
|
+
};
|
7136
7353
|
|
7354
|
+
/**
|
7355
|
+
* @interface
|
7356
|
+
*/
|
7137
7357
|
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'>;
|
7138
7358
|
|
7139
7359
|
declare type Listener<T extends {
|
@@ -7142,6 +7362,9 @@ declare type Listener<T extends {
|
|
7142
7362
|
|
7143
7363
|
declare type LogInfo = OpenFin.LogInfo;
|
7144
7364
|
|
7365
|
+
/**
|
7366
|
+
* @interface
|
7367
|
+
*/
|
7145
7368
|
declare type LogInfo_2 = {
|
7146
7369
|
/**
|
7147
7370
|
* The filename of the log
|
@@ -7170,6 +7393,9 @@ declare type LogLevel = OpenFin.LogLevel;
|
|
7170
7393
|
*/
|
7171
7394
|
declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
7172
7395
|
|
7396
|
+
/**
|
7397
|
+
* @interface
|
7398
|
+
*/
|
7173
7399
|
declare type Manifest = {
|
7174
7400
|
appAssets?: {
|
7175
7401
|
alias: string;
|
@@ -7235,6 +7461,9 @@ declare type ManifestChangedEvent = IdentityEvent & {
|
|
7235
7461
|
type: 'manifest-changed';
|
7236
7462
|
};
|
7237
7463
|
|
7464
|
+
/**
|
7465
|
+
* @interface
|
7466
|
+
*/
|
7238
7467
|
declare type ManifestInfo = {
|
7239
7468
|
/**
|
7240
7469
|
* The uuid of the application.
|
@@ -7248,6 +7477,8 @@ declare type ManifestInfo = {
|
|
7248
7477
|
|
7249
7478
|
/**
|
7250
7479
|
* Margins configuration for printing.
|
7480
|
+
*
|
7481
|
+
* @interface
|
7251
7482
|
*/
|
7252
7483
|
declare type Margins = {
|
7253
7484
|
marginType?: 'default' | 'none' | 'printableArea' | 'custom';
|
@@ -7279,10 +7510,13 @@ declare type MaximizedEvent = NamedEvent & {
|
|
7279
7510
|
type: 'maximized';
|
7280
7511
|
};
|
7281
7512
|
|
7282
|
-
declare type Me<MeType extends
|
7513
|
+
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) & {
|
7283
7514
|
isOpenFin: boolean;
|
7284
7515
|
};
|
7285
7516
|
|
7517
|
+
/**
|
7518
|
+
* @interface
|
7519
|
+
*/
|
7286
7520
|
declare type MenuItemTemplate<T extends unknown = unknown> = {
|
7287
7521
|
/**
|
7288
7522
|
* Can be `normal`, `separator`, `submenu`, or `checkbox`.
|
@@ -7352,6 +7586,9 @@ declare type MinimizedEvent = NamedEvent & {
|
|
7352
7586
|
type: 'minimized';
|
7353
7587
|
};
|
7354
7588
|
|
7589
|
+
/**
|
7590
|
+
* @interface
|
7591
|
+
*/
|
7355
7592
|
declare type MonitorDetails = {
|
7356
7593
|
/**
|
7357
7594
|
* The available DIP scale coordinates.
|
@@ -7398,6 +7635,9 @@ declare type MonitorEvent = OpenFin.MonitorInfo & {
|
|
7398
7635
|
type: 'monitor-info-changed';
|
7399
7636
|
};
|
7400
7637
|
|
7638
|
+
/**
|
7639
|
+
* @interface
|
7640
|
+
*/
|
7401
7641
|
declare type MonitorInfo = {
|
7402
7642
|
/**
|
7403
7643
|
* The device scale factor.
|
@@ -7417,6 +7657,9 @@ declare type MonitorInfo = {
|
|
7417
7657
|
virtualScreen: DipRect;
|
7418
7658
|
};
|
7419
7659
|
|
7660
|
+
/**
|
7661
|
+
* @interface
|
7662
|
+
*/
|
7420
7663
|
declare type MutableViewOptions = {
|
7421
7664
|
autoResize: AutoResizeOptions;
|
7422
7665
|
/**
|
@@ -7498,6 +7741,8 @@ declare type MutableViewOptions = {
|
|
7498
7741
|
|
7499
7742
|
/**
|
7500
7743
|
* Window options that can be changed after window creation.
|
7744
|
+
*
|
7745
|
+
* @interface
|
7501
7746
|
*/
|
7502
7747
|
declare type MutableWindowOptions = {
|
7503
7748
|
/**
|
@@ -7746,6 +7991,9 @@ declare type NamedEvent = IdentityEvent & {
|
|
7746
7991
|
name: string;
|
7747
7992
|
};
|
7748
7993
|
|
7994
|
+
/**
|
7995
|
+
* @interface
|
7996
|
+
*/
|
7749
7997
|
declare type NativeWindowIntegrationProviderAuthorization = {
|
7750
7998
|
authorizedUuid: string;
|
7751
7999
|
};
|
@@ -7760,6 +8008,9 @@ declare type NavigationRejectedEvent = NamedEvent & {
|
|
7760
8008
|
url: string;
|
7761
8009
|
};
|
7762
8010
|
|
8011
|
+
/**
|
8012
|
+
* @interface
|
8013
|
+
*/
|
7763
8014
|
declare type NavigationRules = {
|
7764
8015
|
/** @deprecated Use allowlist property instead. */
|
7765
8016
|
whitelist?: string[];
|
@@ -7819,21 +8070,32 @@ declare type Opacity = TransitionBase & {
|
|
7819
8070
|
|
7820
8071
|
declare namespace OpenFin {
|
7821
8072
|
export {
|
8073
|
+
FinApi,
|
7822
8074
|
Fin_2 as Fin,
|
7823
8075
|
Application,
|
8076
|
+
ApplicationModule,
|
7824
8077
|
ExternalApplication,
|
8078
|
+
ExternalApplicationModule,
|
7825
8079
|
_Frame as Frame,
|
8080
|
+
_FrameModule,
|
8081
|
+
Channel,
|
7826
8082
|
ChannelClient,
|
7827
8083
|
ChannelProvider,
|
7828
8084
|
Platform,
|
8085
|
+
PlatformModule,
|
7829
8086
|
Layout,
|
8087
|
+
LayoutModule,
|
7830
8088
|
View_2 as View,
|
8089
|
+
ViewModule,
|
7831
8090
|
ColumnOrRow,
|
7832
8091
|
TabStack,
|
7833
8092
|
_Window as Window,
|
8093
|
+
_WindowModule,
|
7834
8094
|
InteropClient,
|
7835
8095
|
InteropBroker,
|
8096
|
+
InteropModule,
|
7836
8097
|
SnapshotSource,
|
8098
|
+
SnapshotSourceModule,
|
7837
8099
|
LayoutEntityDefinition,
|
7838
8100
|
LayoutEntityTypes,
|
7839
8101
|
LayoutPosition,
|
@@ -7841,12 +8103,12 @@ declare namespace OpenFin {
|
|
7841
8103
|
PlatformProvider,
|
7842
8104
|
ApplicationIdentity_2 as ApplicationIdentity,
|
7843
8105
|
Identity_5 as Identity,
|
7844
|
-
|
8106
|
+
ClientIdentity,
|
7845
8107
|
ClientInfo,
|
7846
8108
|
ClientIdentityMultiRuntime,
|
7847
8109
|
ClientConnectionPayload,
|
7848
8110
|
EntityInfo_2 as EntityInfo,
|
7849
|
-
|
8111
|
+
EntityType_5 as EntityType,
|
7850
8112
|
Bounds,
|
7851
8113
|
WindowBounds,
|
7852
8114
|
Rectangle,
|
@@ -8086,7 +8348,6 @@ declare namespace OpenFin {
|
|
8086
8348
|
AppVersionCompleteEvent,
|
8087
8349
|
AppVersionRuntimeStatusEvent,
|
8088
8350
|
BaseEvents,
|
8089
|
-
ChannelEvents,
|
8090
8351
|
WebContentsEvents,
|
8091
8352
|
SystemEvents,
|
8092
8353
|
ApplicationEvents,
|
@@ -8097,7 +8358,6 @@ declare namespace OpenFin {
|
|
8097
8358
|
PlatformEvents,
|
8098
8359
|
ExternalApplicationEvents,
|
8099
8360
|
BaseEvent_2 as BaseEvent,
|
8100
|
-
ChannelEvent_2 as ChannelEvent,
|
8101
8361
|
WebContentsEvent_2 as WebContentsEvent,
|
8102
8362
|
SystemEvent_2 as SystemEvent,
|
8103
8363
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -8117,7 +8377,11 @@ declare namespace OpenFin {
|
|
8117
8377
|
Me,
|
8118
8378
|
CapturePageOptions,
|
8119
8379
|
ProcessLoggingOptions,
|
8120
|
-
PositioningOptions
|
8380
|
+
PositioningOptions,
|
8381
|
+
ChannelClientConnectionListener,
|
8382
|
+
ChannelClientDisconnectionListener,
|
8383
|
+
ChannelProviderDisconnectionListener,
|
8384
|
+
RoutingInfo
|
8121
8385
|
}
|
8122
8386
|
}
|
8123
8387
|
export default OpenFin;
|
@@ -8157,6 +8421,9 @@ declare type PerformanceReportEvent = Performance & NamedEvent & {
|
|
8157
8421
|
type: 'performance-report';
|
8158
8422
|
};
|
8159
8423
|
|
8424
|
+
/**
|
8425
|
+
* @interface
|
8426
|
+
*/
|
8160
8427
|
declare type Permissions_2 = {
|
8161
8428
|
Application?: Partial<ApplicationPermissions>;
|
8162
8429
|
System?: Partial<SystemPermissions>;
|
@@ -9488,6 +9755,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
|
|
9488
9755
|
type: 'platform-snapshot-applied';
|
9489
9756
|
};
|
9490
9757
|
|
9758
|
+
/**
|
9759
|
+
* @interface
|
9760
|
+
*/
|
9491
9761
|
declare type PlatformViewCreationOptions = Partial<ViewOptions>;
|
9492
9762
|
|
9493
9763
|
/**
|
@@ -9514,6 +9784,9 @@ declare type PlatformWindowOptions = WindowCreationOptions & {
|
|
9514
9784
|
stylesheetUrl: string;
|
9515
9785
|
};
|
9516
9786
|
|
9787
|
+
/**
|
9788
|
+
* @interface
|
9789
|
+
*/
|
9517
9790
|
declare type Point = {
|
9518
9791
|
/**
|
9519
9792
|
* The mouse x position
|
@@ -9525,6 +9798,9 @@ declare type Point = {
|
|
9525
9798
|
y: number;
|
9526
9799
|
};
|
9527
9800
|
|
9801
|
+
/**
|
9802
|
+
* @interface
|
9803
|
+
*/
|
9528
9804
|
declare type PointTopLeft = {
|
9529
9805
|
/**
|
9530
9806
|
* The mouse top position in virtual screen coordinates
|
@@ -9544,8 +9820,10 @@ declare type PopupInteraction = 'clicked' | 'dismissed';
|
|
9544
9820
|
|
9545
9821
|
/**
|
9546
9822
|
* Popup window options.
|
9823
|
+
*
|
9824
|
+
* @interface
|
9547
9825
|
*/
|
9548
|
-
declare
|
9826
|
+
declare type PopupOptions = {
|
9549
9827
|
/**
|
9550
9828
|
* Window creation options when using `showPopupWindow` to create a new window.
|
9551
9829
|
*/
|
@@ -9619,14 +9897,15 @@ declare interface PopupOptions {
|
|
9619
9897
|
* <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
|
9620
9898
|
*/
|
9621
9899
|
onPopupResult?: (payload: PopupResult) => any;
|
9622
|
-
}
|
9900
|
+
};
|
9623
9901
|
|
9624
9902
|
/**
|
9625
9903
|
* The Popup result.
|
9626
9904
|
*
|
9627
9905
|
* @typeParam T - Type of data the Popup result contains
|
9906
|
+
* @interface
|
9628
9907
|
*/
|
9629
|
-
declare
|
9908
|
+
declare type PopupResult<T = any> = {
|
9630
9909
|
/**
|
9631
9910
|
* `name` and `uuid` of the popup window that called dispatched this result.
|
9632
9911
|
*/
|
@@ -9646,7 +9925,7 @@ declare interface PopupResult<T = any> {
|
|
9646
9925
|
* The last dispatch result.
|
9647
9926
|
*/
|
9648
9927
|
lastDispatchResult?: PopupResult;
|
9649
|
-
}
|
9928
|
+
};
|
9650
9929
|
|
9651
9930
|
declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
|
9652
9931
|
|
@@ -9675,14 +9954,17 @@ declare type Position = TransitionBase & {
|
|
9675
9954
|
fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
|
9676
9955
|
```
|
9677
9956
|
*/
|
9678
|
-
|
9957
|
+
/**
|
9958
|
+
* @interface
|
9959
|
+
*/
|
9960
|
+
declare type PositioningOptions = {
|
9679
9961
|
/**
|
9680
9962
|
* Windows Only.
|
9681
9963
|
* If set to true, will not restore a maximized window before setting the bounds.
|
9682
9964
|
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
9683
9965
|
*/
|
9684
9966
|
skipRestore?: boolean;
|
9685
|
-
}
|
9967
|
+
};
|
9686
9968
|
|
9687
9969
|
/**
|
9688
9970
|
* Context menu item with an implementation provided by OpenFin.
|
@@ -9691,6 +9973,8 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
9691
9973
|
|
9692
9974
|
/**
|
9693
9975
|
* A script that is run before page load.
|
9976
|
+
*
|
9977
|
+
* @interface
|
9694
9978
|
*/
|
9695
9979
|
declare type PreloadScript = {
|
9696
9980
|
/**
|
@@ -9751,6 +10035,9 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
|
|
9751
10035
|
|
9752
10036
|
declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
9753
10037
|
|
10038
|
+
/**
|
10039
|
+
* @interface
|
10040
|
+
*/
|
9754
10041
|
declare type PresetLayoutOptions_2 = {
|
9755
10042
|
/**
|
9756
10043
|
* Which preset layout arrangement to use.
|
@@ -9761,6 +10048,9 @@ declare type PresetLayoutOptions_2 = {
|
|
9761
10048
|
|
9762
10049
|
declare type PrinterInfo = OpenFin.PrinterInfo;
|
9763
10050
|
|
10051
|
+
/**
|
10052
|
+
* @interface
|
10053
|
+
*/
|
9764
10054
|
declare type PrinterInfo_2 = {
|
9765
10055
|
name: string;
|
9766
10056
|
description: string;
|
@@ -9770,6 +10060,8 @@ declare type PrinterInfo_2 = {
|
|
9770
10060
|
|
9771
10061
|
/**
|
9772
10062
|
* Options for printing a webpage in OpenFin.
|
10063
|
+
*
|
10064
|
+
* @interface
|
9773
10065
|
*/
|
9774
10066
|
declare type PrintOptions = {
|
9775
10067
|
content?: 'self';
|
@@ -9835,6 +10127,9 @@ declare type PrintOptions = {
|
|
9835
10127
|
*/
|
9836
10128
|
declare type ProcessAffinityStrategy = 'same' | 'different';
|
9837
10129
|
|
10130
|
+
/**
|
10131
|
+
* @interface
|
10132
|
+
*/
|
9838
10133
|
declare type ProcessDetails = {
|
9839
10134
|
/**
|
9840
10135
|
* The percentage of total CPU usage.
|
@@ -9882,8 +10177,10 @@ declare type ProcessDetails = {
|
|
9882
10177
|
|
9883
10178
|
/**
|
9884
10179
|
* Process logging options
|
10180
|
+
*
|
10181
|
+
* @interface
|
9885
10182
|
*/
|
9886
|
-
declare
|
10183
|
+
declare type ProcessLoggingOptions = {
|
9887
10184
|
/**
|
9888
10185
|
* Periodic Logging Interval (in seconds)
|
9889
10186
|
*/
|
@@ -9901,7 +10198,7 @@ declare interface ProcessLoggingOptions {
|
|
9901
10198
|
*/
|
9902
10199
|
entries?: number;
|
9903
10200
|
};
|
9904
|
-
}
|
10201
|
+
};
|
9905
10202
|
|
9906
10203
|
/**
|
9907
10204
|
* A propagated Application event.
|
@@ -10208,6 +10505,9 @@ declare type ProviderIdentity_7 = Identity_5 & {
|
|
10208
10505
|
|
10209
10506
|
declare type ProxyConfig = OpenFin.ProxyConfig;
|
10210
10507
|
|
10508
|
+
/**
|
10509
|
+
* @interface
|
10510
|
+
*/
|
10211
10511
|
declare type ProxyConfig_2 = {
|
10212
10512
|
/**
|
10213
10513
|
* The configured proxy address.
|
@@ -10222,11 +10522,17 @@ declare type ProxyConfig_2 = {
|
|
10222
10522
|
|
10223
10523
|
declare type ProxyInfo = OpenFin.ProxyInfo;
|
10224
10524
|
|
10525
|
+
/**
|
10526
|
+
* @interface
|
10527
|
+
*/
|
10225
10528
|
declare type ProxyInfo_2 = {
|
10226
10529
|
config: ProxyConfig_2;
|
10227
10530
|
system: ProxySystemInfo;
|
10228
10531
|
};
|
10229
10532
|
|
10533
|
+
/**
|
10534
|
+
* @interface
|
10535
|
+
*/
|
10230
10536
|
declare type ProxySystemInfo = {
|
10231
10537
|
/**
|
10232
10538
|
* The auto configuration url.
|
@@ -10246,6 +10552,9 @@ declare type ProxySystemInfo = {
|
|
10246
10552
|
proxy: string;
|
10247
10553
|
};
|
10248
10554
|
|
10555
|
+
/**
|
10556
|
+
* @interface
|
10557
|
+
*/
|
10249
10558
|
declare type QueryPermissionResult = {
|
10250
10559
|
/**
|
10251
10560
|
* The full name of a secured API.
|
@@ -10271,6 +10580,8 @@ declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptio
|
|
10271
10580
|
* A rectangular area on the screen.
|
10272
10581
|
*
|
10273
10582
|
* @remarks Origin is top-left. All numbers are in pixels.
|
10583
|
+
*
|
10584
|
+
* @interface
|
10274
10585
|
*/
|
10275
10586
|
declare type Rectangle = {
|
10276
10587
|
/**
|
@@ -10291,6 +10602,9 @@ declare type Rectangle = {
|
|
10291
10602
|
height: number;
|
10292
10603
|
};
|
10293
10604
|
|
10605
|
+
/**
|
10606
|
+
* @interface
|
10607
|
+
*/
|
10294
10608
|
declare type RectangleByEdgePositions = {
|
10295
10609
|
top: number;
|
10296
10610
|
left: number;
|
@@ -10306,6 +10620,9 @@ declare type RegisteredEvent = BaseEvent & {
|
|
10306
10620
|
type: 'registered';
|
10307
10621
|
};
|
10308
10622
|
|
10623
|
+
/**
|
10624
|
+
* @interface
|
10625
|
+
*/
|
10309
10626
|
declare type RegisterUsageData = {
|
10310
10627
|
data: unknown;
|
10311
10628
|
type: string;
|
@@ -10313,6 +10630,9 @@ declare type RegisterUsageData = {
|
|
10313
10630
|
|
10314
10631
|
declare type RegistryInfo = OpenFin.RegistryInfo;
|
10315
10632
|
|
10633
|
+
/**
|
10634
|
+
* @interface
|
10635
|
+
*/
|
10316
10636
|
declare type RegistryInfo_2 = {
|
10317
10637
|
data: any;
|
10318
10638
|
rootKey: string;
|
@@ -10334,6 +10654,9 @@ declare interface RemoteConfig extends ExistingConnectConfig {
|
|
10334
10654
|
token: string;
|
10335
10655
|
}
|
10336
10656
|
|
10657
|
+
/**
|
10658
|
+
* @interface
|
10659
|
+
*/
|
10337
10660
|
declare type ReplaceLayoutOpts = {
|
10338
10661
|
/**
|
10339
10662
|
* Layout config to be applied.
|
@@ -10341,6 +10664,9 @@ declare type ReplaceLayoutOpts = {
|
|
10341
10664
|
layout: LayoutOptions;
|
10342
10665
|
};
|
10343
10666
|
|
10667
|
+
/**
|
10668
|
+
* @interface
|
10669
|
+
*/
|
10344
10670
|
declare type ReplaceLayoutPayload = {
|
10345
10671
|
/**
|
10346
10672
|
* Object containing the layout to be applied.
|
@@ -10352,6 +10678,9 @@ declare type ReplaceLayoutPayload = {
|
|
10352
10678
|
target: Identity_5;
|
10353
10679
|
};
|
10354
10680
|
|
10681
|
+
/**
|
10682
|
+
* @interface
|
10683
|
+
*/
|
10355
10684
|
declare type ReplaceViewPayload = {
|
10356
10685
|
opts: {
|
10357
10686
|
viewToReplace: Identity_5;
|
@@ -10362,6 +10691,8 @@ declare type ReplaceViewPayload = {
|
|
10362
10691
|
|
10363
10692
|
/**
|
10364
10693
|
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
10694
|
+
*
|
10695
|
+
* @interface
|
10365
10696
|
*/
|
10366
10697
|
declare type ResizeRegion = {
|
10367
10698
|
/**
|
@@ -10441,6 +10772,9 @@ declare type RespondingEvent = IdentityEvent & {
|
|
10441
10772
|
|
10442
10773
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
10443
10774
|
|
10775
|
+
/**
|
10776
|
+
* @interface
|
10777
|
+
*/
|
10444
10778
|
declare type RGB = {
|
10445
10779
|
red: number;
|
10446
10780
|
blue: number;
|
@@ -10450,7 +10784,7 @@ declare type RGB = {
|
|
10450
10784
|
/**
|
10451
10785
|
* @interface
|
10452
10786
|
*/
|
10453
|
-
declare type RoutingInfo =
|
10787
|
+
declare type RoutingInfo = ProviderIdentity_7 & {
|
10454
10788
|
endpointId: string;
|
10455
10789
|
};
|
10456
10790
|
|
@@ -10515,6 +10849,8 @@ declare type RuntimeConfig = {
|
|
10515
10849
|
|
10516
10850
|
/**
|
10517
10851
|
* The options object required by the downloadRuntime function.
|
10852
|
+
*
|
10853
|
+
* @interface
|
10518
10854
|
*/
|
10519
10855
|
declare type RuntimeDownloadOptions = {
|
10520
10856
|
/**
|
@@ -10523,6 +10859,9 @@ declare type RuntimeDownloadOptions = {
|
|
10523
10859
|
version: string;
|
10524
10860
|
};
|
10525
10861
|
|
10862
|
+
/**
|
10863
|
+
* @interface
|
10864
|
+
*/
|
10526
10865
|
declare type RuntimeDownloadProgress = {
|
10527
10866
|
/**
|
10528
10867
|
* @property { string } alias The name of the asset
|
@@ -10536,6 +10875,9 @@ declare type RuntimeErrorPayload = {
|
|
10536
10875
|
error?: ErrorPlainObject;
|
10537
10876
|
};
|
10538
10877
|
|
10878
|
+
/**
|
10879
|
+
* @interface
|
10880
|
+
*/
|
10539
10881
|
declare type RuntimeInfo = {
|
10540
10882
|
/**
|
10541
10883
|
* The runtime build architecture.
|
@@ -10566,6 +10908,9 @@ declare type RuntimeInfo = {
|
|
10566
10908
|
devtoolsPort?: number;
|
10567
10909
|
};
|
10568
10910
|
|
10911
|
+
/**
|
10912
|
+
* @interface
|
10913
|
+
*/
|
10569
10914
|
declare type RVMInfo = {
|
10570
10915
|
/**
|
10571
10916
|
* The name of action: "get-rvm-info".
|
@@ -10593,6 +10938,9 @@ declare type RVMInfo = {
|
|
10593
10938
|
'working-dir': string;
|
10594
10939
|
};
|
10595
10940
|
|
10941
|
+
/**
|
10942
|
+
* @interface
|
10943
|
+
*/
|
10596
10944
|
declare type RvmLaunchOptions = {
|
10597
10945
|
/**
|
10598
10946
|
* True if no UI when launching
|
@@ -10609,6 +10957,9 @@ declare type RvmLaunchOptions = {
|
|
10609
10957
|
subscribe?: (launch: LaunchEmitter) => void;
|
10610
10958
|
};
|
10611
10959
|
|
10960
|
+
/**
|
10961
|
+
* @interface
|
10962
|
+
*/
|
10612
10963
|
declare type ScreenshotPrintOptions = {
|
10613
10964
|
content: 'screenshot';
|
10614
10965
|
};
|
@@ -10617,6 +10968,9 @@ declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
10617
10968
|
data: ProtocolMap[T]['response'];
|
10618
10969
|
} & ProtocolMap[T]['specialResponse']>;
|
10619
10970
|
|
10971
|
+
/**
|
10972
|
+
* @interface
|
10973
|
+
*/
|
10620
10974
|
declare type SendApplicationLogResponse = {
|
10621
10975
|
logId: string;
|
10622
10976
|
};
|
@@ -10631,6 +10985,9 @@ declare type ServiceConfig = {
|
|
10631
10985
|
manifestUrl: string;
|
10632
10986
|
};
|
10633
10987
|
|
10988
|
+
/**
|
10989
|
+
* @interface
|
10990
|
+
*/
|
10634
10991
|
declare type ServiceConfiguration = {
|
10635
10992
|
config: object;
|
10636
10993
|
/**
|
@@ -10639,6 +10996,9 @@ declare type ServiceConfiguration = {
|
|
10639
10996
|
name: string;
|
10640
10997
|
};
|
10641
10998
|
|
10999
|
+
/**
|
11000
|
+
* @interface
|
11001
|
+
*/
|
10642
11002
|
declare type ServiceIdentifier = {
|
10643
11003
|
/**
|
10644
11004
|
* The name of the service.
|
@@ -10655,6 +11015,9 @@ declare type SessionChangedEvent = {
|
|
10655
11015
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
10656
11016
|
};
|
10657
11017
|
|
11018
|
+
/**
|
11019
|
+
* @interface
|
11020
|
+
*/
|
10658
11021
|
declare type SessionContextGroup = {
|
10659
11022
|
id: string;
|
10660
11023
|
setContext: (context: Context) => Promise<void>;
|
@@ -10664,6 +11027,9 @@ declare type SessionContextGroup = {
|
|
10664
11027
|
}>;
|
10665
11028
|
};
|
10666
11029
|
|
11030
|
+
/**
|
11031
|
+
* @interface
|
11032
|
+
*/
|
10667
11033
|
declare type SetWindowContextPayload = {
|
10668
11034
|
/**
|
10669
11035
|
* The requested context update.
|
@@ -10672,18 +11038,24 @@ declare type SetWindowContextPayload = {
|
|
10672
11038
|
/**
|
10673
11039
|
* Entity type of the target of the context update ('view' or 'window').
|
10674
11040
|
*/
|
10675
|
-
entityType:
|
11041
|
+
entityType: EntityType_5;
|
10676
11042
|
/**
|
10677
11043
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
10678
11044
|
*/
|
10679
11045
|
target: Identity_5;
|
10680
11046
|
};
|
10681
11047
|
|
11048
|
+
/**
|
11049
|
+
* @interface
|
11050
|
+
*/
|
10682
11051
|
declare type SharedWorkerInfo = {
|
10683
11052
|
id: string;
|
10684
11053
|
url: string;
|
10685
11054
|
};
|
10686
11055
|
|
11056
|
+
/**
|
11057
|
+
* @interface
|
11058
|
+
*/
|
10687
11059
|
declare type ShortCutConfig = {
|
10688
11060
|
/**
|
10689
11061
|
* True if application has a shortcut on the desktop.
|
@@ -10714,6 +11086,9 @@ declare type ShownEvent = BaseViewEvent & {
|
|
10714
11086
|
type: 'shown';
|
10715
11087
|
};
|
10716
11088
|
|
11089
|
+
/**
|
11090
|
+
* @interface
|
11091
|
+
*/
|
10717
11092
|
declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
|
10718
11093
|
template: MenuItemTemplate<T>[];
|
10719
11094
|
x?: number;
|
@@ -10722,6 +11097,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
|
|
10722
11097
|
|
10723
11098
|
/**
|
10724
11099
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
11100
|
+
*
|
10725
11101
|
* @interface
|
10726
11102
|
*/
|
10727
11103
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
@@ -10753,6 +11129,9 @@ declare type Size = TransitionBase & {
|
|
10753
11129
|
height: number;
|
10754
11130
|
};
|
10755
11131
|
|
11132
|
+
/**
|
11133
|
+
* @interface
|
11134
|
+
*/
|
10756
11135
|
declare type Snapshot = {
|
10757
11136
|
windows: WindowCreationOptions[];
|
10758
11137
|
snapshotDetails?: {
|
@@ -10765,16 +11144,21 @@ declare type Snapshot = {
|
|
10765
11144
|
};
|
10766
11145
|
};
|
10767
11146
|
|
10768
|
-
|
10769
|
-
|
10770
|
-
|
11147
|
+
/**
|
11148
|
+
* @interface
|
11149
|
+
*/
|
11150
|
+
declare type SnapshotProvider<Snapshot = unknown> = {
|
11151
|
+
getSnapshot: () => Promise<Snapshot>;
|
11152
|
+
applySnapshot: (snapshot: Snapshot) => Promise<void>;
|
10771
11153
|
};
|
10772
11154
|
|
10773
11155
|
/**
|
10774
11156
|
* Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
|
10775
11157
|
*
|
11158
|
+
* @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
|
11159
|
+
* custom snapshot implementations for legacy applications to define their own snapshot format.
|
10776
11160
|
*/
|
10777
|
-
declare class SnapshotSource<
|
11161
|
+
declare class SnapshotSource<Snapshot = unknown> extends Base {
|
10778
11162
|
#private;
|
10779
11163
|
/* Excluded from this release type: __constructor */
|
10780
11164
|
get identity(): OpenFin.ApplicationIdentity;
|
@@ -10810,12 +11194,12 @@ declare class SnapshotSource<T = any> extends Base {
|
|
10810
11194
|
* Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
|
10811
11195
|
*
|
10812
11196
|
*/
|
10813
|
-
getSnapshot(): Promise<
|
11197
|
+
getSnapshot(): Promise<Snapshot>;
|
10814
11198
|
/**
|
10815
11199
|
* Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
|
10816
11200
|
*
|
10817
11201
|
*/
|
10818
|
-
applySnapshot(snapshot:
|
11202
|
+
applySnapshot(snapshot: Snapshot): Promise<void>;
|
10819
11203
|
}
|
10820
11204
|
|
10821
11205
|
/**
|
@@ -10825,6 +11209,9 @@ declare class SnapshotSourceModule extends Base {
|
|
10825
11209
|
/**
|
10826
11210
|
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
10827
11211
|
*
|
11212
|
+
* @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
|
11213
|
+
* custom snapshot implementations for legacy applications to define their own snapshot format.
|
11214
|
+
*
|
10828
11215
|
* @example
|
10829
11216
|
* ```js
|
10830
11217
|
* const snapshotProvider = {
|
@@ -10840,8 +11227,9 @@ declare class SnapshotSourceModule extends Base {
|
|
10840
11227
|
*
|
10841
11228
|
* await fin.SnapshotSource.init(snapshotProvider);
|
10842
11229
|
* ```
|
11230
|
+
*
|
10843
11231
|
*/
|
10844
|
-
init<
|
11232
|
+
init<Snapshot = unknown>(provider: OpenFin.SnapshotProvider<Snapshot>): Promise<void>;
|
10845
11233
|
/**
|
10846
11234
|
* Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
10847
11235
|
*
|
@@ -10905,6 +11293,9 @@ declare type StartedEvent = IdentityEvent & {
|
|
10905
11293
|
type: 'started';
|
10906
11294
|
};
|
10907
11295
|
|
11296
|
+
/**
|
11297
|
+
* @interface
|
11298
|
+
*/
|
10908
11299
|
declare type SubscriptionOptions = {
|
10909
11300
|
/**
|
10910
11301
|
* The event timestamp.
|
@@ -12397,6 +12788,9 @@ declare namespace SystemEvents {
|
|
12397
12788
|
*/
|
12398
12789
|
declare type SystemEventType = SystemEvent['type'];
|
12399
12790
|
|
12791
|
+
/**
|
12792
|
+
* @interface
|
12793
|
+
*/
|
12400
12794
|
declare type SystemPermissions = {
|
12401
12795
|
getAllExternalWindows: boolean;
|
12402
12796
|
launchExternalProcess: boolean | {
|
@@ -12424,6 +12818,9 @@ declare type SystemPermissions = {
|
|
12424
12818
|
};
|
12425
12819
|
};
|
12426
12820
|
|
12821
|
+
/**
|
12822
|
+
* @interface
|
12823
|
+
*/
|
12427
12824
|
declare type SystemProcessInfo = {
|
12428
12825
|
apps: AppProcessInfo[];
|
12429
12826
|
browserProcess: NonAppProcessDetails;
|
@@ -12652,6 +13049,9 @@ declare type TaskBar = DipScaleRects & {
|
|
12652
13049
|
rect: RectangleByEdgePositions;
|
12653
13050
|
};
|
12654
13051
|
|
13052
|
+
/**
|
13053
|
+
* @interface
|
13054
|
+
*/
|
12655
13055
|
declare type TerminateExternalRequestType = {
|
12656
13056
|
/**
|
12657
13057
|
* The uuid of the running application.
|
@@ -12667,6 +13067,9 @@ declare type TerminateExternalRequestType = {
|
|
12667
13067
|
killTree: boolean;
|
12668
13068
|
};
|
12669
13069
|
|
13070
|
+
/**
|
13071
|
+
* @interface
|
13072
|
+
*/
|
12670
13073
|
declare type Time = {
|
12671
13074
|
/**
|
12672
13075
|
* The number of milliseconds the CPU has spent in user mode.
|
@@ -12690,6 +13093,9 @@ declare type Time = {
|
|
12690
13093
|
irq: number;
|
12691
13094
|
};
|
12692
13095
|
|
13096
|
+
/**
|
13097
|
+
* @interface
|
13098
|
+
*/
|
12693
13099
|
declare type Transition = {
|
12694
13100
|
opacity?: Opacity;
|
12695
13101
|
position?: Position;
|
@@ -12698,6 +13104,8 @@ declare type Transition = {
|
|
12698
13104
|
|
12699
13105
|
/**
|
12700
13106
|
* Base configuration options needed for all types of transitions.
|
13107
|
+
*
|
13108
|
+
* @interface
|
12701
13109
|
*/
|
12702
13110
|
declare type TransitionBase = {
|
12703
13111
|
/**
|
@@ -12714,6 +13122,8 @@ declare type TransitionBase = {
|
|
12714
13122
|
|
12715
13123
|
/**
|
12716
13124
|
* Configuration for transition between windows.
|
13125
|
+
*
|
13126
|
+
* @interface
|
12717
13127
|
*/
|
12718
13128
|
declare type TransitionOptions = {
|
12719
13129
|
/**
|
@@ -12729,7 +13139,7 @@ declare type TransitionOptions = {
|
|
12729
13139
|
tween?: tween;
|
12730
13140
|
};
|
12731
13141
|
|
12732
|
-
declare class Transport<MeType extends
|
13142
|
+
declare class Transport<MeType extends EntityType_2 = EntityType_2> extends EventEmitter {
|
12733
13143
|
#private;
|
12734
13144
|
protected wireListeners: Map<number, {
|
12735
13145
|
resolve: Function;
|
@@ -12774,6 +13184,9 @@ declare type TrayIconClickedEvent = IdentityEvent & {
|
|
12774
13184
|
monitorInfo: any;
|
12775
13185
|
};
|
12776
13186
|
|
13187
|
+
/**
|
13188
|
+
* @interface
|
13189
|
+
*/
|
12777
13190
|
declare type TrayInfo = {
|
12778
13191
|
/**
|
12779
13192
|
* The bound of tray icon in virtual screen pixels.
|
@@ -12823,9 +13236,14 @@ declare type UnregisteredEvent = BaseEvent & {
|
|
12823
13236
|
|
12824
13237
|
/**
|
12825
13238
|
* View options that can be updated after creation.
|
13239
|
+
*
|
13240
|
+
* @interface
|
12826
13241
|
*/
|
12827
13242
|
declare type UpdatableViewOptions = Partial<MutableViewOptions>;
|
12828
13243
|
|
13244
|
+
/**
|
13245
|
+
* @interface
|
13246
|
+
*/
|
12829
13247
|
declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
|
12830
13248
|
|
12831
13249
|
/**
|
@@ -13492,6 +13910,9 @@ declare namespace ViewEvents {
|
|
13492
13910
|
*/
|
13493
13911
|
declare type ViewEventType = ViewEvent['type'];
|
13494
13912
|
|
13913
|
+
/**
|
13914
|
+
* @interface
|
13915
|
+
*/
|
13495
13916
|
declare type ViewInfo = {
|
13496
13917
|
canNavigateBack: boolean;
|
13497
13918
|
canNavigateForward: boolean;
|
@@ -13626,6 +14047,7 @@ declare class ViewOverlay {
|
|
13626
14047
|
|
13627
14048
|
/**
|
13628
14049
|
* Represents the payload shape for Views that are trying to prevent an unload.
|
14050
|
+
* @interface
|
13629
14051
|
*/
|
13630
14052
|
declare interface ViewsPreventingUnloadPayload {
|
13631
14053
|
/**
|
@@ -13661,6 +14083,8 @@ declare type ViewState = ViewCreationOptions & {
|
|
13661
14083
|
};
|
13662
14084
|
|
13663
14085
|
/**
|
14086
|
+
* @interface
|
14087
|
+
*
|
13664
14088
|
* The statuses of views specifying which of them are trying to prevent an unload and which are not.
|
13665
14089
|
*/
|
13666
14090
|
declare interface ViewStatuses {
|
@@ -13676,6 +14100,8 @@ declare interface ViewStatuses {
|
|
13676
14100
|
|
13677
14101
|
/**
|
13678
14102
|
* Configuration for view visibility settings
|
14103
|
+
*
|
14104
|
+
* @interface
|
13679
14105
|
*/
|
13680
14106
|
declare type ViewVisibilityOption = {
|
13681
14107
|
enabled?: boolean;
|
@@ -13683,6 +14109,8 @@ declare type ViewVisibilityOption = {
|
|
13683
14109
|
|
13684
14110
|
/**
|
13685
14111
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
14112
|
+
*
|
14113
|
+
* @interface
|
13686
14114
|
*/
|
13687
14115
|
declare type ViewVisibilityOptions = {
|
13688
14116
|
/**
|
@@ -16265,6 +16693,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16265
16693
|
|
16266
16694
|
declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
16267
16695
|
|
16696
|
+
/**
|
16697
|
+
* @interface
|
16698
|
+
*/
|
16268
16699
|
declare type WindowDetail = {
|
16269
16700
|
/**
|
16270
16701
|
* The bottom-most coordinate of the window.
|
@@ -16395,6 +16826,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16395
16826
|
type: 'hotkey';
|
16396
16827
|
};
|
16397
16828
|
|
16829
|
+
/**
|
16830
|
+
* @interface
|
16831
|
+
*/
|
16398
16832
|
declare type WindowInfo = {
|
16399
16833
|
canNavigateBack: boolean;
|
16400
16834
|
canNavigateForward: boolean;
|
@@ -16510,6 +16944,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16510
16944
|
type: 'window-not-responding';
|
16511
16945
|
};
|
16512
16946
|
|
16947
|
+
/**
|
16948
|
+
* @interface
|
16949
|
+
*/
|
16513
16950
|
declare type WindowOptionDiff = {
|
16514
16951
|
[key in keyof WindowOptions]: {
|
16515
16952
|
oldVal: WindowOptions[key];
|
@@ -16583,6 +17020,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16583
17020
|
*/
|
16584
17021
|
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
16585
17022
|
|
17023
|
+
/**
|
17024
|
+
* @interface
|
17025
|
+
*/
|
16586
17026
|
declare type WindowViewsPrintOptions = {
|
16587
17027
|
content: 'views';
|
16588
17028
|
includeSelf?: boolean;
|
@@ -16612,10 +17052,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16612
17052
|
positioningOptions?: OpenFin.PositioningOptions;
|
16613
17053
|
};
|
16614
17054
|
|
16615
|
-
|
16616
|
-
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
16617
|
-
[key: string]: any;
|
16618
|
-
};
|
17055
|
+
/* Excluded from this release type: WorkspacePlatformOptions */
|
16619
17056
|
|
16620
17057
|
/**
|
16621
17058
|
* A generic request to write any supported data to the clipboard.
|
@@ -16633,6 +17070,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16633
17070
|
* @deprecated - instead use WriteAnyClipboardRequest
|
16634
17071
|
*
|
16635
17072
|
* A generic request to write any supported data to the clipboard.
|
17073
|
+
*
|
17074
|
+
* @interface
|
16636
17075
|
*/
|
16637
17076
|
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
16638
17077
|
|
@@ -16663,6 +17102,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16663
17102
|
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
16664
17103
|
*
|
16665
17104
|
* A request to write data to the clipboard.
|
17105
|
+
*
|
17106
|
+
* @interface
|
16666
17107
|
*/
|
16667
17108
|
declare type WriteRequestType = WriteClipboardRequest;
|
16668
17109
|
|