@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.
@@ -7,6 +7,8 @@ import { EventEmitter } from 'events';
7
7
 
8
8
  /**
9
9
  * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
10
+ *
11
+ * @interface
10
12
  */
11
13
  declare type Accelerator = {
12
14
  /**
@@ -43,6 +45,9 @@ declare type Accelerator = {
43
45
  zoom: boolean;
44
46
  };
45
47
 
48
+ /**
49
+ * @interface
50
+ */
46
51
  declare type AddViewToStackOptions = {
47
52
  /**
48
53
  * Optional index within the stack to insert the view. Defaults to 0
@@ -66,6 +71,8 @@ declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<Payl
66
71
 
67
72
  /**
68
73
  * Configurations for API injection.
74
+ *
75
+ * @interface
69
76
  */
70
77
  declare type Api = {
71
78
  /**
@@ -93,6 +100,9 @@ declare type ApiClient<T extends Record<any, any>> = {
93
100
  [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
94
101
  };
95
102
 
103
+ /**
104
+ * @interface
105
+ */
96
106
  declare type AppAssetInfo = {
97
107
  /**
98
108
  * The URL to a zip file containing the package files (executables, dlls, etc…)
@@ -121,6 +131,9 @@ declare type AppAssetInfo = {
121
131
  mandatory?: boolean;
122
132
  };
123
133
 
134
+ /**
135
+ * @interface
136
+ */
124
137
  declare type AppAssetRequest = {
125
138
  alias: string;
126
139
  };
@@ -897,10 +910,16 @@ declare type ApplicationEventType = ApplicationEvent['type'];
897
910
 
898
911
  declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
899
912
 
913
+ /**
914
+ * @interface
915
+ */
900
916
  declare type ApplicationIdentity_2 = {
901
917
  uuid: string;
902
918
  };
903
919
 
920
+ /**
921
+ * @interface
922
+ */
904
923
  declare type ApplicationInfo = {
905
924
  initialOptions: ApplicationCreationOptions;
906
925
  launchMode: string;
@@ -1194,6 +1213,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1194
1213
  enableBeforeUnload: boolean;
1195
1214
  };
1196
1215
 
1216
+ /**
1217
+ * @interface
1218
+ */
1197
1219
  declare type ApplicationPermissions = {
1198
1220
  setFileDownloadLocation: boolean;
1199
1221
  getFileDownloadLocation: boolean;
@@ -1201,6 +1223,9 @@ declare type ApplicationPermissions = {
1201
1223
 
1202
1224
  declare type ApplicationState = OpenFin.ApplicationState;
1203
1225
 
1226
+ /**
1227
+ * @interface
1228
+ */
1204
1229
  declare type ApplicationState_2 = {
1205
1230
  /**
1206
1231
  * True when the application is a Platform controller
@@ -1220,6 +1245,9 @@ declare type ApplicationState_2 = {
1220
1245
  parentUuid?: string;
1221
1246
  };
1222
1247
 
1248
+ /**
1249
+ * @interface
1250
+ */
1223
1251
  declare type ApplicationType = {
1224
1252
  type: 'application' | 'external-app';
1225
1253
  uuid: string;
@@ -1232,6 +1260,9 @@ declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedE
1232
1260
 
1233
1261
  declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
1234
1262
 
1263
+ /**
1264
+ * @interface
1265
+ */
1235
1266
  declare type ApplicationWindowInfo_2 = {
1236
1267
  childWindows: Array<WindowDetail>;
1237
1268
  mainWindow: WindowDetail;
@@ -1241,6 +1272,9 @@ declare type ApplicationWindowInfo_2 = {
1241
1272
  uuid: string;
1242
1273
  };
1243
1274
 
1275
+ /**
1276
+ * @interface
1277
+ */
1244
1278
  declare type ApplySnapshotOptions = {
1245
1279
  /**
1246
1280
  * @defaultValue false
@@ -1268,6 +1302,8 @@ declare type ApplySnapshotOptions = {
1268
1302
 
1269
1303
  /**
1270
1304
  * Payload sent to Platform Provider when {@link Platform#applySnapshot Platform.applySnapshot} is called.
1305
+ *
1306
+ * @interface
1271
1307
  */
1272
1308
  declare type ApplySnapshotPayload = {
1273
1309
  /**
@@ -1280,6 +1316,9 @@ declare type ApplySnapshotPayload = {
1280
1316
  options?: ApplySnapshotOptions;
1281
1317
  };
1282
1318
 
1319
+ /**
1320
+ * @interface
1321
+ */
1283
1322
  declare type AppProcessInfo = {
1284
1323
  /**
1285
1324
  * The uuid of the application.
@@ -1299,6 +1338,9 @@ declare type AppVersionCompleteEvent = {
1299
1338
  type: 'app-version-complete';
1300
1339
  } & AppVersionProgress;
1301
1340
 
1341
+ /**
1342
+ * @interface
1343
+ */
1302
1344
  declare type AppVersionError = {
1303
1345
  error: string;
1304
1346
  srcManifest: string;
@@ -1327,6 +1369,9 @@ declare type AppVersionEventType = AppVersionEvent['type'];
1327
1369
  */
1328
1370
  declare type AppVersionEventWithId = EventWithId<AppVersionEvent>;
1329
1371
 
1372
+ /**
1373
+ * @interface
1374
+ */
1330
1375
  declare type AppVersionProgress = {
1331
1376
  manifest: string | null;
1332
1377
  srcManifest: string;
@@ -1340,6 +1385,9 @@ declare type AppVersionProgressEvent = {
1340
1385
  type: 'app-version-progress';
1341
1386
  } & AppVersionProgress;
1342
1387
 
1388
+ /**
1389
+ * @interface
1390
+ */
1343
1391
  declare type AppVersionRuntimeInfo = {
1344
1392
  version: string | null;
1345
1393
  exists: boolean | null;
@@ -1459,6 +1507,9 @@ declare type AuthRequestedEvent = NamedEvent & {
1459
1507
  */
1460
1508
  declare type AutoplayPolicyOptions = 'no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required';
1461
1509
 
1510
+ /**
1511
+ * @interface
1512
+ */
1462
1513
  declare type AutoResizeOptions = {
1463
1514
  /**
1464
1515
  * If true, the view's width will grow and shrink together with the window. false
@@ -1507,6 +1558,9 @@ declare type BaseChannelEvent = NamedEvent & {
1507
1558
  channelId: string;
1508
1559
  };
1509
1560
 
1561
+ /**
1562
+ * @interface
1563
+ */
1510
1564
  declare type BaseClipboardRequest = {
1511
1565
  /**
1512
1566
  * The type of clipboard to write to, can be 'clipboard' or 'selection'.
@@ -1597,8 +1651,9 @@ declare type BaseViewEvent = NamedEvent & {
1597
1651
 
1598
1652
  /**
1599
1653
  * User decision of whether a Window or specific View should close when trying to prevent an unload.
1654
+ * @interface
1600
1655
  */
1601
- declare interface BeforeUnloadUserDecision {
1656
+ declare type BeforeUnloadUserDecision = {
1602
1657
  /**
1603
1658
  * Specifies if the Window should close.
1604
1659
  */
@@ -1607,7 +1662,7 @@ declare interface BeforeUnloadUserDecision {
1607
1662
  * Array of views that will close.
1608
1663
  */
1609
1664
  viewsToClose: Identity_5[];
1610
- }
1665
+ };
1611
1666
 
1612
1667
  /**
1613
1668
  * Generated at the beginning of a user-driven change to a window's size or position.
@@ -1625,6 +1680,9 @@ declare type BlurredEvent = NamedEvent & {
1625
1680
  type: 'blurred';
1626
1681
  };
1627
1682
 
1683
+ /**
1684
+ * @interface
1685
+ */
1628
1686
  declare type Bounds = {
1629
1687
  top: number;
1630
1688
  left: number;
@@ -1663,8 +1721,10 @@ declare type BoundsChangingEvent = BoundsChangeEvent & {
1663
1721
 
1664
1722
  /**
1665
1723
  * Configuration for page capture.
1724
+ *
1725
+ * @interface
1666
1726
  */
1667
- declare interface CapturePageOptions {
1727
+ declare type CapturePageOptions = {
1668
1728
  /**
1669
1729
  * The area of the window to be captured.
1670
1730
  */
@@ -1681,8 +1741,11 @@ declare interface CapturePageOptions {
1681
1741
  * Quality of JPEG image. Between 0 - 100.
1682
1742
  */
1683
1743
  quality?: number;
1684
- }
1744
+ };
1685
1745
 
1746
+ /**
1747
+ * @interface
1748
+ */
1686
1749
  declare type Certificate = {
1687
1750
  data: string;
1688
1751
  fingerprint: string;
@@ -1707,6 +1770,9 @@ declare type CertificateErrorEvent = NamedEvent & {
1707
1770
  certificate: OpenFin.Certificate;
1708
1771
  };
1709
1772
 
1773
+ /**
1774
+ * @interface
1775
+ */
1710
1776
  declare type CertificatePrincipal = {
1711
1777
  commonName: string;
1712
1778
  country: string;
@@ -1726,6 +1792,9 @@ declare type CertificateSelectionShownEvent = NamedEvent & {
1726
1792
  certificates: OpenFin.Certificate[];
1727
1793
  };
1728
1794
 
1795
+ /**
1796
+ * @interface
1797
+ */
1729
1798
  declare type CertificationInfo = {
1730
1799
  serial?: string;
1731
1800
  subject?: string;
@@ -1734,6 +1803,9 @@ declare type CertificationInfo = {
1734
1803
  trusted?: boolean;
1735
1804
  };
1736
1805
 
1806
+ /**
1807
+ * @interface
1808
+ */
1737
1809
  declare type CertifiedAppInfo = {
1738
1810
  isRunning: boolean;
1739
1811
  isOptedIntoCertfiedApp?: boolean;
@@ -2338,6 +2410,8 @@ declare type ChannelConnectOptions = ChannelCreateOptions & {
2338
2410
 
2339
2411
  /**
2340
2412
  * Channel provider creation options.
2413
+ *
2414
+ * @interface
2341
2415
  */
2342
2416
  declare type ChannelCreateOptions = {
2343
2417
  /**
@@ -2647,6 +2721,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
2647
2721
  isValidEndpointPayload(payload: any): payload is EndpointPayload;
2648
2722
  }
2649
2723
 
2724
+ /**
2725
+ * @interface
2726
+ */
2650
2727
  declare type ClearCacheOption = {
2651
2728
  /**
2652
2729
  * html5 application cache
@@ -2666,6 +2743,9 @@ declare type ClearCacheOption = {
2666
2743
  localStorage?: boolean;
2667
2744
  };
2668
2745
 
2746
+ /**
2747
+ * @interface
2748
+ */
2669
2749
  declare type ClickedMenuResult<T extends unknown = unknown> = {
2670
2750
  result: 'clicked';
2671
2751
  data: T;
@@ -2895,10 +2975,16 @@ declare type ClosedEvent = IdentityEvent & {
2895
2975
  type: 'closed';
2896
2976
  };
2897
2977
 
2978
+ /**
2979
+ * @interface
2980
+ */
2898
2981
  declare type ClosedMenuResult = {
2899
2982
  result: 'closed';
2900
2983
  };
2901
2984
 
2985
+ /**
2986
+ * @interface
2987
+ */
2902
2988
  declare type CloseViewPayload = {
2903
2989
  /**
2904
2990
  *View to be closed.
@@ -2907,6 +2993,8 @@ declare type CloseViewPayload = {
2907
2993
  };
2908
2994
 
2909
2995
  /**
2996
+ * @interface
2997
+ *
2910
2998
  * Represents the shape of payload that contains the Window Identity and related options.
2911
2999
  */
2912
3000
  declare interface CloseWindowPayload {
@@ -3043,6 +3131,8 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
3043
3131
 
3044
3132
  /**
3045
3133
  * View options that cannot be updated after creation.
3134
+ *
3135
+ * @interface
3046
3136
  */
3047
3137
  declare type ConstViewOptions = {
3048
3138
  /**
@@ -3110,6 +3200,8 @@ declare type ConstViewOptions = {
3110
3200
 
3111
3201
  /**
3112
3202
  * Window options that cannot be changed after creation.
3203
+ *
3204
+ * @interface
3113
3205
  */
3114
3206
  declare type ConstWindowOptions = {
3115
3207
  /**
@@ -3311,6 +3403,8 @@ declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'brows
3311
3403
 
3312
3404
  /**
3313
3405
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3406
+ *
3407
+ * @interface
3314
3408
  */
3315
3409
  declare type ContentCreationOptions = {
3316
3410
  /**
@@ -3326,6 +3420,8 @@ declare type ContentCreationOptions = {
3326
3420
  * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
3327
3421
  * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
3328
3422
  * @property { object } options Window creation options or View creation options.
3423
+ *
3424
+ * @interface
3329
3425
  */
3330
3426
  declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
3331
3427
  /**
@@ -3378,6 +3474,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3378
3474
  * Restrict navigation to URLs that match an allowed pattern.
3379
3475
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3380
3476
  * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3477
+ *
3478
+ * @interface
3381
3479
  */
3382
3480
  declare type ContentNavigation = NavigationRules;
3383
3481
 
@@ -3385,11 +3483,15 @@ declare type ContentNavigation = NavigationRules;
3385
3483
  * Restrict redirects to URLs that match an allowed pattern.
3386
3484
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3387
3485
  * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3486
+ *
3487
+ * @interface
3388
3488
  */
3389
3489
  declare type ContentRedirect = NavigationRules;
3390
3490
 
3391
3491
  /**
3392
3492
  * Data passed between entities and applications.
3493
+ *
3494
+ * @interface
3393
3495
  */
3394
3496
  declare type Context = {
3395
3497
  /**
@@ -3415,6 +3517,9 @@ declare type ContextForIntent<MetadataType = any> = Context & {
3415
3517
  metadata?: MetadataType;
3416
3518
  };
3417
3519
 
3520
+ /**
3521
+ * @interface
3522
+ */
3418
3523
  declare type ContextGroupInfo = {
3419
3524
  /**
3420
3525
  * Unique identifier of the context group.
@@ -3436,6 +3541,8 @@ declare type ContextHandler = (context: Context) => void;
3436
3541
 
3437
3542
  /**
3438
3543
  * Configure the context menu when right-clicking on a window.
3544
+ *
3545
+ * @interface
3439
3546
  */
3440
3547
  declare type ContextMenuOptions = {
3441
3548
  /**
@@ -3451,6 +3558,8 @@ declare type ContextMenuOptions = {
3451
3558
  /**
3452
3559
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
3453
3560
  * Configure the context menu when right-clicking on a window.
3561
+ *
3562
+ * @interface
3454
3563
  */
3455
3564
  declare type ContextMenuSettings = {
3456
3565
  /**
@@ -3467,12 +3576,18 @@ declare type ContextMenuSettings = {
3467
3576
  reload?: boolean;
3468
3577
  };
3469
3578
 
3579
+ /**
3580
+ * @interface
3581
+ */
3470
3582
  declare type CookieInfo = {
3471
3583
  name: string;
3472
3584
  domain: string;
3473
3585
  path: string;
3474
3586
  };
3475
3587
 
3588
+ /**
3589
+ * @interface
3590
+ */
3476
3591
  declare type CookieOption = {
3477
3592
  name: string;
3478
3593
  };
@@ -3480,6 +3595,8 @@ declare type CookieOption = {
3480
3595
  /**
3481
3596
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
3482
3597
  * average of _height_ and _width_.
3598
+ *
3599
+ * @interface
3483
3600
  */
3484
3601
  declare type CornerRounding = {
3485
3602
  /**
@@ -3496,6 +3613,9 @@ declare type CornerRounding = {
3496
3613
  width: number;
3497
3614
  };
3498
3615
 
3616
+ /**
3617
+ * @interface
3618
+ */
3499
3619
  declare type CpuInfo = {
3500
3620
  /**
3501
3621
  * The model of the cpu
@@ -3525,6 +3645,9 @@ declare type CrashedEvent = NamedEvent & {
3525
3645
  };
3526
3646
  };
3527
3647
 
3648
+ /**
3649
+ * @interface
3650
+ */
3528
3651
  declare type CrashReporterOptions = {
3529
3652
  /**
3530
3653
  * In diagnostics mode the crash reporter will send diagnostic logs to
@@ -3552,6 +3675,9 @@ declare type CreatedEvent = BaseViewEvent & {
3552
3675
  type: 'created';
3553
3676
  };
3554
3677
 
3678
+ /**
3679
+ * @interface
3680
+ */
3555
3681
  declare type CreateViewPayload = {
3556
3682
  /**
3557
3683
  * Options for the view to be added.
@@ -3580,6 +3706,8 @@ declare type CreateViewTarget = Identity_5 & {
3580
3706
 
3581
3707
  /**
3582
3708
  * Custom headers for requests sent by the window.
3709
+ *
3710
+ * @interface
3583
3711
  */
3584
3712
  declare type CustomRequestHeaders = {
3585
3713
  /**
@@ -3593,10 +3721,16 @@ declare type CustomRequestHeaders = {
3593
3721
  headers: WebRequestHeader[];
3594
3722
  };
3595
3723
 
3724
+ /**
3725
+ * @interface
3726
+ */
3596
3727
  declare type DefaultDomainSettings = {
3597
3728
  rules: DefaultDomainSettingsRule[];
3598
3729
  };
3599
3730
 
3731
+ /**
3732
+ * @interface
3733
+ */
3600
3734
  declare type DefaultDomainSettingsRule = {
3601
3735
  match: string[];
3602
3736
  options: {
@@ -3652,6 +3786,9 @@ declare type DipRect = RectangleByEdgePositions & {
3652
3786
  scaledRect: RectangleByEdgePositions;
3653
3787
  };
3654
3788
 
3789
+ /**
3790
+ * @interface
3791
+ */
3655
3792
  declare type DipScaleRects = {
3656
3793
  dipRect: RectangleByEdgePositions;
3657
3794
  scaledRect: RectangleByEdgePositions;
@@ -3675,6 +3812,8 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
3675
3812
 
3676
3813
  /**
3677
3814
  * The display data for a context group.
3815
+ *
3816
+ * @interface
3678
3817
  */
3679
3818
  declare type DisplayMetadata = {
3680
3819
  /**
@@ -3693,6 +3832,8 @@ declare type DisplayMetadata = {
3693
3832
 
3694
3833
  /**
3695
3834
  * Metadata returned from a preload script download request.
3835
+ *
3836
+ * @interface
3696
3837
  */
3697
3838
  declare type DownloadPreloadInfo = {
3698
3839
  /**
@@ -3711,6 +3852,8 @@ declare type DownloadPreloadInfo = {
3711
3852
 
3712
3853
  /**
3713
3854
  * Options for downloading a preload script.
3855
+ *
3856
+ * @interface
3714
3857
  */
3715
3858
  declare type DownloadPreloadOption = {
3716
3859
  /**
@@ -3719,6 +3862,9 @@ declare type DownloadPreloadOption = {
3719
3862
  url: string;
3720
3863
  };
3721
3864
 
3865
+ /**
3866
+ * @interface
3867
+ */
3722
3868
  declare type DownloadRule = {
3723
3869
  behavior: FileDownloadBehaviorNames;
3724
3870
  match: string[];
@@ -3726,6 +3872,8 @@ declare type DownloadRule = {
3726
3872
 
3727
3873
  /**
3728
3874
  * DPI (dots per inch) configuration for printing.
3875
+ *
3876
+ * @interface
3729
3877
  */
3730
3878
  declare type Dpi = {
3731
3879
  /**
@@ -3788,53 +3936,35 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3788
3936
  protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
3789
3937
  /**
3790
3938
  * Adds a listener to the end of the listeners array for the specified event.
3791
- *
3792
- * @param eventType
3793
- * @param listener
3794
- * @param options
3795
3939
  */
3796
3940
  on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
3797
- addListener: <EventType extends EmitterEventType>(eventType: EventType, listener: OpenFin.BaseEvents.EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions) => Promise<this>;
3941
+ /**
3942
+ * Adds a listener to the end of the listeners array for the specified event.
3943
+ */
3944
+ addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
3798
3945
  /**
3799
3946
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
3800
- *
3801
- * @param eventType
3802
- * @param listener
3803
- * @param options
3804
3947
  */
3805
3948
  once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
3806
3949
  /**
3807
3950
  * Adds a listener to the beginning of the listeners array for the specified event.
3808
- *
3809
- * @param eventType
3810
- * @param listener
3811
- * @param options
3812
3951
  */
3813
3952
  prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
3814
3953
  /**
3815
3954
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
3816
3955
  * after which it is removed. The listener is added to the beginning of the listeners array.
3817
- *
3818
- * @param eventType
3819
- * @param listener
3820
- * @param options
3821
3956
  */
3822
3957
  prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
3823
3958
  /**
3824
3959
  * Remove a listener from the listener array for the specified event.
3825
3960
  *
3826
3961
  * @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
3827
- *
3828
- * @param eventType
3829
- * @param listener
3830
- * @param options
3831
3962
  */
3832
3963
  removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
3833
3964
  protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
3834
3965
  /**
3835
3966
  * Removes all listeners, or those of the specified event.
3836
3967
  *
3837
- * @param eventType
3838
3968
  */
3839
3969
  removeAllListeners(eventType?: EmitterEventType): Promise<this>;
3840
3970
  private deleteEmitterIfNothingRegistered;
@@ -3877,6 +4007,9 @@ declare type Entity = OpenFin.ApplicationType;
3877
4007
 
3878
4008
  declare type EntityInfo = OpenFin.EntityInfo;
3879
4009
 
4010
+ /**
4011
+ * @interface
4012
+ */
3880
4013
  declare type EntityInfo_2 = {
3881
4014
  uuid: string;
3882
4015
  name: string;
@@ -4004,6 +4137,9 @@ declare type ExistingConnectConfig = ConfigWithUuid & {
4004
4137
  address: string;
4005
4138
  };
4006
4139
 
4140
+ /**
4141
+ * @interface
4142
+ */
4007
4143
  declare type ExitCode = {
4008
4144
  topic: string;
4009
4145
  uuid: string;
@@ -4153,6 +4289,9 @@ declare namespace ExternalApplicationEvents {
4153
4289
  }
4154
4290
  }
4155
4291
 
4292
+ /**
4293
+ * @interface
4294
+ */
4156
4295
  declare type ExternalApplicationInfo = {
4157
4296
  parent: Identity_5;
4158
4297
  };
@@ -4195,6 +4334,9 @@ declare type ExternalConfig = BaseConfig & {
4195
4334
  manifestUrl: string;
4196
4335
  };
4197
4336
 
4337
+ /**
4338
+ * @interface
4339
+ */
4198
4340
  declare type ExternalConnection = {
4199
4341
  /**
4200
4342
  * The token to broker an external connection.
@@ -4216,11 +4358,17 @@ declare type ExternalProcessExitedEvent = NamedEvent & {
4216
4358
  exitCode: number;
4217
4359
  };
4218
4360
 
4361
+ /**
4362
+ * @interface
4363
+ */
4219
4364
  declare type ExternalProcessInfo = {
4220
4365
  pid: number;
4221
4366
  listener?: LaunchExternalProcessListener;
4222
4367
  };
4223
4368
 
4369
+ /**
4370
+ * @interface
4371
+ */
4224
4372
  declare type ExternalProcessRequestType = {
4225
4373
  /**
4226
4374
  * The file path to where the running application resides.
@@ -4263,6 +4411,9 @@ declare type FaviconUpdatedEvent = NamedEvent & {
4263
4411
  favicons: string[];
4264
4412
  };
4265
4413
 
4414
+ /**
4415
+ * @interface
4416
+ */
4266
4417
  declare type FetchManifestPayload = {
4267
4418
  /**
4268
4419
  * The URL of the manifest to fetch.
@@ -4351,6 +4502,9 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
4351
4502
  state: 'progressing' | 'interrupted';
4352
4503
  };
4353
4504
 
4505
+ /**
4506
+ * @interface
4507
+ */
4354
4508
  declare type FileDownloadSettings = {
4355
4509
  rules: DownloadRule[];
4356
4510
  };
@@ -4411,6 +4565,8 @@ declare interface FinApi<MeType extends EntityType> {
4411
4565
 
4412
4566
  /**
4413
4567
  * Configuration for find-in-page requests.
4568
+ *
4569
+ * @interface
4414
4570
  */
4415
4571
  declare type FindInPageOptions = {
4416
4572
  /**
@@ -4446,6 +4602,9 @@ declare type FindInPageOptions = {
4446
4602
  medialCapitalAsWordStart?: boolean;
4447
4603
  };
4448
4604
 
4605
+ /**
4606
+ * @interface
4607
+ */
4449
4608
  declare type FindInPageResult = {
4450
4609
  requestId: number;
4451
4610
  /**
@@ -4463,6 +4622,9 @@ declare type FindInPageResult = {
4463
4622
  finalUpdate: boolean;
4464
4623
  };
4465
4624
 
4625
+ /**
4626
+ * @interface
4627
+ */
4466
4628
  declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
4467
4629
  context: Context;
4468
4630
  metadata?: MetadataType;
@@ -4660,6 +4822,9 @@ declare namespace FrameEvents {
4660
4822
  */
4661
4823
  declare type FrameEventType = FrameEvent['type'];
4662
4824
 
4825
+ /**
4826
+ * @interface
4827
+ */
4663
4828
  declare type FrameInfo = {
4664
4829
  name: string;
4665
4830
  uuid: string;
@@ -4736,6 +4901,9 @@ declare type FrameProcessDetails = ProcessDetails & {
4736
4901
 
4737
4902
  declare type GetLogRequestType = OpenFin.GetLogRequestType;
4738
4903
 
4904
+ /**
4905
+ * @interface
4906
+ */
4739
4907
  declare type GetLogRequestType_2 = {
4740
4908
  /**
4741
4909
  * The name of the running application
@@ -4753,6 +4921,9 @@ declare type GetLogRequestType_2 = {
4753
4921
 
4754
4922
  declare type GetterCall<T> = ApiCall<void, T>;
4755
4923
 
4924
+ /**
4925
+ * @interface
4926
+ */
4756
4927
  declare type GetWindowContextPayload = {
4757
4928
  /**
4758
4929
  * Entity type of the target of the context update ('view' or 'window').
@@ -4888,6 +5059,9 @@ declare namespace GlobalHotkeyEvents {
4888
5059
  }
4889
5060
  }
4890
5061
 
5062
+ /**
5063
+ * @interface
5064
+ */
4891
5065
  declare type GpuInfo = {
4892
5066
  name: string;
4893
5067
  };
@@ -4900,6 +5074,9 @@ declare type HiddenEvent = BaseViewEvent & {
4900
5074
  type: 'hidden';
4901
5075
  };
4902
5076
 
5077
+ /**
5078
+ * @interface
5079
+ */
4903
5080
  declare type HostContextChangedPayload = {
4904
5081
  /**
4905
5082
  * The new context object
@@ -4913,6 +5090,9 @@ declare type HostContextChangedPayload = {
4913
5090
 
4914
5091
  declare type HostContextChangedReasons = 'updated' | 'reparented';
4915
5092
 
5093
+ /**
5094
+ * @interface
5095
+ */
4916
5096
  declare type HostSpecs = {
4917
5097
  /**
4918
5098
  * True if Aero Glass theme is supported on Windows platforms
@@ -4946,6 +5126,8 @@ declare type HostSpecs = {
4946
5126
 
4947
5127
  /**
4948
5128
  * A hotkey binding.
5129
+ *
5130
+ * @interface
4949
5131
  */
4950
5132
  declare type Hotkey = {
4951
5133
  /**
@@ -4982,6 +5164,8 @@ declare type Identity_4 = OpenFin.Identity;
4982
5164
  *
4983
5165
  * @remarks The `uuid` property refers the application that owns the entity, not to the entity itself.
4984
5166
  * The `name` property identifies the entity itself, and must be unique within the application.
5167
+ *
5168
+ * @interface
4985
5169
  */
4986
5170
  declare type Identity_5 = {
4987
5171
  /**
@@ -5032,6 +5216,9 @@ declare type ImageFormatOptions = {
5032
5216
  quality?: number;
5033
5217
  };
5034
5218
 
5219
+ /**
5220
+ * @interface
5221
+ */
5035
5222
  declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
5036
5223
  /**
5037
5224
  * Name of the intent to get info for.
@@ -5053,6 +5240,9 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
5053
5240
 
5054
5241
  declare type InitLayoutOptions_2 = OpenFin.InitLayoutOptions;
5055
5242
 
5243
+ /**
5244
+ * @interface
5245
+ */
5056
5246
  declare type InitLayoutOptions_3 = {
5057
5247
  /**
5058
5248
  * The id attribute of the container where the window's Layout should be initialized. If not provided
@@ -5061,6 +5251,9 @@ declare type InitLayoutOptions_3 = {
5061
5251
  containerId?: string;
5062
5252
  };
5063
5253
 
5254
+ /**
5255
+ * @interface
5256
+ */
5064
5257
  declare type InitPlatformOptions = {
5065
5258
  /**
5066
5259
  * A callback function or an array of constructor callbacks that can be used to extend or replace default Provider behavior.
@@ -5088,12 +5281,18 @@ declare type InputEvent_2 = {
5088
5281
  command?: string;
5089
5282
  };
5090
5283
 
5284
+ /**
5285
+ * @interface
5286
+ */
5091
5287
  declare type InstallationInfo = {
5092
5288
  cachedManifest: any;
5093
5289
  };
5094
5290
 
5095
5291
  declare type InstalledApps = OpenFin.InstalledApps;
5096
5292
 
5293
+ /**
5294
+ * @interface
5295
+ */
5097
5296
  declare type InstalledApps_2 = {
5098
5297
  [key: string]: InstallationInfo;
5099
5298
  };
@@ -5115,6 +5314,9 @@ declare type Intent<MetadataType = IntentMetadata> = {
5115
5314
 
5116
5315
  declare type IntentHandler = (intent: Intent) => void;
5117
5316
 
5317
+ /**
5318
+ * @interface
5319
+ */
5118
5320
  declare type IntentMetadata<TargetType = any> = {
5119
5321
  target?: TargetType;
5120
5322
  resultType?: string;
@@ -5242,10 +5444,11 @@ declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
5242
5444
 
5243
5445
  /**
5244
5446
  * Define whether to enable interop action logging.
5447
+ *
5245
5448
  */
5246
- declare interface InteropActionLoggingOption {
5449
+ declare type InteropActionLoggingOption = {
5247
5450
  enabled: boolean;
5248
- }
5451
+ };
5249
5452
 
5250
5453
  /**
5251
5454
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
@@ -5914,12 +6117,18 @@ declare class InteropBroker extends Base {
5914
6117
  isActionAuthorized(_action: string, _payload: any, _identity: OpenFin.ClientIdentity): Promise<boolean> | boolean;
5915
6118
  }
5916
6119
 
6120
+ /**
6121
+ * @interface
6122
+ */
5917
6123
  declare type InteropBrokerDisconnectionEvent = {
5918
6124
  type: string;
5919
6125
  topic: string;
5920
6126
  brokerName: string;
5921
6127
  };
5922
6128
 
6129
+ /**
6130
+ * @interface
6131
+ */
5923
6132
  declare type InteropBrokerOptions = {
5924
6133
  contextGroups?: ContextGroupInfo;
5925
6134
  logging?: InteropLoggingOptions;
@@ -6425,8 +6634,14 @@ declare class InteropClient extends Base {
6425
6634
  static ferryFdc3Call(interopClient: OpenFin.InteropClient, action: string, payload?: any): Promise<any>;
6426
6635
  }
6427
6636
 
6637
+ /**
6638
+ * @interface
6639
+ */
6428
6640
  declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
6429
6641
 
6642
+ /**
6643
+ * @interface
6644
+ */
6430
6645
  declare type InteropConfig = {
6431
6646
  /**
6432
6647
  * Context Group for the client. (green, yellow, red, etc.).
@@ -6440,6 +6655,9 @@ declare type InteropConfig = {
6440
6655
 
6441
6656
  declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
6442
6657
 
6658
+ /**
6659
+ * @interface
6660
+ */
6443
6661
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
6444
6662
 
6445
6663
  /**
@@ -6494,6 +6712,9 @@ declare class InteropModule extends Base {
6494
6712
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
6495
6713
  }
6496
6714
 
6715
+ /**
6716
+ * @interface
6717
+ */
6497
6718
  declare type JumpListCategory = {
6498
6719
  /**
6499
6720
  * The display title for the category.
@@ -6510,10 +6731,16 @@ declare type JumpListCategory = {
6510
6731
 
6511
6732
  declare type JumpListItem = JumpListTask | JumpListSeparator;
6512
6733
 
6734
+ /**
6735
+ * @interface
6736
+ */
6513
6737
  declare type JumpListSeparator = {
6514
6738
  type: 'separator';
6515
6739
  };
6516
6740
 
6741
+ /**
6742
+ * @interface
6743
+ */
6517
6744
  declare type JumpListTask = {
6518
6745
  type: 'task';
6519
6746
  /**
@@ -6607,15 +6834,19 @@ export declare function launch(config: ConnectConfig): Promise<number>;
6607
6834
  */
6608
6835
  declare type LaunchEmitter = TypedEventEmitter<AppVersionEvent>;
6609
6836
 
6610
- declare type LaunchExternalProcessListener = {
6611
- (code: ExitCode): void;
6612
- };
6837
+ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
6613
6838
 
6839
+ /**
6840
+ * @interface
6841
+ */
6614
6842
  declare type LaunchExternalProcessRule = {
6615
6843
  behavior: 'allow' | 'block';
6616
6844
  match: string[];
6617
6845
  };
6618
6846
 
6847
+ /**
6848
+ * @interface
6849
+ */
6619
6850
  declare type LaunchIntoPlatformPayload = {
6620
6851
  manifest: any;
6621
6852
  };
@@ -6904,14 +7135,20 @@ declare class Layout extends Base {
6904
7135
  applyPreset: (options: PresetLayoutOptions) => Promise<void>;
6905
7136
  }
6906
7137
 
6907
- declare interface LayoutColumn extends LayoutItemConfig {
7138
+ /**
7139
+ * @interface
7140
+ */
7141
+ declare type LayoutColumn = LayoutItemConfig & {
6908
7142
  type: 'column';
6909
- }
7143
+ };
6910
7144
 
6911
- declare interface LayoutComponent extends LayoutItemConfig {
7145
+ /**
7146
+ * @interface
7147
+ */
7148
+ declare type LayoutComponent = LayoutItemConfig & {
6912
7149
  componentName: 'view';
6913
7150
  componentState?: Partial<ViewCreationOptions>;
6914
- }
7151
+ };
6915
7152
 
6916
7153
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
6917
7154
 
@@ -7043,6 +7280,9 @@ declare class LayoutEntitiesController {
7043
7280
  setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
7044
7281
  }
7045
7282
 
7283
+ /**
7284
+ * @interface
7285
+ */
7046
7286
  declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes = LayoutEntityTypes> = {
7047
7287
  type: TLayoutEntityType;
7048
7288
  entityId: string;
@@ -7065,6 +7305,8 @@ declare type LayoutInitializedEvent = NamedEvent & {
7065
7305
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
7066
7306
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7067
7307
  * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7308
+ *
7309
+ * @interface
7068
7310
  */
7069
7311
  declare type LayoutItemConfig = {
7070
7312
  /**
@@ -7446,6 +7688,9 @@ declare abstract class LayoutNode {
7446
7688
  getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
7447
7689
  }
7448
7690
 
7691
+ /**
7692
+ * @interface
7693
+ */
7449
7694
  declare type LayoutOptions = {
7450
7695
  /**
7451
7696
  * Represents a potential ways to customize behavior of your Layout
@@ -7526,6 +7771,9 @@ declare type LayoutOptions = {
7526
7771
 
7527
7772
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
7528
7773
 
7774
+ /**
7775
+ * @interface
7776
+ */
7529
7777
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
7530
7778
 
7531
7779
  /**
@@ -7539,10 +7787,16 @@ declare type LayoutReadyEvent = NamedEvent & {
7539
7787
  })[];
7540
7788
  };
7541
7789
 
7542
- declare interface LayoutRow extends LayoutItemConfig {
7790
+ /**
7791
+ * @interface
7792
+ */
7793
+ declare type LayoutRow = LayoutItemConfig & {
7543
7794
  type: 'row';
7544
- }
7795
+ };
7545
7796
 
7797
+ /**
7798
+ * @interface
7799
+ */
7546
7800
  declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
7547
7801
 
7548
7802
  declare type Listener<T extends {
@@ -7551,6 +7805,9 @@ declare type Listener<T extends {
7551
7805
 
7552
7806
  declare type LogInfo = OpenFin.LogInfo;
7553
7807
 
7808
+ /**
7809
+ * @interface
7810
+ */
7554
7811
  declare type LogInfo_2 = {
7555
7812
  /**
7556
7813
  * The filename of the log
@@ -7579,6 +7836,9 @@ declare type LogLevel = OpenFin.LogLevel;
7579
7836
  */
7580
7837
  declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
7581
7838
 
7839
+ /**
7840
+ * @interface
7841
+ */
7582
7842
  declare type Manifest = {
7583
7843
  appAssets?: {
7584
7844
  alias: string;
@@ -7644,6 +7904,9 @@ declare type ManifestChangedEvent = IdentityEvent & {
7644
7904
  type: 'manifest-changed';
7645
7905
  };
7646
7906
 
7907
+ /**
7908
+ * @interface
7909
+ */
7647
7910
  declare type ManifestInfo = {
7648
7911
  /**
7649
7912
  * The uuid of the application.
@@ -7657,6 +7920,8 @@ declare type ManifestInfo = {
7657
7920
 
7658
7921
  /**
7659
7922
  * Margins configuration for printing.
7923
+ *
7924
+ * @interface
7660
7925
  */
7661
7926
  declare type Margins = {
7662
7927
  marginType?: 'default' | 'none' | 'printableArea' | 'custom';
@@ -7692,6 +7957,9 @@ declare type Me<MeType extends EntityType_3> = OpenFin.EntityInfo & (MeType exte
7692
7957
  isOpenFin: boolean;
7693
7958
  };
7694
7959
 
7960
+ /**
7961
+ * @interface
7962
+ */
7695
7963
  declare type MenuItemTemplate<T extends unknown = unknown> = {
7696
7964
  /**
7697
7965
  * Can be `normal`, `separator`, `submenu`, or `checkbox`.
@@ -7761,6 +8029,9 @@ declare type MinimizedEvent = NamedEvent & {
7761
8029
  type: 'minimized';
7762
8030
  };
7763
8031
 
8032
+ /**
8033
+ * @interface
8034
+ */
7764
8035
  declare type MonitorDetails = {
7765
8036
  /**
7766
8037
  * The available DIP scale coordinates.
@@ -7807,6 +8078,9 @@ declare type MonitorEvent = OpenFin.MonitorInfo & {
7807
8078
  type: 'monitor-info-changed';
7808
8079
  };
7809
8080
 
8081
+ /**
8082
+ * @interface
8083
+ */
7810
8084
  declare type MonitorInfo = {
7811
8085
  /**
7812
8086
  * The device scale factor.
@@ -7826,6 +8100,9 @@ declare type MonitorInfo = {
7826
8100
  virtualScreen: DipRect;
7827
8101
  };
7828
8102
 
8103
+ /**
8104
+ * @interface
8105
+ */
7829
8106
  declare type MutableViewOptions = {
7830
8107
  autoResize: AutoResizeOptions;
7831
8108
  /**
@@ -7911,6 +8188,8 @@ declare type MutableViewOptions = {
7911
8188
 
7912
8189
  /**
7913
8190
  * Window options that can be changed after window creation.
8191
+ *
8192
+ * @interface
7914
8193
  */
7915
8194
  declare type MutableWindowOptions = {
7916
8195
  /**
@@ -8163,6 +8442,9 @@ declare type NamedEvent = IdentityEvent & {
8163
8442
  name: string;
8164
8443
  };
8165
8444
 
8445
+ /**
8446
+ * @interface
8447
+ */
8166
8448
  declare type NativeWindowIntegrationProviderAuthorization = {
8167
8449
  authorizedUuid: string;
8168
8450
  };
@@ -8177,6 +8459,9 @@ declare type NavigationRejectedEvent = NamedEvent & {
8177
8459
  url: string;
8178
8460
  };
8179
8461
 
8462
+ /**
8463
+ * @interface
8464
+ */
8180
8465
  declare type NavigationRules = {
8181
8466
  /** @deprecated Use allowlist property instead. */
8182
8467
  whitelist?: string[];
@@ -8590,6 +8875,9 @@ declare type PerformanceReportEvent = Performance & NamedEvent & {
8590
8875
  type: 'performance-report';
8591
8876
  };
8592
8877
 
8878
+ /**
8879
+ * @interface
8880
+ */
8593
8881
  declare type Permissions_2 = {
8594
8882
  Application?: Partial<ApplicationPermissions>;
8595
8883
  System?: Partial<SystemPermissions>;
@@ -9990,6 +10278,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9990
10278
  type: 'platform-snapshot-applied';
9991
10279
  };
9992
10280
 
10281
+ /**
10282
+ * @interface
10283
+ */
9993
10284
  declare type PlatformViewCreationOptions = Partial<ViewOptions>;
9994
10285
 
9995
10286
  /**
@@ -10016,6 +10307,9 @@ declare type PlatformWindowOptions = WindowCreationOptions & {
10016
10307
  stylesheetUrl: string;
10017
10308
  };
10018
10309
 
10310
+ /**
10311
+ * @interface
10312
+ */
10019
10313
  declare type Point = {
10020
10314
  /**
10021
10315
  * The mouse x position
@@ -10027,6 +10321,9 @@ declare type Point = {
10027
10321
  y: number;
10028
10322
  };
10029
10323
 
10324
+ /**
10325
+ * @interface
10326
+ */
10030
10327
  declare type PointTopLeft = {
10031
10328
  /**
10032
10329
  * The mouse top position in virtual screen coordinates
@@ -10046,8 +10343,10 @@ declare type PopupInteraction = 'clicked' | 'dismissed';
10046
10343
 
10047
10344
  /**
10048
10345
  * Popup window options.
10346
+ *
10347
+ * @interface
10049
10348
  */
10050
- declare interface PopupOptions {
10349
+ declare type PopupOptions = {
10051
10350
  /**
10052
10351
  * Window creation options when using `showPopupWindow` to create a new window.
10053
10352
  */
@@ -10121,14 +10420,15 @@ declare interface PopupOptions {
10121
10420
  * <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
10122
10421
  */
10123
10422
  onPopupResult?: (payload: PopupResult) => any;
10124
- }
10423
+ };
10125
10424
 
10126
10425
  /**
10127
10426
  * The Popup result.
10128
10427
  *
10129
10428
  * @typeParam T - Type of data the Popup result contains
10429
+ * @interface
10130
10430
  */
10131
- declare interface PopupResult<T = any> {
10431
+ declare type PopupResult<T = any> = {
10132
10432
  /**
10133
10433
  * `name` and `uuid` of the popup window that called dispatched this result.
10134
10434
  */
@@ -10148,7 +10448,7 @@ declare interface PopupResult<T = any> {
10148
10448
  * The last dispatch result.
10149
10449
  */
10150
10450
  lastDispatchResult?: PopupResult;
10151
- }
10451
+ };
10152
10452
 
10153
10453
  declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
10154
10454
 
@@ -10177,14 +10477,17 @@ declare type Position = TransitionBase & {
10177
10477
  fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
10178
10478
  ```
10179
10479
  */
10180
- declare interface PositioningOptions {
10480
+ /**
10481
+ * @interface
10482
+ */
10483
+ declare type PositioningOptions = {
10181
10484
  /**
10182
10485
  * Windows Only.
10183
10486
  * If set to true, will not restore a maximized window before setting the bounds.
10184
10487
  * This will have the effect of the maximized window staying maximized and not immediately taking this new position.
10185
10488
  */
10186
10489
  skipRestore?: boolean;
10187
- }
10490
+ };
10188
10491
 
10189
10492
  /**
10190
10493
  * Context menu item with an implementation provided by OpenFin.
@@ -10193,6 +10496,8 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
10193
10496
 
10194
10497
  /**
10195
10498
  * A script that is run before page load.
10499
+ *
10500
+ * @interface
10196
10501
  */
10197
10502
  declare type PreloadScript = {
10198
10503
  /**
@@ -10253,6 +10558,9 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
10253
10558
 
10254
10559
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
10255
10560
 
10561
+ /**
10562
+ * @interface
10563
+ */
10256
10564
  declare type PresetLayoutOptions_2 = {
10257
10565
  /**
10258
10566
  * Which preset layout arrangement to use.
@@ -10263,6 +10571,9 @@ declare type PresetLayoutOptions_2 = {
10263
10571
 
10264
10572
  declare type PrinterInfo = OpenFin.PrinterInfo;
10265
10573
 
10574
+ /**
10575
+ * @interface
10576
+ */
10266
10577
  declare type PrinterInfo_2 = {
10267
10578
  name: string;
10268
10579
  description: string;
@@ -10272,6 +10583,8 @@ declare type PrinterInfo_2 = {
10272
10583
 
10273
10584
  /**
10274
10585
  * Options for printing a webpage in OpenFin.
10586
+ *
10587
+ * @interface
10275
10588
  */
10276
10589
  declare type PrintOptions = {
10277
10590
  content?: 'self';
@@ -10337,6 +10650,9 @@ declare type PrintOptions = {
10337
10650
  */
10338
10651
  declare type ProcessAffinityStrategy = 'same' | 'different';
10339
10652
 
10653
+ /**
10654
+ * @interface
10655
+ */
10340
10656
  declare type ProcessDetails = {
10341
10657
  /**
10342
10658
  * The percentage of total CPU usage.
@@ -10384,8 +10700,10 @@ declare type ProcessDetails = {
10384
10700
 
10385
10701
  /**
10386
10702
  * Process logging options
10703
+ *
10704
+ * @interface
10387
10705
  */
10388
- declare interface ProcessLoggingOptions {
10706
+ declare type ProcessLoggingOptions = {
10389
10707
  /**
10390
10708
  * Periodic Logging Interval (in seconds)
10391
10709
  */
@@ -10403,7 +10721,7 @@ declare interface ProcessLoggingOptions {
10403
10721
  */
10404
10722
  entries?: number;
10405
10723
  };
10406
- }
10724
+ };
10407
10725
 
10408
10726
  /**
10409
10727
  * A propagated Application event.
@@ -10710,6 +11028,9 @@ declare type ProviderIdentity_7 = Identity_5 & {
10710
11028
 
10711
11029
  declare type ProxyConfig = OpenFin.ProxyConfig;
10712
11030
 
11031
+ /**
11032
+ * @interface
11033
+ */
10713
11034
  declare type ProxyConfig_2 = {
10714
11035
  /**
10715
11036
  * The configured proxy address.
@@ -10724,11 +11045,17 @@ declare type ProxyConfig_2 = {
10724
11045
 
10725
11046
  declare type ProxyInfo = OpenFin.ProxyInfo;
10726
11047
 
11048
+ /**
11049
+ * @interface
11050
+ */
10727
11051
  declare type ProxyInfo_2 = {
10728
11052
  config: ProxyConfig_2;
10729
11053
  system: ProxySystemInfo;
10730
11054
  };
10731
11055
 
11056
+ /**
11057
+ * @interface
11058
+ */
10732
11059
  declare type ProxySystemInfo = {
10733
11060
  /**
10734
11061
  * The auto configuration url.
@@ -10748,6 +11075,9 @@ declare type ProxySystemInfo = {
10748
11075
  proxy: string;
10749
11076
  };
10750
11077
 
11078
+ /**
11079
+ * @interface
11080
+ */
10751
11081
  declare type QueryPermissionResult = {
10752
11082
  /**
10753
11083
  * The full name of a secured API.
@@ -10773,6 +11103,8 @@ declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptio
10773
11103
  * A rectangular area on the screen.
10774
11104
  *
10775
11105
  * @remarks Origin is top-left. All numbers are in pixels.
11106
+ *
11107
+ * @interface
10776
11108
  */
10777
11109
  declare type Rectangle = {
10778
11110
  /**
@@ -10793,6 +11125,9 @@ declare type Rectangle = {
10793
11125
  height: number;
10794
11126
  };
10795
11127
 
11128
+ /**
11129
+ * @interface
11130
+ */
10796
11131
  declare type RectangleByEdgePositions = {
10797
11132
  top: number;
10798
11133
  left: number;
@@ -10808,6 +11143,9 @@ declare type RegisteredEvent = BaseEvent & {
10808
11143
  type: 'registered';
10809
11144
  };
10810
11145
 
11146
+ /**
11147
+ * @interface
11148
+ */
10811
11149
  declare type RegisterUsageData = {
10812
11150
  data: unknown;
10813
11151
  type: string;
@@ -10815,6 +11153,9 @@ declare type RegisterUsageData = {
10815
11153
 
10816
11154
  declare type RegistryInfo = OpenFin.RegistryInfo;
10817
11155
 
11156
+ /**
11157
+ * @interface
11158
+ */
10818
11159
  declare type RegistryInfo_2 = {
10819
11160
  data: any;
10820
11161
  rootKey: string;
@@ -10836,6 +11177,9 @@ declare interface RemoteConfig extends ExistingConnectConfig {
10836
11177
  token: string;
10837
11178
  }
10838
11179
 
11180
+ /**
11181
+ * @interface
11182
+ */
10839
11183
  declare type ReplaceLayoutOpts = {
10840
11184
  /**
10841
11185
  * Layout config to be applied.
@@ -10843,6 +11187,9 @@ declare type ReplaceLayoutOpts = {
10843
11187
  layout: LayoutOptions;
10844
11188
  };
10845
11189
 
11190
+ /**
11191
+ * @interface
11192
+ */
10846
11193
  declare type ReplaceLayoutPayload = {
10847
11194
  /**
10848
11195
  * Object containing the layout to be applied.
@@ -10854,6 +11201,9 @@ declare type ReplaceLayoutPayload = {
10854
11201
  target: Identity_5;
10855
11202
  };
10856
11203
 
11204
+ /**
11205
+ * @interface
11206
+ */
10857
11207
  declare type ReplaceViewPayload = {
10858
11208
  opts: {
10859
11209
  viewToReplace: Identity_5;
@@ -10864,6 +11214,8 @@ declare type ReplaceViewPayload = {
10864
11214
 
10865
11215
  /**
10866
11216
  * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
11217
+ *
11218
+ * @interface
10867
11219
  */
10868
11220
  declare type ResizeRegion = {
10869
11221
  /**
@@ -10943,6 +11295,9 @@ declare type RespondingEvent = IdentityEvent & {
10943
11295
 
10944
11296
  declare type ResultBehavior = 'close' | 'hide' | 'none';
10945
11297
 
11298
+ /**
11299
+ * @interface
11300
+ */
10946
11301
  declare type RGB = {
10947
11302
  red: number;
10948
11303
  blue: number;
@@ -11017,6 +11372,8 @@ declare type RuntimeConfig = {
11017
11372
 
11018
11373
  /**
11019
11374
  * The options object required by the downloadRuntime function.
11375
+ *
11376
+ * @interface
11020
11377
  */
11021
11378
  declare type RuntimeDownloadOptions = {
11022
11379
  /**
@@ -11025,6 +11382,9 @@ declare type RuntimeDownloadOptions = {
11025
11382
  version: string;
11026
11383
  };
11027
11384
 
11385
+ /**
11386
+ * @interface
11387
+ */
11028
11388
  declare type RuntimeDownloadProgress = {
11029
11389
  /**
11030
11390
  * @property { string } alias The name of the asset
@@ -11038,6 +11398,9 @@ declare type RuntimeErrorPayload = {
11038
11398
  error?: ErrorPlainObject;
11039
11399
  };
11040
11400
 
11401
+ /**
11402
+ * @interface
11403
+ */
11041
11404
  declare type RuntimeInfo = {
11042
11405
  /**
11043
11406
  * The runtime build architecture.
@@ -11068,6 +11431,9 @@ declare type RuntimeInfo = {
11068
11431
  devtoolsPort?: number;
11069
11432
  };
11070
11433
 
11434
+ /**
11435
+ * @interface
11436
+ */
11071
11437
  declare type RVMInfo = {
11072
11438
  /**
11073
11439
  * The name of action: "get-rvm-info".
@@ -11095,6 +11461,9 @@ declare type RVMInfo = {
11095
11461
  'working-dir': string;
11096
11462
  };
11097
11463
 
11464
+ /**
11465
+ * @interface
11466
+ */
11098
11467
  declare type RvmLaunchOptions = {
11099
11468
  /**
11100
11469
  * True if no UI when launching
@@ -11111,6 +11480,9 @@ declare type RvmLaunchOptions = {
11111
11480
  subscribe?: (launch: LaunchEmitter) => void;
11112
11481
  };
11113
11482
 
11483
+ /**
11484
+ * @interface
11485
+ */
11114
11486
  declare type ScreenshotPrintOptions = {
11115
11487
  content: 'screenshot';
11116
11488
  };
@@ -11119,6 +11491,9 @@ declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
11119
11491
  data: ProtocolMap[T]['response'];
11120
11492
  } & ProtocolMap[T]['specialResponse']>;
11121
11493
 
11494
+ /**
11495
+ * @interface
11496
+ */
11122
11497
  declare type SendApplicationLogResponse = {
11123
11498
  logId: string;
11124
11499
  };
@@ -11133,6 +11508,9 @@ declare type ServiceConfig = {
11133
11508
  manifestUrl: string;
11134
11509
  };
11135
11510
 
11511
+ /**
11512
+ * @interface
11513
+ */
11136
11514
  declare type ServiceConfiguration = {
11137
11515
  config: object;
11138
11516
  /**
@@ -11141,6 +11519,9 @@ declare type ServiceConfiguration = {
11141
11519
  name: string;
11142
11520
  };
11143
11521
 
11522
+ /**
11523
+ * @interface
11524
+ */
11144
11525
  declare type ServiceIdentifier = {
11145
11526
  /**
11146
11527
  * The name of the service.
@@ -11157,6 +11538,9 @@ declare type SessionChangedEvent = {
11157
11538
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
11158
11539
  };
11159
11540
 
11541
+ /**
11542
+ * @interface
11543
+ */
11160
11544
  declare type SessionContextGroup = {
11161
11545
  id: string;
11162
11546
  setContext: (context: Context) => Promise<void>;
@@ -11166,6 +11550,9 @@ declare type SessionContextGroup = {
11166
11550
  }>;
11167
11551
  };
11168
11552
 
11553
+ /**
11554
+ * @interface
11555
+ */
11169
11556
  declare type SetWindowContextPayload = {
11170
11557
  /**
11171
11558
  * The requested context update.
@@ -11181,11 +11568,17 @@ declare type SetWindowContextPayload = {
11181
11568
  target: Identity_5;
11182
11569
  };
11183
11570
 
11571
+ /**
11572
+ * @interface
11573
+ */
11184
11574
  declare type SharedWorkerInfo = {
11185
11575
  id: string;
11186
11576
  url: string;
11187
11577
  };
11188
11578
 
11579
+ /**
11580
+ * @interface
11581
+ */
11189
11582
  declare type ShortCutConfig = {
11190
11583
  /**
11191
11584
  * True if application has a shortcut on the desktop.
@@ -11216,6 +11609,9 @@ declare type ShownEvent = BaseViewEvent & {
11216
11609
  type: 'shown';
11217
11610
  };
11218
11611
 
11612
+ /**
11613
+ * @interface
11614
+ */
11219
11615
  declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
11220
11616
  template: MenuItemTemplate<T>[];
11221
11617
  x?: number;
@@ -11224,6 +11620,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
11224
11620
 
11225
11621
  /**
11226
11622
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
11623
+ *
11227
11624
  * @interface
11228
11625
  */
11229
11626
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
@@ -11255,6 +11652,9 @@ declare type Size = TransitionBase & {
11255
11652
  height: number;
11256
11653
  };
11257
11654
 
11655
+ /**
11656
+ * @interface
11657
+ */
11258
11658
  declare type Snapshot = {
11259
11659
  windows: WindowCreationOptions[];
11260
11660
  snapshotDetails?: {
@@ -11267,6 +11667,9 @@ declare type Snapshot = {
11267
11667
  };
11268
11668
  };
11269
11669
 
11670
+ /**
11671
+ * @interface
11672
+ */
11270
11673
  declare type SnapshotProvider<Snapshot = unknown> = {
11271
11674
  getSnapshot: () => Promise<Snapshot>;
11272
11675
  applySnapshot: (snapshot: Snapshot) => Promise<void>;
@@ -11416,6 +11819,9 @@ declare type StartedEvent = IdentityEvent & {
11416
11819
  type: 'started';
11417
11820
  };
11418
11821
 
11822
+ /**
11823
+ * @interface
11824
+ */
11419
11825
  declare type SubscriptionOptions = {
11420
11826
  /**
11421
11827
  * The event timestamp.
@@ -12911,6 +13317,9 @@ declare namespace SystemEvents {
12911
13317
  */
12912
13318
  declare type SystemEventType = SystemEvent['type'];
12913
13319
 
13320
+ /**
13321
+ * @interface
13322
+ */
12914
13323
  declare type SystemPermissions = {
12915
13324
  getAllExternalWindows: boolean;
12916
13325
  launchExternalProcess: boolean | {
@@ -12938,6 +13347,9 @@ declare type SystemPermissions = {
12938
13347
  };
12939
13348
  };
12940
13349
 
13350
+ /**
13351
+ * @interface
13352
+ */
12941
13353
  declare type SystemProcessInfo = {
12942
13354
  apps: AppProcessInfo[];
12943
13355
  browserProcess: NonAppProcessDetails;
@@ -13223,6 +13635,9 @@ declare type TaskBar = DipScaleRects & {
13223
13635
  rect: RectangleByEdgePositions;
13224
13636
  };
13225
13637
 
13638
+ /**
13639
+ * @interface
13640
+ */
13226
13641
  declare type TerminateExternalRequestType = {
13227
13642
  /**
13228
13643
  * The uuid of the running application.
@@ -13238,6 +13653,9 @@ declare type TerminateExternalRequestType = {
13238
13653
  killTree: boolean;
13239
13654
  };
13240
13655
 
13656
+ /**
13657
+ * @interface
13658
+ */
13241
13659
  declare type Time = {
13242
13660
  /**
13243
13661
  * The number of milliseconds the CPU has spent in user mode.
@@ -13261,6 +13679,9 @@ declare type Time = {
13261
13679
  irq: number;
13262
13680
  };
13263
13681
 
13682
+ /**
13683
+ * @interface
13684
+ */
13264
13685
  declare type Transition = {
13265
13686
  opacity?: Opacity;
13266
13687
  position?: Position;
@@ -13269,6 +13690,8 @@ declare type Transition = {
13269
13690
 
13270
13691
  /**
13271
13692
  * Base configuration options needed for all types of transitions.
13693
+ *
13694
+ * @interface
13272
13695
  */
13273
13696
  declare type TransitionBase = {
13274
13697
  /**
@@ -13285,6 +13708,8 @@ declare type TransitionBase = {
13285
13708
 
13286
13709
  /**
13287
13710
  * Configuration for transition between windows.
13711
+ *
13712
+ * @interface
13288
13713
  */
13289
13714
  declare type TransitionOptions = {
13290
13715
  /**
@@ -13345,6 +13770,9 @@ declare type TrayIconClickedEvent = IdentityEvent & {
13345
13770
  monitorInfo: any;
13346
13771
  };
13347
13772
 
13773
+ /**
13774
+ * @interface
13775
+ */
13348
13776
  declare type TrayInfo = {
13349
13777
  /**
13350
13778
  * The bound of tray icon in virtual screen pixels.
@@ -13394,9 +13822,14 @@ declare type UnregisteredEvent = BaseEvent & {
13394
13822
 
13395
13823
  /**
13396
13824
  * View options that can be updated after creation.
13825
+ *
13826
+ * @interface
13397
13827
  */
13398
13828
  declare type UpdatableViewOptions = Partial<MutableViewOptions>;
13399
13829
 
13830
+ /**
13831
+ * @interface
13832
+ */
13400
13833
  declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
13401
13834
 
13402
13835
  /**
@@ -14100,6 +14533,9 @@ declare namespace ViewEvents {
14100
14533
  */
14101
14534
  declare type ViewEventType = ViewEvent['type'];
14102
14535
 
14536
+ /**
14537
+ * @interface
14538
+ */
14103
14539
  declare type ViewInfo = {
14104
14540
  canNavigateBack: boolean;
14105
14541
  canNavigateForward: boolean;
@@ -14234,6 +14670,7 @@ declare class ViewOverlay {
14234
14670
 
14235
14671
  /**
14236
14672
  * Represents the payload shape for Views that are trying to prevent an unload.
14673
+ * @interface
14237
14674
  */
14238
14675
  declare interface ViewsPreventingUnloadPayload {
14239
14676
  /**
@@ -14269,6 +14706,8 @@ declare type ViewState = ViewCreationOptions & {
14269
14706
  };
14270
14707
 
14271
14708
  /**
14709
+ * @interface
14710
+ *
14272
14711
  * The statuses of views specifying which of them are trying to prevent an unload and which are not.
14273
14712
  */
14274
14713
  declare interface ViewStatuses {
@@ -14284,6 +14723,8 @@ declare interface ViewStatuses {
14284
14723
 
14285
14724
  /**
14286
14725
  * Configuration for view visibility settings
14726
+ *
14727
+ * @interface
14287
14728
  */
14288
14729
  declare type ViewVisibilityOption = {
14289
14730
  enabled?: boolean;
@@ -14291,6 +14732,8 @@ declare type ViewVisibilityOption = {
14291
14732
 
14292
14733
  /**
14293
14734
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
14735
+ *
14736
+ * @interface
14294
14737
  */
14295
14738
  declare type ViewVisibilityOptions = {
14296
14739
  /**
@@ -16957,6 +17400,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16957
17400
 
16958
17401
  declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
16959
17402
 
17403
+ /**
17404
+ * @interface
17405
+ */
16960
17406
  declare type WindowDetail = {
16961
17407
  /**
16962
17408
  * The bottom-most coordinate of the window.
@@ -17087,6 +17533,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
17087
17533
  type: 'hotkey';
17088
17534
  };
17089
17535
 
17536
+ /**
17537
+ * @interface
17538
+ */
17090
17539
  declare type WindowInfo = {
17091
17540
  canNavigateBack: boolean;
17092
17541
  canNavigateForward: boolean;
@@ -17202,6 +17651,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
17202
17651
  type: 'window-not-responding';
17203
17652
  };
17204
17653
 
17654
+ /**
17655
+ * @interface
17656
+ */
17205
17657
  declare type WindowOptionDiff = {
17206
17658
  [key in keyof WindowOptions]: {
17207
17659
  oldVal: WindowOptions[key];
@@ -17275,6 +17727,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
17275
17727
  */
17276
17728
  declare type WindowState = 'maximized' | 'minimized' | 'normal';
17277
17729
 
17730
+ /**
17731
+ * @interface
17732
+ */
17278
17733
  declare type WindowViewsPrintOptions = {
17279
17734
  content: 'views';
17280
17735
  includeSelf?: boolean;
@@ -17310,6 +17765,10 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
17310
17765
  positioningOptions?: OpenFin.PositioningOptions;
17311
17766
  };
17312
17767
 
17768
+ /**
17769
+ * @internal
17770
+ * @interface
17771
+ */
17313
17772
  declare type WorkspacePlatformOptions = {
17314
17773
  /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
17315
17774
  [key: string]: any;
@@ -17331,6 +17790,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
17331
17790
  * @deprecated - instead use WriteAnyClipboardRequest
17332
17791
  *
17333
17792
  * A generic request to write any supported data to the clipboard.
17793
+ *
17794
+ * @interface
17334
17795
  */
17335
17796
  declare type WriteAnyRequestType = WriteAnyClipboardRequest;
17336
17797
 
@@ -17361,6 +17822,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
17361
17822
  * @deprecated - instead use OpenFin.WriteClipboardRequest
17362
17823
  *
17363
17824
  * A request to write data to the clipboard.
17825
+ *
17826
+ * @interface
17364
17827
  */
17365
17828
  declare type WriteRequestType = WriteClipboardRequest;
17366
17829