@openfin/node-adapter 34.78.11 → 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 +505 -49
- package/out/node-adapter-beta.d.ts +505 -49
- package/out/node-adapter-public.d.ts +505 -49
- package/out/node-adapter.d.ts +508 -45
- package/out/node-adapter.js +58 -551
- 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
|
@@ -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;
|
@@ -2301,6 +2373,8 @@ declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2301
2373
|
|
2302
2374
|
/**
|
2303
2375
|
* Channel provider creation options.
|
2376
|
+
*
|
2377
|
+
* @interface
|
2304
2378
|
*/
|
2305
2379
|
declare type ChannelCreateOptions = {
|
2306
2380
|
/**
|
@@ -2607,6 +2681,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
|
|
2607
2681
|
isValidEndpointPayload(payload: any): payload is EndpointPayload;
|
2608
2682
|
}
|
2609
2683
|
|
2684
|
+
/**
|
2685
|
+
* @interface
|
2686
|
+
*/
|
2610
2687
|
declare type ClearCacheOption = {
|
2611
2688
|
/**
|
2612
2689
|
* html5 application cache
|
@@ -2626,6 +2703,9 @@ declare type ClearCacheOption = {
|
|
2626
2703
|
localStorage?: boolean;
|
2627
2704
|
};
|
2628
2705
|
|
2706
|
+
/**
|
2707
|
+
* @interface
|
2708
|
+
*/
|
2629
2709
|
declare type ClickedMenuResult<T extends unknown = unknown> = {
|
2630
2710
|
result: 'clicked';
|
2631
2711
|
data: T;
|
@@ -2855,10 +2935,16 @@ declare type ClosedEvent = IdentityEvent & {
|
|
2855
2935
|
type: 'closed';
|
2856
2936
|
};
|
2857
2937
|
|
2938
|
+
/**
|
2939
|
+
* @interface
|
2940
|
+
*/
|
2858
2941
|
declare type ClosedMenuResult = {
|
2859
2942
|
result: 'closed';
|
2860
2943
|
};
|
2861
2944
|
|
2945
|
+
/**
|
2946
|
+
* @interface
|
2947
|
+
*/
|
2862
2948
|
declare type CloseViewPayload = {
|
2863
2949
|
/**
|
2864
2950
|
*View to be closed.
|
@@ -2867,6 +2953,8 @@ declare type CloseViewPayload = {
|
|
2867
2953
|
};
|
2868
2954
|
|
2869
2955
|
/**
|
2956
|
+
* @interface
|
2957
|
+
*
|
2870
2958
|
* Represents the shape of payload that contains the Window Identity and related options.
|
2871
2959
|
*/
|
2872
2960
|
declare interface CloseWindowPayload {
|
@@ -2949,6 +3037,8 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
|
2949
3037
|
|
2950
3038
|
/**
|
2951
3039
|
* View options that cannot be updated after creation.
|
3040
|
+
*
|
3041
|
+
* @interface
|
2952
3042
|
*/
|
2953
3043
|
declare type ConstViewOptions = {
|
2954
3044
|
/**
|
@@ -3016,6 +3106,8 @@ declare type ConstViewOptions = {
|
|
3016
3106
|
|
3017
3107
|
/**
|
3018
3108
|
* Window options that cannot be changed after creation.
|
3109
|
+
*
|
3110
|
+
* @interface
|
3019
3111
|
*/
|
3020
3112
|
declare type ConstWindowOptions = {
|
3021
3113
|
/**
|
@@ -3217,6 +3309,8 @@ declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'brows
|
|
3217
3309
|
|
3218
3310
|
/**
|
3219
3311
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
3312
|
+
*
|
3313
|
+
* @interface
|
3220
3314
|
*/
|
3221
3315
|
declare type ContentCreationOptions = {
|
3222
3316
|
/**
|
@@ -3232,6 +3326,8 @@ declare type ContentCreationOptions = {
|
|
3232
3326
|
* @property { string } behavior 'view' | 'window' | 'browser' | 'block'
|
3233
3327
|
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
3234
3328
|
* @property { object } options Window creation options or View creation options.
|
3329
|
+
*
|
3330
|
+
* @interface
|
3235
3331
|
*/
|
3236
3332
|
declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
3237
3333
|
/**
|
@@ -3284,6 +3380,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
3284
3380
|
* Restrict navigation to URLs that match an allowed pattern.
|
3285
3381
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
3286
3382
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
3383
|
+
*
|
3384
|
+
* @interface
|
3287
3385
|
*/
|
3288
3386
|
declare type ContentNavigation = NavigationRules;
|
3289
3387
|
|
@@ -3291,11 +3389,15 @@ declare type ContentNavigation = NavigationRules;
|
|
3291
3389
|
* Restrict redirects to URLs that match an allowed pattern.
|
3292
3390
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
3293
3391
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
3392
|
+
*
|
3393
|
+
* @interface
|
3294
3394
|
*/
|
3295
3395
|
declare type ContentRedirect = NavigationRules;
|
3296
3396
|
|
3297
3397
|
/**
|
3298
3398
|
* Data passed between entities and applications.
|
3399
|
+
*
|
3400
|
+
* @interface
|
3299
3401
|
*/
|
3300
3402
|
declare type Context = {
|
3301
3403
|
/**
|
@@ -3321,6 +3423,9 @@ declare type ContextForIntent<MetadataType = any> = Context & {
|
|
3321
3423
|
metadata?: MetadataType;
|
3322
3424
|
};
|
3323
3425
|
|
3426
|
+
/**
|
3427
|
+
* @interface
|
3428
|
+
*/
|
3324
3429
|
declare type ContextGroupInfo = {
|
3325
3430
|
/**
|
3326
3431
|
* Unique identifier of the context group.
|
@@ -3342,6 +3447,8 @@ declare type ContextHandler = (context: Context) => void;
|
|
3342
3447
|
|
3343
3448
|
/**
|
3344
3449
|
* Configure the context menu when right-clicking on a window.
|
3450
|
+
*
|
3451
|
+
* @interface
|
3345
3452
|
*/
|
3346
3453
|
declare type ContextMenuOptions = {
|
3347
3454
|
/**
|
@@ -3357,6 +3464,8 @@ declare type ContextMenuOptions = {
|
|
3357
3464
|
/**
|
3358
3465
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
3359
3466
|
* Configure the context menu when right-clicking on a window.
|
3467
|
+
*
|
3468
|
+
* @interface
|
3360
3469
|
*/
|
3361
3470
|
declare type ContextMenuSettings = {
|
3362
3471
|
/**
|
@@ -3373,12 +3482,18 @@ declare type ContextMenuSettings = {
|
|
3373
3482
|
reload?: boolean;
|
3374
3483
|
};
|
3375
3484
|
|
3485
|
+
/**
|
3486
|
+
* @interface
|
3487
|
+
*/
|
3376
3488
|
declare type CookieInfo = {
|
3377
3489
|
name: string;
|
3378
3490
|
domain: string;
|
3379
3491
|
path: string;
|
3380
3492
|
};
|
3381
3493
|
|
3494
|
+
/**
|
3495
|
+
* @interface
|
3496
|
+
*/
|
3382
3497
|
declare type CookieOption = {
|
3383
3498
|
name: string;
|
3384
3499
|
};
|
@@ -3386,6 +3501,8 @@ declare type CookieOption = {
|
|
3386
3501
|
/**
|
3387
3502
|
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
3388
3503
|
* average of _height_ and _width_.
|
3504
|
+
*
|
3505
|
+
* @interface
|
3389
3506
|
*/
|
3390
3507
|
declare type CornerRounding = {
|
3391
3508
|
/**
|
@@ -3402,6 +3519,9 @@ declare type CornerRounding = {
|
|
3402
3519
|
width: number;
|
3403
3520
|
};
|
3404
3521
|
|
3522
|
+
/**
|
3523
|
+
* @interface
|
3524
|
+
*/
|
3405
3525
|
declare type CpuInfo = {
|
3406
3526
|
/**
|
3407
3527
|
* The model of the cpu
|
@@ -3431,6 +3551,9 @@ declare type CrashedEvent = NamedEvent & {
|
|
3431
3551
|
};
|
3432
3552
|
};
|
3433
3553
|
|
3554
|
+
/**
|
3555
|
+
* @interface
|
3556
|
+
*/
|
3434
3557
|
declare type CrashReporterOptions = {
|
3435
3558
|
/**
|
3436
3559
|
* In diagnostics mode the crash reporter will send diagnostic logs to
|
@@ -3458,6 +3581,9 @@ declare type CreatedEvent = BaseViewEvent & {
|
|
3458
3581
|
type: 'created';
|
3459
3582
|
};
|
3460
3583
|
|
3584
|
+
/**
|
3585
|
+
* @interface
|
3586
|
+
*/
|
3461
3587
|
declare type CreateViewPayload = {
|
3462
3588
|
/**
|
3463
3589
|
* Options for the view to be added.
|
@@ -3486,6 +3612,8 @@ declare type CreateViewTarget = Identity_5 & {
|
|
3486
3612
|
|
3487
3613
|
/**
|
3488
3614
|
* Custom headers for requests sent by the window.
|
3615
|
+
*
|
3616
|
+
* @interface
|
3489
3617
|
*/
|
3490
3618
|
declare type CustomRequestHeaders = {
|
3491
3619
|
/**
|
@@ -3499,10 +3627,16 @@ declare type CustomRequestHeaders = {
|
|
3499
3627
|
headers: WebRequestHeader[];
|
3500
3628
|
};
|
3501
3629
|
|
3630
|
+
/**
|
3631
|
+
* @interface
|
3632
|
+
*/
|
3502
3633
|
declare type DefaultDomainSettings = {
|
3503
3634
|
rules: DefaultDomainSettingsRule[];
|
3504
3635
|
};
|
3505
3636
|
|
3637
|
+
/**
|
3638
|
+
* @interface
|
3639
|
+
*/
|
3506
3640
|
declare type DefaultDomainSettingsRule = {
|
3507
3641
|
match: string[];
|
3508
3642
|
options: {
|
@@ -3558,6 +3692,9 @@ declare type DipRect = RectangleByEdgePositions & {
|
|
3558
3692
|
scaledRect: RectangleByEdgePositions;
|
3559
3693
|
};
|
3560
3694
|
|
3695
|
+
/**
|
3696
|
+
* @interface
|
3697
|
+
*/
|
3561
3698
|
declare type DipScaleRects = {
|
3562
3699
|
dipRect: RectangleByEdgePositions;
|
3563
3700
|
scaledRect: RectangleByEdgePositions;
|
@@ -3581,6 +3718,8 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
3581
3718
|
|
3582
3719
|
/**
|
3583
3720
|
* The display data for a context group.
|
3721
|
+
*
|
3722
|
+
* @interface
|
3584
3723
|
*/
|
3585
3724
|
declare type DisplayMetadata = {
|
3586
3725
|
/**
|
@@ -3599,6 +3738,8 @@ declare type DisplayMetadata = {
|
|
3599
3738
|
|
3600
3739
|
/**
|
3601
3740
|
* Metadata returned from a preload script download request.
|
3741
|
+
*
|
3742
|
+
* @interface
|
3602
3743
|
*/
|
3603
3744
|
declare type DownloadPreloadInfo = {
|
3604
3745
|
/**
|
@@ -3617,6 +3758,8 @@ declare type DownloadPreloadInfo = {
|
|
3617
3758
|
|
3618
3759
|
/**
|
3619
3760
|
* Options for downloading a preload script.
|
3761
|
+
*
|
3762
|
+
* @interface
|
3620
3763
|
*/
|
3621
3764
|
declare type DownloadPreloadOption = {
|
3622
3765
|
/**
|
@@ -3625,6 +3768,9 @@ declare type DownloadPreloadOption = {
|
|
3625
3768
|
url: string;
|
3626
3769
|
};
|
3627
3770
|
|
3771
|
+
/**
|
3772
|
+
* @interface
|
3773
|
+
*/
|
3628
3774
|
declare type DownloadRule = {
|
3629
3775
|
behavior: FileDownloadBehaviorNames;
|
3630
3776
|
match: string[];
|
@@ -3632,6 +3778,8 @@ declare type DownloadRule = {
|
|
3632
3778
|
|
3633
3779
|
/**
|
3634
3780
|
* DPI (dots per inch) configuration for printing.
|
3781
|
+
*
|
3782
|
+
* @interface
|
3635
3783
|
*/
|
3636
3784
|
declare type Dpi = {
|
3637
3785
|
/**
|
@@ -3694,53 +3842,35 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
3694
3842
|
protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
|
3695
3843
|
/**
|
3696
3844
|
* Adds a listener to the end of the listeners array for the specified event.
|
3697
|
-
*
|
3698
|
-
* @param eventType
|
3699
|
-
* @param listener
|
3700
|
-
* @param options
|
3701
3845
|
*/
|
3702
3846
|
on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3703
|
-
|
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>;
|
3704
3851
|
/**
|
3705
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.
|
3706
|
-
*
|
3707
|
-
* @param eventType
|
3708
|
-
* @param listener
|
3709
|
-
* @param options
|
3710
3853
|
*/
|
3711
3854
|
once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3712
3855
|
/**
|
3713
3856
|
* Adds a listener to the beginning of the listeners array for the specified event.
|
3714
|
-
*
|
3715
|
-
* @param eventType
|
3716
|
-
* @param listener
|
3717
|
-
* @param options
|
3718
3857
|
*/
|
3719
3858
|
prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3720
3859
|
/**
|
3721
3860
|
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
|
3722
3861
|
* after which it is removed. The listener is added to the beginning of the listeners array.
|
3723
|
-
*
|
3724
|
-
* @param eventType
|
3725
|
-
* @param listener
|
3726
|
-
* @param options
|
3727
3862
|
*/
|
3728
3863
|
prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3729
3864
|
/**
|
3730
3865
|
* Remove a listener from the listener array for the specified event.
|
3731
3866
|
*
|
3732
3867
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
3733
|
-
*
|
3734
|
-
* @param eventType
|
3735
|
-
* @param listener
|
3736
|
-
* @param options
|
3737
3868
|
*/
|
3738
3869
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
3739
3870
|
protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
|
3740
3871
|
/**
|
3741
3872
|
* Removes all listeners, or those of the specified event.
|
3742
3873
|
*
|
3743
|
-
* @param eventType
|
3744
3874
|
*/
|
3745
3875
|
removeAllListeners(eventType?: EmitterEventType): Promise<this>;
|
3746
3876
|
private deleteEmitterIfNothingRegistered;
|
@@ -3783,6 +3913,9 @@ declare type Entity = OpenFin.ApplicationType;
|
|
3783
3913
|
|
3784
3914
|
declare type EntityInfo = OpenFin.EntityInfo;
|
3785
3915
|
|
3916
|
+
/**
|
3917
|
+
* @interface
|
3918
|
+
*/
|
3786
3919
|
declare type EntityInfo_2 = {
|
3787
3920
|
uuid: string;
|
3788
3921
|
name: string;
|
@@ -3894,6 +4027,9 @@ declare type ExistingConnectConfig = ConfigWithUuid & {
|
|
3894
4027
|
address: string;
|
3895
4028
|
};
|
3896
4029
|
|
4030
|
+
/**
|
4031
|
+
* @interface
|
4032
|
+
*/
|
3897
4033
|
declare type ExitCode = {
|
3898
4034
|
topic: string;
|
3899
4035
|
uuid: string;
|
@@ -4040,6 +4176,9 @@ declare namespace ExternalApplicationEvents {
|
|
4040
4176
|
}
|
4041
4177
|
}
|
4042
4178
|
|
4179
|
+
/**
|
4180
|
+
* @interface
|
4181
|
+
*/
|
4043
4182
|
declare type ExternalApplicationInfo = {
|
4044
4183
|
parent: Identity_5;
|
4045
4184
|
};
|
@@ -4082,6 +4221,9 @@ declare type ExternalConfig = BaseConfig & {
|
|
4082
4221
|
manifestUrl: string;
|
4083
4222
|
};
|
4084
4223
|
|
4224
|
+
/**
|
4225
|
+
* @interface
|
4226
|
+
*/
|
4085
4227
|
declare type ExternalConnection = {
|
4086
4228
|
/**
|
4087
4229
|
* The token to broker an external connection.
|
@@ -4103,11 +4245,17 @@ declare type ExternalProcessExitedEvent = NamedEvent & {
|
|
4103
4245
|
exitCode: number;
|
4104
4246
|
};
|
4105
4247
|
|
4248
|
+
/**
|
4249
|
+
* @interface
|
4250
|
+
*/
|
4106
4251
|
declare type ExternalProcessInfo = {
|
4107
4252
|
pid: number;
|
4108
4253
|
listener?: LaunchExternalProcessListener;
|
4109
4254
|
};
|
4110
4255
|
|
4256
|
+
/**
|
4257
|
+
* @interface
|
4258
|
+
*/
|
4111
4259
|
declare type ExternalProcessRequestType = {
|
4112
4260
|
/**
|
4113
4261
|
* The file path to where the running application resides.
|
@@ -4150,6 +4298,9 @@ declare type FaviconUpdatedEvent = NamedEvent & {
|
|
4150
4298
|
favicons: string[];
|
4151
4299
|
};
|
4152
4300
|
|
4301
|
+
/**
|
4302
|
+
* @interface
|
4303
|
+
*/
|
4153
4304
|
declare type FetchManifestPayload = {
|
4154
4305
|
/**
|
4155
4306
|
* The URL of the manifest to fetch.
|
@@ -4238,6 +4389,9 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
4238
4389
|
state: 'progressing' | 'interrupted';
|
4239
4390
|
};
|
4240
4391
|
|
4392
|
+
/**
|
4393
|
+
* @interface
|
4394
|
+
*/
|
4241
4395
|
declare type FileDownloadSettings = {
|
4242
4396
|
rules: DownloadRule[];
|
4243
4397
|
};
|
@@ -4276,6 +4430,8 @@ declare interface FinApi<MeType extends EntityType> {
|
|
4276
4430
|
|
4277
4431
|
/**
|
4278
4432
|
* Configuration for find-in-page requests.
|
4433
|
+
*
|
4434
|
+
* @interface
|
4279
4435
|
*/
|
4280
4436
|
declare type FindInPageOptions = {
|
4281
4437
|
/**
|
@@ -4311,6 +4467,9 @@ declare type FindInPageOptions = {
|
|
4311
4467
|
medialCapitalAsWordStart?: boolean;
|
4312
4468
|
};
|
4313
4469
|
|
4470
|
+
/**
|
4471
|
+
* @interface
|
4472
|
+
*/
|
4314
4473
|
declare type FindInPageResult = {
|
4315
4474
|
requestId: number;
|
4316
4475
|
/**
|
@@ -4328,6 +4487,9 @@ declare type FindInPageResult = {
|
|
4328
4487
|
finalUpdate: boolean;
|
4329
4488
|
};
|
4330
4489
|
|
4490
|
+
/**
|
4491
|
+
* @interface
|
4492
|
+
*/
|
4331
4493
|
declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
4332
4494
|
context: Context;
|
4333
4495
|
metadata?: MetadataType;
|
@@ -4522,6 +4684,9 @@ declare namespace FrameEvents {
|
|
4522
4684
|
*/
|
4523
4685
|
declare type FrameEventType = FrameEvent['type'];
|
4524
4686
|
|
4687
|
+
/**
|
4688
|
+
* @interface
|
4689
|
+
*/
|
4525
4690
|
declare type FrameInfo = {
|
4526
4691
|
name: string;
|
4527
4692
|
uuid: string;
|
@@ -4598,6 +4763,9 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
4598
4763
|
|
4599
4764
|
declare type GetLogRequestType = OpenFin.GetLogRequestType;
|
4600
4765
|
|
4766
|
+
/**
|
4767
|
+
* @interface
|
4768
|
+
*/
|
4601
4769
|
declare type GetLogRequestType_2 = {
|
4602
4770
|
/**
|
4603
4771
|
* The name of the running application
|
@@ -4615,6 +4783,9 @@ declare type GetLogRequestType_2 = {
|
|
4615
4783
|
|
4616
4784
|
declare type GetterCall<T> = ApiCall<void, T>;
|
4617
4785
|
|
4786
|
+
/**
|
4787
|
+
* @interface
|
4788
|
+
*/
|
4618
4789
|
declare type GetWindowContextPayload = {
|
4619
4790
|
/**
|
4620
4791
|
* Entity type of the target of the context update ('view' or 'window').
|
@@ -4747,6 +4918,9 @@ declare namespace GlobalHotkeyEvents {
|
|
4747
4918
|
}
|
4748
4919
|
}
|
4749
4920
|
|
4921
|
+
/**
|
4922
|
+
* @interface
|
4923
|
+
*/
|
4750
4924
|
declare type GpuInfo = {
|
4751
4925
|
name: string;
|
4752
4926
|
};
|
@@ -4759,6 +4933,9 @@ declare type HiddenEvent = BaseViewEvent & {
|
|
4759
4933
|
type: 'hidden';
|
4760
4934
|
};
|
4761
4935
|
|
4936
|
+
/**
|
4937
|
+
* @interface
|
4938
|
+
*/
|
4762
4939
|
declare type HostContextChangedPayload = {
|
4763
4940
|
/**
|
4764
4941
|
* The new context object
|
@@ -4772,6 +4949,9 @@ declare type HostContextChangedPayload = {
|
|
4772
4949
|
|
4773
4950
|
declare type HostContextChangedReasons = 'updated' | 'reparented';
|
4774
4951
|
|
4952
|
+
/**
|
4953
|
+
* @interface
|
4954
|
+
*/
|
4775
4955
|
declare type HostSpecs = {
|
4776
4956
|
/**
|
4777
4957
|
* True if Aero Glass theme is supported on Windows platforms
|
@@ -4805,6 +4985,8 @@ declare type HostSpecs = {
|
|
4805
4985
|
|
4806
4986
|
/**
|
4807
4987
|
* A hotkey binding.
|
4988
|
+
*
|
4989
|
+
* @interface
|
4808
4990
|
*/
|
4809
4991
|
declare type Hotkey = {
|
4810
4992
|
/**
|
@@ -4841,6 +5023,8 @@ declare type Identity_4 = OpenFin.Identity;
|
|
4841
5023
|
*
|
4842
5024
|
* @remarks The `uuid` property refers the application that owns the entity, not to the entity itself.
|
4843
5025
|
* The `name` property identifies the entity itself, and must be unique within the application.
|
5026
|
+
*
|
5027
|
+
* @interface
|
4844
5028
|
*/
|
4845
5029
|
declare type Identity_5 = {
|
4846
5030
|
/**
|
@@ -4888,6 +5072,9 @@ declare type ImageFormatOptions = {
|
|
4888
5072
|
quality?: number;
|
4889
5073
|
};
|
4890
5074
|
|
5075
|
+
/**
|
5076
|
+
* @interface
|
5077
|
+
*/
|
4891
5078
|
declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
4892
5079
|
/**
|
4893
5080
|
* Name of the intent to get info for.
|
@@ -4909,6 +5096,9 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
|
|
4909
5096
|
|
4910
5097
|
declare type InitLayoutOptions_2 = OpenFin.InitLayoutOptions;
|
4911
5098
|
|
5099
|
+
/**
|
5100
|
+
* @interface
|
5101
|
+
*/
|
4912
5102
|
declare type InitLayoutOptions_3 = {
|
4913
5103
|
/**
|
4914
5104
|
* The id attribute of the container where the window's Layout should be initialized. If not provided
|
@@ -4917,6 +5107,9 @@ declare type InitLayoutOptions_3 = {
|
|
4917
5107
|
containerId?: string;
|
4918
5108
|
};
|
4919
5109
|
|
5110
|
+
/**
|
5111
|
+
* @interface
|
5112
|
+
*/
|
4920
5113
|
declare type InitPlatformOptions = {
|
4921
5114
|
/**
|
4922
5115
|
* A callback function or an array of constructor callbacks that can be used to extend or replace default Provider behavior.
|
@@ -4944,12 +5137,18 @@ declare type InputEvent_2 = {
|
|
4944
5137
|
command?: string;
|
4945
5138
|
};
|
4946
5139
|
|
5140
|
+
/**
|
5141
|
+
* @interface
|
5142
|
+
*/
|
4947
5143
|
declare type InstallationInfo = {
|
4948
5144
|
cachedManifest: any;
|
4949
5145
|
};
|
4950
5146
|
|
4951
5147
|
declare type InstalledApps = OpenFin.InstalledApps;
|
4952
5148
|
|
5149
|
+
/**
|
5150
|
+
* @interface
|
5151
|
+
*/
|
4953
5152
|
declare type InstalledApps_2 = {
|
4954
5153
|
[key: string]: InstallationInfo;
|
4955
5154
|
};
|
@@ -4971,6 +5170,9 @@ declare type Intent<MetadataType = IntentMetadata> = {
|
|
4971
5170
|
|
4972
5171
|
declare type IntentHandler = (intent: Intent) => void;
|
4973
5172
|
|
5173
|
+
/**
|
5174
|
+
* @interface
|
5175
|
+
*/
|
4974
5176
|
declare type IntentMetadata<TargetType = any> = {
|
4975
5177
|
target?: TargetType;
|
4976
5178
|
resultType?: string;
|
@@ -5086,10 +5288,11 @@ declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
|
|
5086
5288
|
|
5087
5289
|
/**
|
5088
5290
|
* Define whether to enable interop action logging.
|
5291
|
+
*
|
5089
5292
|
*/
|
5090
|
-
declare
|
5293
|
+
declare type InteropActionLoggingOption = {
|
5091
5294
|
enabled: boolean;
|
5092
|
-
}
|
5295
|
+
};
|
5093
5296
|
|
5094
5297
|
/**
|
5095
5298
|
* {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
|
@@ -5755,12 +5958,18 @@ declare class InteropBroker extends Base {
|
|
5755
5958
|
isActionAuthorized(_action: string, _payload: any, _identity: OpenFin.ClientIdentity): Promise<boolean> | boolean;
|
5756
5959
|
}
|
5757
5960
|
|
5961
|
+
/**
|
5962
|
+
* @interface
|
5963
|
+
*/
|
5758
5964
|
declare type InteropBrokerDisconnectionEvent = {
|
5759
5965
|
type: string;
|
5760
5966
|
topic: string;
|
5761
5967
|
brokerName: string;
|
5762
5968
|
};
|
5763
5969
|
|
5970
|
+
/**
|
5971
|
+
* @interface
|
5972
|
+
*/
|
5764
5973
|
declare type InteropBrokerOptions = {
|
5765
5974
|
contextGroups?: ContextGroupInfo;
|
5766
5975
|
logging?: InteropLoggingOptions;
|
@@ -6263,8 +6472,14 @@ declare class InteropClient extends Base {
|
|
6263
6472
|
static ferryFdc3Call(interopClient: OpenFin.InteropClient, action: string, payload?: any): Promise<any>;
|
6264
6473
|
}
|
6265
6474
|
|
6475
|
+
/**
|
6476
|
+
* @interface
|
6477
|
+
*/
|
6266
6478
|
declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
|
6267
6479
|
|
6480
|
+
/**
|
6481
|
+
* @interface
|
6482
|
+
*/
|
6268
6483
|
declare type InteropConfig = {
|
6269
6484
|
/**
|
6270
6485
|
* Context Group for the client. (green, yellow, red, etc.).
|
@@ -6278,6 +6493,9 @@ declare type InteropConfig = {
|
|
6278
6493
|
|
6279
6494
|
declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
6280
6495
|
|
6496
|
+
/**
|
6497
|
+
* @interface
|
6498
|
+
*/
|
6281
6499
|
declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
6282
6500
|
|
6283
6501
|
/**
|
@@ -6332,6 +6550,9 @@ declare class InteropModule extends Base {
|
|
6332
6550
|
connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
|
6333
6551
|
}
|
6334
6552
|
|
6553
|
+
/**
|
6554
|
+
* @interface
|
6555
|
+
*/
|
6335
6556
|
declare type JumpListCategory = {
|
6336
6557
|
/**
|
6337
6558
|
* The display title for the category.
|
@@ -6348,10 +6569,16 @@ declare type JumpListCategory = {
|
|
6348
6569
|
|
6349
6570
|
declare type JumpListItem = JumpListTask | JumpListSeparator;
|
6350
6571
|
|
6572
|
+
/**
|
6573
|
+
* @interface
|
6574
|
+
*/
|
6351
6575
|
declare type JumpListSeparator = {
|
6352
6576
|
type: 'separator';
|
6353
6577
|
};
|
6354
6578
|
|
6579
|
+
/**
|
6580
|
+
* @interface
|
6581
|
+
*/
|
6355
6582
|
declare type JumpListTask = {
|
6356
6583
|
type: 'task';
|
6357
6584
|
/**
|
@@ -6445,15 +6672,19 @@ export declare function launch(config: ConnectConfig): Promise<number>;
|
|
6445
6672
|
*/
|
6446
6673
|
declare type LaunchEmitter = TypedEventEmitter<AppVersionEvent>;
|
6447
6674
|
|
6448
|
-
declare type LaunchExternalProcessListener =
|
6449
|
-
(code: ExitCode): void;
|
6450
|
-
};
|
6675
|
+
declare type LaunchExternalProcessListener = (code: ExitCode) => void;
|
6451
6676
|
|
6677
|
+
/**
|
6678
|
+
* @interface
|
6679
|
+
*/
|
6452
6680
|
declare type LaunchExternalProcessRule = {
|
6453
6681
|
behavior: 'allow' | 'block';
|
6454
6682
|
match: string[];
|
6455
6683
|
};
|
6456
6684
|
|
6685
|
+
/**
|
6686
|
+
* @interface
|
6687
|
+
*/
|
6457
6688
|
declare type LaunchIntoPlatformPayload = {
|
6458
6689
|
manifest: any;
|
6459
6690
|
};
|
@@ -6736,14 +6967,20 @@ declare class Layout extends Base {
|
|
6736
6967
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
6737
6968
|
}
|
6738
6969
|
|
6739
|
-
|
6970
|
+
/**
|
6971
|
+
* @interface
|
6972
|
+
*/
|
6973
|
+
declare type LayoutColumn = LayoutItemConfig & {
|
6740
6974
|
type: 'column';
|
6741
|
-
}
|
6975
|
+
};
|
6742
6976
|
|
6743
|
-
|
6977
|
+
/**
|
6978
|
+
* @interface
|
6979
|
+
*/
|
6980
|
+
declare type LayoutComponent = LayoutItemConfig & {
|
6744
6981
|
componentName: 'view';
|
6745
6982
|
componentState?: Partial<ViewCreationOptions>;
|
6746
|
-
}
|
6983
|
+
};
|
6747
6984
|
|
6748
6985
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
6749
6986
|
|
@@ -6761,6 +6998,9 @@ declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
|
|
6761
6998
|
|
6762
6999
|
/* Excluded from this release type: LayoutEntitiesController */
|
6763
7000
|
|
7001
|
+
/**
|
7002
|
+
* @interface
|
7003
|
+
*/
|
6764
7004
|
declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes = LayoutEntityTypes> = {
|
6765
7005
|
type: TLayoutEntityType;
|
6766
7006
|
entityId: string;
|
@@ -6783,6 +7023,8 @@ declare type LayoutInitializedEvent = NamedEvent & {
|
|
6783
7023
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
6784
7024
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
|
6785
7025
|
* {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
|
7026
|
+
*
|
7027
|
+
* @interface
|
6786
7028
|
*/
|
6787
7029
|
declare type LayoutItemConfig = {
|
6788
7030
|
/**
|
@@ -7003,6 +7245,9 @@ declare type LayoutModule_2 = OpenFin.Fin['Platform']['Layout'];
|
|
7003
7245
|
|
7004
7246
|
/* Excluded from this release type: LayoutNode */
|
7005
7247
|
|
7248
|
+
/**
|
7249
|
+
* @interface
|
7250
|
+
*/
|
7006
7251
|
declare type LayoutOptions = {
|
7007
7252
|
/**
|
7008
7253
|
* Represents a potential ways to customize behavior of your Layout
|
@@ -7083,6 +7328,9 @@ declare type LayoutOptions = {
|
|
7083
7328
|
|
7084
7329
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
7085
7330
|
|
7331
|
+
/**
|
7332
|
+
* @interface
|
7333
|
+
*/
|
7086
7334
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
7087
7335
|
|
7088
7336
|
/**
|
@@ -7096,10 +7344,16 @@ declare type LayoutReadyEvent = NamedEvent & {
|
|
7096
7344
|
})[];
|
7097
7345
|
};
|
7098
7346
|
|
7099
|
-
|
7347
|
+
/**
|
7348
|
+
* @interface
|
7349
|
+
*/
|
7350
|
+
declare type LayoutRow = LayoutItemConfig & {
|
7100
7351
|
type: 'row';
|
7101
|
-
}
|
7352
|
+
};
|
7102
7353
|
|
7354
|
+
/**
|
7355
|
+
* @interface
|
7356
|
+
*/
|
7103
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'>;
|
7104
7358
|
|
7105
7359
|
declare type Listener<T extends {
|
@@ -7108,6 +7362,9 @@ declare type Listener<T extends {
|
|
7108
7362
|
|
7109
7363
|
declare type LogInfo = OpenFin.LogInfo;
|
7110
7364
|
|
7365
|
+
/**
|
7366
|
+
* @interface
|
7367
|
+
*/
|
7111
7368
|
declare type LogInfo_2 = {
|
7112
7369
|
/**
|
7113
7370
|
* The filename of the log
|
@@ -7136,6 +7393,9 @@ declare type LogLevel = OpenFin.LogLevel;
|
|
7136
7393
|
*/
|
7137
7394
|
declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
7138
7395
|
|
7396
|
+
/**
|
7397
|
+
* @interface
|
7398
|
+
*/
|
7139
7399
|
declare type Manifest = {
|
7140
7400
|
appAssets?: {
|
7141
7401
|
alias: string;
|
@@ -7201,6 +7461,9 @@ declare type ManifestChangedEvent = IdentityEvent & {
|
|
7201
7461
|
type: 'manifest-changed';
|
7202
7462
|
};
|
7203
7463
|
|
7464
|
+
/**
|
7465
|
+
* @interface
|
7466
|
+
*/
|
7204
7467
|
declare type ManifestInfo = {
|
7205
7468
|
/**
|
7206
7469
|
* The uuid of the application.
|
@@ -7214,6 +7477,8 @@ declare type ManifestInfo = {
|
|
7214
7477
|
|
7215
7478
|
/**
|
7216
7479
|
* Margins configuration for printing.
|
7480
|
+
*
|
7481
|
+
* @interface
|
7217
7482
|
*/
|
7218
7483
|
declare type Margins = {
|
7219
7484
|
marginType?: 'default' | 'none' | 'printableArea' | 'custom';
|
@@ -7249,6 +7514,9 @@ declare type Me<MeType extends EntityType_3> = OpenFin.EntityInfo & (MeType exte
|
|
7249
7514
|
isOpenFin: boolean;
|
7250
7515
|
};
|
7251
7516
|
|
7517
|
+
/**
|
7518
|
+
* @interface
|
7519
|
+
*/
|
7252
7520
|
declare type MenuItemTemplate<T extends unknown = unknown> = {
|
7253
7521
|
/**
|
7254
7522
|
* Can be `normal`, `separator`, `submenu`, or `checkbox`.
|
@@ -7318,6 +7586,9 @@ declare type MinimizedEvent = NamedEvent & {
|
|
7318
7586
|
type: 'minimized';
|
7319
7587
|
};
|
7320
7588
|
|
7589
|
+
/**
|
7590
|
+
* @interface
|
7591
|
+
*/
|
7321
7592
|
declare type MonitorDetails = {
|
7322
7593
|
/**
|
7323
7594
|
* The available DIP scale coordinates.
|
@@ -7364,6 +7635,9 @@ declare type MonitorEvent = OpenFin.MonitorInfo & {
|
|
7364
7635
|
type: 'monitor-info-changed';
|
7365
7636
|
};
|
7366
7637
|
|
7638
|
+
/**
|
7639
|
+
* @interface
|
7640
|
+
*/
|
7367
7641
|
declare type MonitorInfo = {
|
7368
7642
|
/**
|
7369
7643
|
* The device scale factor.
|
@@ -7383,6 +7657,9 @@ declare type MonitorInfo = {
|
|
7383
7657
|
virtualScreen: DipRect;
|
7384
7658
|
};
|
7385
7659
|
|
7660
|
+
/**
|
7661
|
+
* @interface
|
7662
|
+
*/
|
7386
7663
|
declare type MutableViewOptions = {
|
7387
7664
|
autoResize: AutoResizeOptions;
|
7388
7665
|
/**
|
@@ -7464,6 +7741,8 @@ declare type MutableViewOptions = {
|
|
7464
7741
|
|
7465
7742
|
/**
|
7466
7743
|
* Window options that can be changed after window creation.
|
7744
|
+
*
|
7745
|
+
* @interface
|
7467
7746
|
*/
|
7468
7747
|
declare type MutableWindowOptions = {
|
7469
7748
|
/**
|
@@ -7712,6 +7991,9 @@ declare type NamedEvent = IdentityEvent & {
|
|
7712
7991
|
name: string;
|
7713
7992
|
};
|
7714
7993
|
|
7994
|
+
/**
|
7995
|
+
* @interface
|
7996
|
+
*/
|
7715
7997
|
declare type NativeWindowIntegrationProviderAuthorization = {
|
7716
7998
|
authorizedUuid: string;
|
7717
7999
|
};
|
@@ -7726,6 +8008,9 @@ declare type NavigationRejectedEvent = NamedEvent & {
|
|
7726
8008
|
url: string;
|
7727
8009
|
};
|
7728
8010
|
|
8011
|
+
/**
|
8012
|
+
* @interface
|
8013
|
+
*/
|
7729
8014
|
declare type NavigationRules = {
|
7730
8015
|
/** @deprecated Use allowlist property instead. */
|
7731
8016
|
whitelist?: string[];
|
@@ -8136,6 +8421,9 @@ declare type PerformanceReportEvent = Performance & NamedEvent & {
|
|
8136
8421
|
type: 'performance-report';
|
8137
8422
|
};
|
8138
8423
|
|
8424
|
+
/**
|
8425
|
+
* @interface
|
8426
|
+
*/
|
8139
8427
|
declare type Permissions_2 = {
|
8140
8428
|
Application?: Partial<ApplicationPermissions>;
|
8141
8429
|
System?: Partial<SystemPermissions>;
|
@@ -9467,6 +9755,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
|
|
9467
9755
|
type: 'platform-snapshot-applied';
|
9468
9756
|
};
|
9469
9757
|
|
9758
|
+
/**
|
9759
|
+
* @interface
|
9760
|
+
*/
|
9470
9761
|
declare type PlatformViewCreationOptions = Partial<ViewOptions>;
|
9471
9762
|
|
9472
9763
|
/**
|
@@ -9493,6 +9784,9 @@ declare type PlatformWindowOptions = WindowCreationOptions & {
|
|
9493
9784
|
stylesheetUrl: string;
|
9494
9785
|
};
|
9495
9786
|
|
9787
|
+
/**
|
9788
|
+
* @interface
|
9789
|
+
*/
|
9496
9790
|
declare type Point = {
|
9497
9791
|
/**
|
9498
9792
|
* The mouse x position
|
@@ -9504,6 +9798,9 @@ declare type Point = {
|
|
9504
9798
|
y: number;
|
9505
9799
|
};
|
9506
9800
|
|
9801
|
+
/**
|
9802
|
+
* @interface
|
9803
|
+
*/
|
9507
9804
|
declare type PointTopLeft = {
|
9508
9805
|
/**
|
9509
9806
|
* The mouse top position in virtual screen coordinates
|
@@ -9523,8 +9820,10 @@ declare type PopupInteraction = 'clicked' | 'dismissed';
|
|
9523
9820
|
|
9524
9821
|
/**
|
9525
9822
|
* Popup window options.
|
9823
|
+
*
|
9824
|
+
* @interface
|
9526
9825
|
*/
|
9527
|
-
declare
|
9826
|
+
declare type PopupOptions = {
|
9528
9827
|
/**
|
9529
9828
|
* Window creation options when using `showPopupWindow` to create a new window.
|
9530
9829
|
*/
|
@@ -9598,14 +9897,15 @@ declare interface PopupOptions {
|
|
9598
9897
|
* <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
|
9599
9898
|
*/
|
9600
9899
|
onPopupResult?: (payload: PopupResult) => any;
|
9601
|
-
}
|
9900
|
+
};
|
9602
9901
|
|
9603
9902
|
/**
|
9604
9903
|
* The Popup result.
|
9605
9904
|
*
|
9606
9905
|
* @typeParam T - Type of data the Popup result contains
|
9906
|
+
* @interface
|
9607
9907
|
*/
|
9608
|
-
declare
|
9908
|
+
declare type PopupResult<T = any> = {
|
9609
9909
|
/**
|
9610
9910
|
* `name` and `uuid` of the popup window that called dispatched this result.
|
9611
9911
|
*/
|
@@ -9625,7 +9925,7 @@ declare interface PopupResult<T = any> {
|
|
9625
9925
|
* The last dispatch result.
|
9626
9926
|
*/
|
9627
9927
|
lastDispatchResult?: PopupResult;
|
9628
|
-
}
|
9928
|
+
};
|
9629
9929
|
|
9630
9930
|
declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
|
9631
9931
|
|
@@ -9654,14 +9954,17 @@ declare type Position = TransitionBase & {
|
|
9654
9954
|
fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
|
9655
9955
|
```
|
9656
9956
|
*/
|
9657
|
-
|
9957
|
+
/**
|
9958
|
+
* @interface
|
9959
|
+
*/
|
9960
|
+
declare type PositioningOptions = {
|
9658
9961
|
/**
|
9659
9962
|
* Windows Only.
|
9660
9963
|
* If set to true, will not restore a maximized window before setting the bounds.
|
9661
9964
|
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
9662
9965
|
*/
|
9663
9966
|
skipRestore?: boolean;
|
9664
|
-
}
|
9967
|
+
};
|
9665
9968
|
|
9666
9969
|
/**
|
9667
9970
|
* Context menu item with an implementation provided by OpenFin.
|
@@ -9670,6 +9973,8 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
9670
9973
|
|
9671
9974
|
/**
|
9672
9975
|
* A script that is run before page load.
|
9976
|
+
*
|
9977
|
+
* @interface
|
9673
9978
|
*/
|
9674
9979
|
declare type PreloadScript = {
|
9675
9980
|
/**
|
@@ -9730,6 +10035,9 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
|
|
9730
10035
|
|
9731
10036
|
declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
9732
10037
|
|
10038
|
+
/**
|
10039
|
+
* @interface
|
10040
|
+
*/
|
9733
10041
|
declare type PresetLayoutOptions_2 = {
|
9734
10042
|
/**
|
9735
10043
|
* Which preset layout arrangement to use.
|
@@ -9740,6 +10048,9 @@ declare type PresetLayoutOptions_2 = {
|
|
9740
10048
|
|
9741
10049
|
declare type PrinterInfo = OpenFin.PrinterInfo;
|
9742
10050
|
|
10051
|
+
/**
|
10052
|
+
* @interface
|
10053
|
+
*/
|
9743
10054
|
declare type PrinterInfo_2 = {
|
9744
10055
|
name: string;
|
9745
10056
|
description: string;
|
@@ -9749,6 +10060,8 @@ declare type PrinterInfo_2 = {
|
|
9749
10060
|
|
9750
10061
|
/**
|
9751
10062
|
* Options for printing a webpage in OpenFin.
|
10063
|
+
*
|
10064
|
+
* @interface
|
9752
10065
|
*/
|
9753
10066
|
declare type PrintOptions = {
|
9754
10067
|
content?: 'self';
|
@@ -9814,6 +10127,9 @@ declare type PrintOptions = {
|
|
9814
10127
|
*/
|
9815
10128
|
declare type ProcessAffinityStrategy = 'same' | 'different';
|
9816
10129
|
|
10130
|
+
/**
|
10131
|
+
* @interface
|
10132
|
+
*/
|
9817
10133
|
declare type ProcessDetails = {
|
9818
10134
|
/**
|
9819
10135
|
* The percentage of total CPU usage.
|
@@ -9861,8 +10177,10 @@ declare type ProcessDetails = {
|
|
9861
10177
|
|
9862
10178
|
/**
|
9863
10179
|
* Process logging options
|
10180
|
+
*
|
10181
|
+
* @interface
|
9864
10182
|
*/
|
9865
|
-
declare
|
10183
|
+
declare type ProcessLoggingOptions = {
|
9866
10184
|
/**
|
9867
10185
|
* Periodic Logging Interval (in seconds)
|
9868
10186
|
*/
|
@@ -9880,7 +10198,7 @@ declare interface ProcessLoggingOptions {
|
|
9880
10198
|
*/
|
9881
10199
|
entries?: number;
|
9882
10200
|
};
|
9883
|
-
}
|
10201
|
+
};
|
9884
10202
|
|
9885
10203
|
/**
|
9886
10204
|
* A propagated Application event.
|
@@ -10187,6 +10505,9 @@ declare type ProviderIdentity_7 = Identity_5 & {
|
|
10187
10505
|
|
10188
10506
|
declare type ProxyConfig = OpenFin.ProxyConfig;
|
10189
10507
|
|
10508
|
+
/**
|
10509
|
+
* @interface
|
10510
|
+
*/
|
10190
10511
|
declare type ProxyConfig_2 = {
|
10191
10512
|
/**
|
10192
10513
|
* The configured proxy address.
|
@@ -10201,11 +10522,17 @@ declare type ProxyConfig_2 = {
|
|
10201
10522
|
|
10202
10523
|
declare type ProxyInfo = OpenFin.ProxyInfo;
|
10203
10524
|
|
10525
|
+
/**
|
10526
|
+
* @interface
|
10527
|
+
*/
|
10204
10528
|
declare type ProxyInfo_2 = {
|
10205
10529
|
config: ProxyConfig_2;
|
10206
10530
|
system: ProxySystemInfo;
|
10207
10531
|
};
|
10208
10532
|
|
10533
|
+
/**
|
10534
|
+
* @interface
|
10535
|
+
*/
|
10209
10536
|
declare type ProxySystemInfo = {
|
10210
10537
|
/**
|
10211
10538
|
* The auto configuration url.
|
@@ -10225,6 +10552,9 @@ declare type ProxySystemInfo = {
|
|
10225
10552
|
proxy: string;
|
10226
10553
|
};
|
10227
10554
|
|
10555
|
+
/**
|
10556
|
+
* @interface
|
10557
|
+
*/
|
10228
10558
|
declare type QueryPermissionResult = {
|
10229
10559
|
/**
|
10230
10560
|
* The full name of a secured API.
|
@@ -10250,6 +10580,8 @@ declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptio
|
|
10250
10580
|
* A rectangular area on the screen.
|
10251
10581
|
*
|
10252
10582
|
* @remarks Origin is top-left. All numbers are in pixels.
|
10583
|
+
*
|
10584
|
+
* @interface
|
10253
10585
|
*/
|
10254
10586
|
declare type Rectangle = {
|
10255
10587
|
/**
|
@@ -10270,6 +10602,9 @@ declare type Rectangle = {
|
|
10270
10602
|
height: number;
|
10271
10603
|
};
|
10272
10604
|
|
10605
|
+
/**
|
10606
|
+
* @interface
|
10607
|
+
*/
|
10273
10608
|
declare type RectangleByEdgePositions = {
|
10274
10609
|
top: number;
|
10275
10610
|
left: number;
|
@@ -10285,6 +10620,9 @@ declare type RegisteredEvent = BaseEvent & {
|
|
10285
10620
|
type: 'registered';
|
10286
10621
|
};
|
10287
10622
|
|
10623
|
+
/**
|
10624
|
+
* @interface
|
10625
|
+
*/
|
10288
10626
|
declare type RegisterUsageData = {
|
10289
10627
|
data: unknown;
|
10290
10628
|
type: string;
|
@@ -10292,6 +10630,9 @@ declare type RegisterUsageData = {
|
|
10292
10630
|
|
10293
10631
|
declare type RegistryInfo = OpenFin.RegistryInfo;
|
10294
10632
|
|
10633
|
+
/**
|
10634
|
+
* @interface
|
10635
|
+
*/
|
10295
10636
|
declare type RegistryInfo_2 = {
|
10296
10637
|
data: any;
|
10297
10638
|
rootKey: string;
|
@@ -10313,6 +10654,9 @@ declare interface RemoteConfig extends ExistingConnectConfig {
|
|
10313
10654
|
token: string;
|
10314
10655
|
}
|
10315
10656
|
|
10657
|
+
/**
|
10658
|
+
* @interface
|
10659
|
+
*/
|
10316
10660
|
declare type ReplaceLayoutOpts = {
|
10317
10661
|
/**
|
10318
10662
|
* Layout config to be applied.
|
@@ -10320,6 +10664,9 @@ declare type ReplaceLayoutOpts = {
|
|
10320
10664
|
layout: LayoutOptions;
|
10321
10665
|
};
|
10322
10666
|
|
10667
|
+
/**
|
10668
|
+
* @interface
|
10669
|
+
*/
|
10323
10670
|
declare type ReplaceLayoutPayload = {
|
10324
10671
|
/**
|
10325
10672
|
* Object containing the layout to be applied.
|
@@ -10331,6 +10678,9 @@ declare type ReplaceLayoutPayload = {
|
|
10331
10678
|
target: Identity_5;
|
10332
10679
|
};
|
10333
10680
|
|
10681
|
+
/**
|
10682
|
+
* @interface
|
10683
|
+
*/
|
10334
10684
|
declare type ReplaceViewPayload = {
|
10335
10685
|
opts: {
|
10336
10686
|
viewToReplace: Identity_5;
|
@@ -10341,6 +10691,8 @@ declare type ReplaceViewPayload = {
|
|
10341
10691
|
|
10342
10692
|
/**
|
10343
10693
|
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
10694
|
+
*
|
10695
|
+
* @interface
|
10344
10696
|
*/
|
10345
10697
|
declare type ResizeRegion = {
|
10346
10698
|
/**
|
@@ -10420,6 +10772,9 @@ declare type RespondingEvent = IdentityEvent & {
|
|
10420
10772
|
|
10421
10773
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
10422
10774
|
|
10775
|
+
/**
|
10776
|
+
* @interface
|
10777
|
+
*/
|
10423
10778
|
declare type RGB = {
|
10424
10779
|
red: number;
|
10425
10780
|
blue: number;
|
@@ -10494,6 +10849,8 @@ declare type RuntimeConfig = {
|
|
10494
10849
|
|
10495
10850
|
/**
|
10496
10851
|
* The options object required by the downloadRuntime function.
|
10852
|
+
*
|
10853
|
+
* @interface
|
10497
10854
|
*/
|
10498
10855
|
declare type RuntimeDownloadOptions = {
|
10499
10856
|
/**
|
@@ -10502,6 +10859,9 @@ declare type RuntimeDownloadOptions = {
|
|
10502
10859
|
version: string;
|
10503
10860
|
};
|
10504
10861
|
|
10862
|
+
/**
|
10863
|
+
* @interface
|
10864
|
+
*/
|
10505
10865
|
declare type RuntimeDownloadProgress = {
|
10506
10866
|
/**
|
10507
10867
|
* @property { string } alias The name of the asset
|
@@ -10515,6 +10875,9 @@ declare type RuntimeErrorPayload = {
|
|
10515
10875
|
error?: ErrorPlainObject;
|
10516
10876
|
};
|
10517
10877
|
|
10878
|
+
/**
|
10879
|
+
* @interface
|
10880
|
+
*/
|
10518
10881
|
declare type RuntimeInfo = {
|
10519
10882
|
/**
|
10520
10883
|
* The runtime build architecture.
|
@@ -10545,6 +10908,9 @@ declare type RuntimeInfo = {
|
|
10545
10908
|
devtoolsPort?: number;
|
10546
10909
|
};
|
10547
10910
|
|
10911
|
+
/**
|
10912
|
+
* @interface
|
10913
|
+
*/
|
10548
10914
|
declare type RVMInfo = {
|
10549
10915
|
/**
|
10550
10916
|
* The name of action: "get-rvm-info".
|
@@ -10572,6 +10938,9 @@ declare type RVMInfo = {
|
|
10572
10938
|
'working-dir': string;
|
10573
10939
|
};
|
10574
10940
|
|
10941
|
+
/**
|
10942
|
+
* @interface
|
10943
|
+
*/
|
10575
10944
|
declare type RvmLaunchOptions = {
|
10576
10945
|
/**
|
10577
10946
|
* True if no UI when launching
|
@@ -10588,6 +10957,9 @@ declare type RvmLaunchOptions = {
|
|
10588
10957
|
subscribe?: (launch: LaunchEmitter) => void;
|
10589
10958
|
};
|
10590
10959
|
|
10960
|
+
/**
|
10961
|
+
* @interface
|
10962
|
+
*/
|
10591
10963
|
declare type ScreenshotPrintOptions = {
|
10592
10964
|
content: 'screenshot';
|
10593
10965
|
};
|
@@ -10596,6 +10968,9 @@ declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
10596
10968
|
data: ProtocolMap[T]['response'];
|
10597
10969
|
} & ProtocolMap[T]['specialResponse']>;
|
10598
10970
|
|
10971
|
+
/**
|
10972
|
+
* @interface
|
10973
|
+
*/
|
10599
10974
|
declare type SendApplicationLogResponse = {
|
10600
10975
|
logId: string;
|
10601
10976
|
};
|
@@ -10610,6 +10985,9 @@ declare type ServiceConfig = {
|
|
10610
10985
|
manifestUrl: string;
|
10611
10986
|
};
|
10612
10987
|
|
10988
|
+
/**
|
10989
|
+
* @interface
|
10990
|
+
*/
|
10613
10991
|
declare type ServiceConfiguration = {
|
10614
10992
|
config: object;
|
10615
10993
|
/**
|
@@ -10618,6 +10996,9 @@ declare type ServiceConfiguration = {
|
|
10618
10996
|
name: string;
|
10619
10997
|
};
|
10620
10998
|
|
10999
|
+
/**
|
11000
|
+
* @interface
|
11001
|
+
*/
|
10621
11002
|
declare type ServiceIdentifier = {
|
10622
11003
|
/**
|
10623
11004
|
* The name of the service.
|
@@ -10634,6 +11015,9 @@ declare type SessionChangedEvent = {
|
|
10634
11015
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
10635
11016
|
};
|
10636
11017
|
|
11018
|
+
/**
|
11019
|
+
* @interface
|
11020
|
+
*/
|
10637
11021
|
declare type SessionContextGroup = {
|
10638
11022
|
id: string;
|
10639
11023
|
setContext: (context: Context) => Promise<void>;
|
@@ -10643,6 +11027,9 @@ declare type SessionContextGroup = {
|
|
10643
11027
|
}>;
|
10644
11028
|
};
|
10645
11029
|
|
11030
|
+
/**
|
11031
|
+
* @interface
|
11032
|
+
*/
|
10646
11033
|
declare type SetWindowContextPayload = {
|
10647
11034
|
/**
|
10648
11035
|
* The requested context update.
|
@@ -10658,11 +11045,17 @@ declare type SetWindowContextPayload = {
|
|
10658
11045
|
target: Identity_5;
|
10659
11046
|
};
|
10660
11047
|
|
11048
|
+
/**
|
11049
|
+
* @interface
|
11050
|
+
*/
|
10661
11051
|
declare type SharedWorkerInfo = {
|
10662
11052
|
id: string;
|
10663
11053
|
url: string;
|
10664
11054
|
};
|
10665
11055
|
|
11056
|
+
/**
|
11057
|
+
* @interface
|
11058
|
+
*/
|
10666
11059
|
declare type ShortCutConfig = {
|
10667
11060
|
/**
|
10668
11061
|
* True if application has a shortcut on the desktop.
|
@@ -10693,6 +11086,9 @@ declare type ShownEvent = BaseViewEvent & {
|
|
10693
11086
|
type: 'shown';
|
10694
11087
|
};
|
10695
11088
|
|
11089
|
+
/**
|
11090
|
+
* @interface
|
11091
|
+
*/
|
10696
11092
|
declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
|
10697
11093
|
template: MenuItemTemplate<T>[];
|
10698
11094
|
x?: number;
|
@@ -10701,6 +11097,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
|
|
10701
11097
|
|
10702
11098
|
/**
|
10703
11099
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
11100
|
+
*
|
10704
11101
|
* @interface
|
10705
11102
|
*/
|
10706
11103
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
@@ -10732,6 +11129,9 @@ declare type Size = TransitionBase & {
|
|
10732
11129
|
height: number;
|
10733
11130
|
};
|
10734
11131
|
|
11132
|
+
/**
|
11133
|
+
* @interface
|
11134
|
+
*/
|
10735
11135
|
declare type Snapshot = {
|
10736
11136
|
windows: WindowCreationOptions[];
|
10737
11137
|
snapshotDetails?: {
|
@@ -10744,6 +11144,9 @@ declare type Snapshot = {
|
|
10744
11144
|
};
|
10745
11145
|
};
|
10746
11146
|
|
11147
|
+
/**
|
11148
|
+
* @interface
|
11149
|
+
*/
|
10747
11150
|
declare type SnapshotProvider<Snapshot = unknown> = {
|
10748
11151
|
getSnapshot: () => Promise<Snapshot>;
|
10749
11152
|
applySnapshot: (snapshot: Snapshot) => Promise<void>;
|
@@ -10890,6 +11293,9 @@ declare type StartedEvent = IdentityEvent & {
|
|
10890
11293
|
type: 'started';
|
10891
11294
|
};
|
10892
11295
|
|
11296
|
+
/**
|
11297
|
+
* @interface
|
11298
|
+
*/
|
10893
11299
|
declare type SubscriptionOptions = {
|
10894
11300
|
/**
|
10895
11301
|
* The event timestamp.
|
@@ -12382,6 +12788,9 @@ declare namespace SystemEvents {
|
|
12382
12788
|
*/
|
12383
12789
|
declare type SystemEventType = SystemEvent['type'];
|
12384
12790
|
|
12791
|
+
/**
|
12792
|
+
* @interface
|
12793
|
+
*/
|
12385
12794
|
declare type SystemPermissions = {
|
12386
12795
|
getAllExternalWindows: boolean;
|
12387
12796
|
launchExternalProcess: boolean | {
|
@@ -12409,6 +12818,9 @@ declare type SystemPermissions = {
|
|
12409
12818
|
};
|
12410
12819
|
};
|
12411
12820
|
|
12821
|
+
/**
|
12822
|
+
* @interface
|
12823
|
+
*/
|
12412
12824
|
declare type SystemProcessInfo = {
|
12413
12825
|
apps: AppProcessInfo[];
|
12414
12826
|
browserProcess: NonAppProcessDetails;
|
@@ -12637,6 +13049,9 @@ declare type TaskBar = DipScaleRects & {
|
|
12637
13049
|
rect: RectangleByEdgePositions;
|
12638
13050
|
};
|
12639
13051
|
|
13052
|
+
/**
|
13053
|
+
* @interface
|
13054
|
+
*/
|
12640
13055
|
declare type TerminateExternalRequestType = {
|
12641
13056
|
/**
|
12642
13057
|
* The uuid of the running application.
|
@@ -12652,6 +13067,9 @@ declare type TerminateExternalRequestType = {
|
|
12652
13067
|
killTree: boolean;
|
12653
13068
|
};
|
12654
13069
|
|
13070
|
+
/**
|
13071
|
+
* @interface
|
13072
|
+
*/
|
12655
13073
|
declare type Time = {
|
12656
13074
|
/**
|
12657
13075
|
* The number of milliseconds the CPU has spent in user mode.
|
@@ -12675,6 +13093,9 @@ declare type Time = {
|
|
12675
13093
|
irq: number;
|
12676
13094
|
};
|
12677
13095
|
|
13096
|
+
/**
|
13097
|
+
* @interface
|
13098
|
+
*/
|
12678
13099
|
declare type Transition = {
|
12679
13100
|
opacity?: Opacity;
|
12680
13101
|
position?: Position;
|
@@ -12683,6 +13104,8 @@ declare type Transition = {
|
|
12683
13104
|
|
12684
13105
|
/**
|
12685
13106
|
* Base configuration options needed for all types of transitions.
|
13107
|
+
*
|
13108
|
+
* @interface
|
12686
13109
|
*/
|
12687
13110
|
declare type TransitionBase = {
|
12688
13111
|
/**
|
@@ -12699,6 +13122,8 @@ declare type TransitionBase = {
|
|
12699
13122
|
|
12700
13123
|
/**
|
12701
13124
|
* Configuration for transition between windows.
|
13125
|
+
*
|
13126
|
+
* @interface
|
12702
13127
|
*/
|
12703
13128
|
declare type TransitionOptions = {
|
12704
13129
|
/**
|
@@ -12759,6 +13184,9 @@ declare type TrayIconClickedEvent = IdentityEvent & {
|
|
12759
13184
|
monitorInfo: any;
|
12760
13185
|
};
|
12761
13186
|
|
13187
|
+
/**
|
13188
|
+
* @interface
|
13189
|
+
*/
|
12762
13190
|
declare type TrayInfo = {
|
12763
13191
|
/**
|
12764
13192
|
* The bound of tray icon in virtual screen pixels.
|
@@ -12808,9 +13236,14 @@ declare type UnregisteredEvent = BaseEvent & {
|
|
12808
13236
|
|
12809
13237
|
/**
|
12810
13238
|
* View options that can be updated after creation.
|
13239
|
+
*
|
13240
|
+
* @interface
|
12811
13241
|
*/
|
12812
13242
|
declare type UpdatableViewOptions = Partial<MutableViewOptions>;
|
12813
13243
|
|
13244
|
+
/**
|
13245
|
+
* @interface
|
13246
|
+
*/
|
12814
13247
|
declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
|
12815
13248
|
|
12816
13249
|
/**
|
@@ -13477,6 +13910,9 @@ declare namespace ViewEvents {
|
|
13477
13910
|
*/
|
13478
13911
|
declare type ViewEventType = ViewEvent['type'];
|
13479
13912
|
|
13913
|
+
/**
|
13914
|
+
* @interface
|
13915
|
+
*/
|
13480
13916
|
declare type ViewInfo = {
|
13481
13917
|
canNavigateBack: boolean;
|
13482
13918
|
canNavigateForward: boolean;
|
@@ -13611,6 +14047,7 @@ declare class ViewOverlay {
|
|
13611
14047
|
|
13612
14048
|
/**
|
13613
14049
|
* Represents the payload shape for Views that are trying to prevent an unload.
|
14050
|
+
* @interface
|
13614
14051
|
*/
|
13615
14052
|
declare interface ViewsPreventingUnloadPayload {
|
13616
14053
|
/**
|
@@ -13646,6 +14083,8 @@ declare type ViewState = ViewCreationOptions & {
|
|
13646
14083
|
};
|
13647
14084
|
|
13648
14085
|
/**
|
14086
|
+
* @interface
|
14087
|
+
*
|
13649
14088
|
* The statuses of views specifying which of them are trying to prevent an unload and which are not.
|
13650
14089
|
*/
|
13651
14090
|
declare interface ViewStatuses {
|
@@ -13661,6 +14100,8 @@ declare interface ViewStatuses {
|
|
13661
14100
|
|
13662
14101
|
/**
|
13663
14102
|
* Configuration for view visibility settings
|
14103
|
+
*
|
14104
|
+
* @interface
|
13664
14105
|
*/
|
13665
14106
|
declare type ViewVisibilityOption = {
|
13666
14107
|
enabled?: boolean;
|
@@ -13668,6 +14109,8 @@ declare type ViewVisibilityOption = {
|
|
13668
14109
|
|
13669
14110
|
/**
|
13670
14111
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
14112
|
+
*
|
14113
|
+
* @interface
|
13671
14114
|
*/
|
13672
14115
|
declare type ViewVisibilityOptions = {
|
13673
14116
|
/**
|
@@ -16250,6 +16693,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16250
16693
|
|
16251
16694
|
declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
16252
16695
|
|
16696
|
+
/**
|
16697
|
+
* @interface
|
16698
|
+
*/
|
16253
16699
|
declare type WindowDetail = {
|
16254
16700
|
/**
|
16255
16701
|
* The bottom-most coordinate of the window.
|
@@ -16380,6 +16826,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16380
16826
|
type: 'hotkey';
|
16381
16827
|
};
|
16382
16828
|
|
16829
|
+
/**
|
16830
|
+
* @interface
|
16831
|
+
*/
|
16383
16832
|
declare type WindowInfo = {
|
16384
16833
|
canNavigateBack: boolean;
|
16385
16834
|
canNavigateForward: boolean;
|
@@ -16495,6 +16944,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16495
16944
|
type: 'window-not-responding';
|
16496
16945
|
};
|
16497
16946
|
|
16947
|
+
/**
|
16948
|
+
* @interface
|
16949
|
+
*/
|
16498
16950
|
declare type WindowOptionDiff = {
|
16499
16951
|
[key in keyof WindowOptions]: {
|
16500
16952
|
oldVal: WindowOptions[key];
|
@@ -16568,6 +17020,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16568
17020
|
*/
|
16569
17021
|
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
16570
17022
|
|
17023
|
+
/**
|
17024
|
+
* @interface
|
17025
|
+
*/
|
16571
17026
|
declare type WindowViewsPrintOptions = {
|
16572
17027
|
content: 'views';
|
16573
17028
|
includeSelf?: boolean;
|
@@ -16597,10 +17052,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16597
17052
|
positioningOptions?: OpenFin.PositioningOptions;
|
16598
17053
|
};
|
16599
17054
|
|
16600
|
-
|
16601
|
-
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
16602
|
-
[key: string]: any;
|
16603
|
-
};
|
17055
|
+
/* Excluded from this release type: WorkspacePlatformOptions */
|
16604
17056
|
|
16605
17057
|
/**
|
16606
17058
|
* A generic request to write any supported data to the clipboard.
|
@@ -16618,6 +17070,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16618
17070
|
* @deprecated - instead use WriteAnyClipboardRequest
|
16619
17071
|
*
|
16620
17072
|
* A generic request to write any supported data to the clipboard.
|
17073
|
+
*
|
17074
|
+
* @interface
|
16621
17075
|
*/
|
16622
17076
|
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
16623
17077
|
|
@@ -16648,6 +17102,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16648
17102
|
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
16649
17103
|
*
|
16650
17104
|
* A request to write data to the clipboard.
|
17105
|
+
*
|
17106
|
+
* @interface
|
16651
17107
|
*/
|
16652
17108
|
declare type WriteRequestType = WriteClipboardRequest;
|
16653
17109
|
|