@openfin/core 34.78.7 → 34.78.10

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.
@@ -52,6 +52,7 @@ declare type AddViewToStackOptions = {
52
52
 
53
53
  /**
54
54
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
55
+ * @interface
55
56
  */
56
57
  declare type AlertRequestedEvent = NamedEvent & {
57
58
  type: 'alert-requested';
@@ -810,6 +811,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
810
811
 
811
812
  /**
812
813
  * Generated when an application has authenticated and is connected.
814
+ * @interface
813
815
  */
814
816
  declare type ApplicationConnectedEvent = IdentityEvent & {
815
817
  type: 'connected';
@@ -817,6 +819,7 @@ declare type ApplicationConnectedEvent = IdentityEvent & {
817
819
 
818
820
  /**
819
821
  * Generated when an application is created.
822
+ * @interface
820
823
  */
821
824
  declare type ApplicationCreatedEvent = IdentityEvent & {
822
825
  type: 'application-created';
@@ -831,11 +834,10 @@ declare type ApplicationCreatedEvent = IdentityEvent & {
831
834
  * * `url` is optional in both the app manifest {@link Application.ApplicationModule.start Application.start} and but is usually given
832
835
  * (defaults to `"about:blank"` when omitted).
833
836
  *
834
- * _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
835
- *
836
837
  * **IMPORTANT NOTE:**
837
838
  * This object inherits all the properties of the window creation {@link OpenFin.WindowCreationOptions options} object,
838
839
  * which will take priority over those of the same name that may be provided in `mainWindowOptions`.
840
+ * @interface
839
841
  */
840
842
  declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
841
843
  name: string;
@@ -843,7 +845,10 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
843
845
  };
844
846
 
845
847
  /**
846
- * An Application event.
848
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
849
+ * discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
850
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
851
+ * from which they propagate).
847
852
  */
848
853
  declare type ApplicationEvent = {
849
854
  topic: 'application';
@@ -903,6 +908,9 @@ declare type ApplicationInfo = {
903
908
  };
904
909
  };
905
910
 
911
+ /**
912
+ * Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
913
+ */
906
914
  declare class ApplicationModule extends Base {
907
915
  /**
908
916
  * Asynchronously returns an Application object that represents an existing application.
@@ -1083,6 +1091,7 @@ declare class ApplicationModule extends Base {
1083
1091
 
1084
1092
  /**
1085
1093
  * The complete set of options for an application.
1094
+ * @interface
1086
1095
  */
1087
1096
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1088
1097
  /**
@@ -1276,6 +1285,10 @@ declare type AppProcessInfo = {
1276
1285
  entities: EntityProcessDetails[];
1277
1286
  };
1278
1287
 
1288
+ /**
1289
+ * Generated when system app versioning is successfully completed.
1290
+ * @interface
1291
+ */
1279
1292
  declare type AppVersionCompleteEvent = {
1280
1293
  type: 'app-version-complete';
1281
1294
  } & AppVersionProgress;
@@ -1285,6 +1298,10 @@ declare type AppVersionError = {
1285
1298
  srcManifest: string;
1286
1299
  };
1287
1300
 
1301
+ /**
1302
+ * Generated when none of fallback manifests is compatible to the system.
1303
+ * @interface
1304
+ */
1288
1305
  declare type AppVersionErrorEvent = {
1289
1306
  type: 'app-version-error';
1290
1307
  } & AppVersionError;
@@ -1306,6 +1323,10 @@ declare type AppVersionProgress = {
1306
1323
  srcManifest: string;
1307
1324
  };
1308
1325
 
1326
+ /**
1327
+ * Generated during the progress of system app versioning.
1328
+ * @interface
1329
+ */
1309
1330
  declare type AppVersionProgressEvent = {
1310
1331
  type: 'app-version-progress';
1311
1332
  } & AppVersionProgress;
@@ -1319,6 +1340,10 @@ declare type AppVersionRuntimeInfo = {
1319
1340
  error: string | null;
1320
1341
  };
1321
1342
 
1343
+ /**
1344
+ * Generated when checking a runtime availability.
1345
+ * @interface
1346
+ */
1322
1347
  declare type AppVersionRuntimeStatusEvent = {
1323
1348
  type: 'runtime-status';
1324
1349
  } & AppVersionRuntimeInfo;
@@ -1327,6 +1352,7 @@ declare type AppVersionRuntimeStatusEvent = {
1327
1352
 
1328
1353
  /**
1329
1354
  * Generated when a View is attached to a window.
1355
+ * @interface
1330
1356
  */
1331
1357
  declare type AttachedEvent = BaseViewEvent & {
1332
1358
  type: 'attached';
@@ -1399,6 +1425,7 @@ declare interface AuthorizationPayload {
1399
1425
  * }
1400
1426
  * });
1401
1427
  * ```
1428
+ * @interface
1402
1429
  */
1403
1430
  declare type AuthRequestedEvent = NamedEvent & {
1404
1431
  type: 'auth-requested';
@@ -1453,6 +1480,7 @@ declare class Base {
1453
1480
 
1454
1481
  /**
1455
1482
  * A base Channel event.
1483
+ * @interface
1456
1484
  */
1457
1485
  declare type BaseChannelEvent = NamedEvent & {
1458
1486
  channelName: string;
@@ -1519,6 +1547,7 @@ declare namespace BaseEvents {
1519
1547
 
1520
1548
  /**
1521
1549
  * The base frame event.
1550
+ * @interface
1522
1551
  */
1523
1552
  declare type BaseFrameEvent = NamedEvent & {
1524
1553
  entityType: 'iframe';
@@ -1539,12 +1568,16 @@ declare type BaseUrlEvent = NamedEvent & {
1539
1568
 
1540
1569
  /**
1541
1570
  * A base View event.
1571
+ * @interface
1542
1572
  */
1543
1573
  declare type BaseViewEvent = NamedEvent & {
1544
1574
  target: OpenFin_2.Identity;
1545
1575
  viewIdentity: OpenFin_2.Identity;
1546
1576
  };
1547
1577
 
1578
+ /**
1579
+ * User decision of whether a Window or specific View should close when trying to prevent an unload.
1580
+ */
1548
1581
  declare interface BeforeUnloadUserDecision {
1549
1582
  /**
1550
1583
  * Specifies if the Window should close.
@@ -1558,6 +1591,7 @@ declare interface BeforeUnloadUserDecision {
1558
1591
 
1559
1592
  /**
1560
1593
  * Generated at the beginning of a user-driven change to a window's size or position.
1594
+ * @interface
1561
1595
  */
1562
1596
  declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1563
1597
  type: 'begin-user-bounds-changing';
@@ -1565,6 +1599,7 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1565
1599
 
1566
1600
  /**
1567
1601
  * Generated when a WebContents loses focus.
1602
+ * @interface
1568
1603
  */
1569
1604
  declare type BlurredEvent = NamedEvent & {
1570
1605
  type: 'blurred';
@@ -1579,6 +1614,7 @@ declare type Bounds = {
1579
1614
 
1580
1615
  /**
1581
1616
  * Generated after changes in a window's size and/or position.
1617
+ * @interface
1582
1618
  */
1583
1619
  declare type BoundsChangedEvent = BoundsChangeEvent & {
1584
1620
  type: 'bounds-changed';
@@ -1586,6 +1622,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1586
1622
 
1587
1623
  /**
1588
1624
  * A general bounds change event without event type.
1625
+ * @interface
1589
1626
  */
1590
1627
  declare type BoundsChangeEvent = NamedEvent & {
1591
1628
  changeType: 0 | 1 | 2;
@@ -1598,6 +1635,7 @@ declare type BoundsChangeEvent = NamedEvent & {
1598
1635
 
1599
1636
  /**
1600
1637
  * Generated during changes to a window's size and/or position.
1638
+ * @interface
1601
1639
  */
1602
1640
  declare type BoundsChangingEvent = BoundsChangeEvent & {
1603
1641
  type: 'bounds-changing';
@@ -1640,6 +1678,7 @@ declare type Certificate = {
1640
1678
 
1641
1679
  /**
1642
1680
  * Generated when navigating to a URL that fails certificate validation.
1681
+ * @interface
1643
1682
  */
1644
1683
  declare type CertificateErrorEvent = NamedEvent & {
1645
1684
  type: 'certificate-error';
@@ -1659,6 +1698,7 @@ declare type CertificatePrincipal = {
1659
1698
 
1660
1699
  /**
1661
1700
  * Generated when the certificate selection dialog is shown.
1701
+ * @interface
1662
1702
  */
1663
1703
  declare type CertificateSelectionShownEvent = NamedEvent & {
1664
1704
  type: 'certificate-selection-shown';
@@ -1856,7 +1896,7 @@ declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
1856
1896
 
1857
1897
  declare type ChannelAction = OpenFin_2.ChannelAction;
1858
1898
 
1859
- declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_8 | ClientIdentity_2) => unknown;
1899
+ declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
1860
1900
 
1861
1901
  declare class ChannelBase {
1862
1902
  protected subscriptions: Map<string, ChannelAction>;
@@ -2135,17 +2175,17 @@ declare class ChannelBase {
2135
2175
  * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
2136
2176
  * from the provider by registering an action via {@link ChannelClient#register register}.
2137
2177
  *
2138
- * Synchronous Methods:
2178
+ * ### Synchronous Methods:
2139
2179
  * * {@link ChannelClient#onDisconnection onDisconnection(listener)}
2140
2180
  * * {@link ChannelClient#register register(action, listener)}
2141
2181
  * * {@link ChannelClient#remove remove(action)}
2142
2182
  *
2143
- * Asynchronous Methods:
2183
+ * ### Asynchronous Methods:
2144
2184
  * * {@link ChannelClient#disconnect disconnect()}
2145
2185
  * * {@link ChannelClient#dispatch dispatch(action, payload)}
2146
2186
  *
2147
- * Middleware:
2148
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
2187
+ * ### Middleware:
2188
+ * Middleware functions receive the following arguments: (action, payload, senderId).
2149
2189
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
2150
2190
  * unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
2151
2191
  * * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
@@ -2160,11 +2200,11 @@ declare class ChannelClient extends ChannelBase {
2160
2200
  /* Excluded from this release type: closeChannelByEndpointId */
2161
2201
  /* Excluded from this release type: handleProviderDisconnect */
2162
2202
  /* Excluded from this release type: __constructor */
2163
- protected processAction: (action: string, payload: any, senderIdentity: ProviderIdentity_3 | OpenFin_2.ClientIdentity) => Promise<any>;
2203
+ protected processAction: (action: string, payload: any, senderIdentity: OpenFin_2.ProviderIdentity | OpenFin_2.ClientIdentity) => Promise<any>;
2164
2204
  /**
2165
2205
  * a read-only provider identity
2166
2206
  */
2167
- get providerIdentity(): ProviderIdentity_3;
2207
+ get providerIdentity(): OpenFin_2.ProviderIdentity;
2168
2208
  /**
2169
2209
  * Dispatch the given action to the channel provider. Returns a promise that resolves with the response from
2170
2210
  * the provider for that action.
@@ -2231,6 +2271,7 @@ declare type ChannelClient_2 = OpenFin_2.ChannelClient;
2231
2271
 
2232
2272
  /**
2233
2273
  * Generated when a Channel client is connected.
2274
+ * @interface
2234
2275
  */
2235
2276
  declare type ChannelConnectedEvent = BaseChannelEvent & {
2236
2277
  type: 'connected';
@@ -2239,6 +2280,7 @@ declare type ChannelConnectedEvent = BaseChannelEvent & {
2239
2280
  /**
2240
2281
  * Options provided on a client connection to a channel.
2241
2282
  *
2283
+ * @interface
2242
2284
  */
2243
2285
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2244
2286
  /**
@@ -2265,6 +2307,7 @@ declare type ChannelCreateOptions = {
2265
2307
 
2266
2308
  /**
2267
2309
  * Generated when a Channel client has disconnected.
2310
+ * @interface
2268
2311
  */
2269
2312
  declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2270
2313
  type: 'disconnected';
@@ -2290,33 +2333,35 @@ declare namespace ChannelEvents {
2290
2333
  }
2291
2334
 
2292
2335
  /**
2293
- * A Channel event type.
2336
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
2337
+ * discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
2338
+ * under the {@link OpenFin.ChannelEvents} namespace.
2294
2339
  */
2295
2340
  declare type ChannelEventType = ChannelEvent['type'];
2296
2341
 
2297
2342
  declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
2298
2343
 
2299
- declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_8 | ClientIdentity_2) => Promise<unknown> | unknown;
2344
+ declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity_2) => Promise<unknown> | unknown;
2300
2345
 
2301
2346
  /**
2302
2347
  * Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
2303
2348
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
2304
2349
  * and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
2305
2350
  *
2306
- * Synchronous Methods:
2351
+ * ### Synchronous Methods:
2307
2352
  * * {@link ChannelProvider#onConnection onConnection(listener)}
2308
2353
  * * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
2309
2354
  * * {@link ChannelProvider#publish publish(action, payload)}
2310
2355
  * * {@link ChannelProvider#register register(action, listener)}
2311
2356
  * * {@link ChannelProvider#remove remove(action)}
2312
2357
  *
2313
- * Asynchronous Methods:
2358
+ * ### Asynchronous Methods:
2314
2359
  * * {@link ChannelProvider#destroy destroy()}
2315
2360
  * * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
2316
2361
  * * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
2317
2362
  *
2318
- * Middleware:
2319
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
2363
+ * ### Middleware:
2364
+ * Middleware functions receive the following arguments: (action, payload, senderId).
2320
2365
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
2321
2366
  * unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
2322
2367
  * * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
@@ -2506,6 +2551,7 @@ declare interface ChannelStrategy<T extends unknown> {
2506
2551
 
2507
2552
  /**
2508
2553
  * Generated when a child content is blocked to load.
2554
+ * @interface
2509
2555
  */
2510
2556
  declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
2511
2557
  type: 'child-content-blocked';
@@ -2513,6 +2559,7 @@ declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
2513
2559
 
2514
2560
  /**
2515
2561
  * Generated when a child content is loaded into a browser.
2562
+ * @interface
2516
2563
  */
2517
2564
  declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
2518
2565
  type: 'child-content-opened-in-browser';
@@ -2525,6 +2572,7 @@ declare interface ChildContentOptions {
2525
2572
 
2526
2573
  /**
2527
2574
  * Generated when a child View is created.
2575
+ * @interface
2528
2576
  */
2529
2577
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
2530
2578
  type: 'child-view-created';
@@ -2536,6 +2584,7 @@ declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
2536
2584
 
2537
2585
  /**
2538
2586
  * Generated when a child Window is created.
2587
+ * @interface
2539
2588
  */
2540
2589
  declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
2541
2590
  type: 'child-window-created';
@@ -2560,9 +2609,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
2560
2609
  private endpointId;
2561
2610
  private providerIdentity;
2562
2611
  constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
2563
- providerIdentity: ProviderIdentity_5);
2612
+ providerIdentity: ProviderIdentity_4);
2564
2613
  onEndpointDisconnect(endpointId: string, listener: () => void): void;
2565
- receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
2614
+ receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
2566
2615
  send: (endpointId: string, action: string, payload: any) => Promise<any>;
2567
2616
  close: () => Promise<void>;
2568
2617
  closeEndpoint(endpointId: string): Promise<void>;
@@ -2595,12 +2644,16 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
2595
2644
  data: T;
2596
2645
  };
2597
2646
 
2647
+ /**
2648
+ * @interface
2649
+ */
2598
2650
  declare type ClientConnectionPayload = ClientIdentity_2 & ClientInfo;
2599
2651
 
2600
2652
  declare type ClientIdentity = OpenFin_2.ClientIdentity;
2601
2653
 
2602
2654
  /**
2603
2655
  * Identity of a channel client
2656
+ * @interface
2604
2657
  */
2605
2658
  declare type ClientIdentity_2 = Identity_5 & {
2606
2659
  /**
@@ -2610,12 +2663,16 @@ declare type ClientIdentity_2 = Identity_5 & {
2610
2663
  isLocalEndpointId: boolean;
2611
2664
  };
2612
2665
 
2666
+ /**
2667
+ * @interface
2668
+ */
2613
2669
  declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
2614
2670
  runtimeUuid: string;
2615
2671
  };
2616
2672
 
2617
2673
  /**
2618
2674
  * Extended channel client information
2675
+ * @interface
2619
2676
  */
2620
2677
  declare type ClientInfo = Omit<ClientIdentity_2, 'isLocalEndpointId'> & {
2621
2678
  /**
@@ -2807,6 +2864,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
2807
2864
 
2808
2865
  /**
2809
2866
  * Generated when an application is closed.
2867
+ * @interface
2810
2868
  */
2811
2869
  declare type ClosedEvent = IdentityEvent & {
2812
2870
  type: 'closed';
@@ -2823,6 +2881,9 @@ declare type CloseViewPayload = {
2823
2881
  view: Identity_5;
2824
2882
  };
2825
2883
 
2884
+ /**
2885
+ * Represents the shape of payload that contains the Window Identity and related options.
2886
+ */
2826
2887
  declare interface CloseWindowPayload {
2827
2888
  /**
2828
2889
  *
@@ -3205,6 +3266,9 @@ declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
3205
3266
  data?: unknown;
3206
3267
  };
3207
3268
 
3269
+ /**
3270
+ * @interface
3271
+ */
3208
3272
  declare type ContentCreationRulesEvent = NamedEvent & {
3209
3273
  /**
3210
3274
  * The absolute url which triggered this event.
@@ -3263,6 +3327,9 @@ declare type Context = {
3263
3327
  type: string;
3264
3328
  };
3265
3329
 
3330
+ /**
3331
+ * @interface
3332
+ */
3266
3333
  declare type ContextForIntent<MetadataType = any> = Context & {
3267
3334
  metadata?: MetadataType;
3268
3335
  };
@@ -3365,6 +3432,7 @@ declare type CpuInfo = {
3365
3432
 
3366
3433
  /**
3367
3434
  * Generated when an application has crashed.
3435
+ * @interface
3368
3436
  */
3369
3437
  declare type CrashedEvent = NamedEvent & {
3370
3438
  type: 'crashed';
@@ -3384,6 +3452,9 @@ declare type CrashReporterOptions = {
3384
3452
  diagnosticsMode: boolean;
3385
3453
  };
3386
3454
 
3455
+ /**
3456
+ * @interface
3457
+ */
3387
3458
  declare type CrashReporterState = CrashReporterOptions & {
3388
3459
  /**
3389
3460
  * Whether the crash reporter is running
@@ -3394,6 +3465,7 @@ declare type CrashReporterState = CrashReporterOptions & {
3394
3465
 
3395
3466
  /**
3396
3467
  * Generated when a View is created.
3468
+ * @interface
3397
3469
  */
3398
3470
  declare type CreatedEvent = BaseViewEvent & {
3399
3471
  type: 'created';
@@ -3411,6 +3483,9 @@ declare type CreateViewPayload = {
3411
3483
  targetView?: Identity_5;
3412
3484
  };
3413
3485
 
3486
+ /**
3487
+ * @interface
3488
+ */
3414
3489
  declare type CreateViewTarget = Identity_5 & {
3415
3490
  /**
3416
3491
  * If specified, view creation will not attach to a window and caller must
@@ -3450,6 +3525,7 @@ declare type DefaultDomainSettingsRule = {
3450
3525
 
3451
3526
  /**
3452
3527
  * Generated when the desktop icon is clicked while it's already running.
3528
+ * @interface
3453
3529
  */
3454
3530
  declare type DesktopIconClickedEvent = BaseEvent & {
3455
3531
  type: 'desktop-icon-clicked';
@@ -3457,6 +3533,7 @@ declare type DesktopIconClickedEvent = BaseEvent & {
3457
3533
 
3458
3534
  /**
3459
3535
  * Generated when a View is destroyed.
3536
+ * @interface
3460
3537
  */
3461
3538
  declare type DestroyedEvent = BaseViewEvent & {
3462
3539
  type: 'destroyed';
@@ -3464,6 +3541,7 @@ declare type DestroyedEvent = BaseViewEvent & {
3464
3541
 
3465
3542
  /**
3466
3543
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
3544
+ * @interface
3467
3545
  */
3468
3546
  declare type DidChangeThemeColorEvent = NamedEvent & {
3469
3547
  type: 'did-change-theme-color';
@@ -3471,6 +3549,7 @@ declare type DidChangeThemeColorEvent = NamedEvent & {
3471
3549
 
3472
3550
  /**
3473
3551
  * Generated when load failed.
3552
+ * @interface
3474
3553
  */
3475
3554
  declare type DidFailLoadEvent = BaseLoadFailedEvent & {
3476
3555
  type: 'did-fail-load';
@@ -3478,11 +3557,15 @@ declare type DidFailLoadEvent = BaseLoadFailedEvent & {
3478
3557
 
3479
3558
  /**
3480
3559
  * Generated when the navigation is done, i.e. the spinner of the tab will stop spinning, and the onload event is dispatched.
3560
+ * @interface
3481
3561
  */
3482
3562
  declare type DidFinishLoadEvent = NamedEvent & {
3483
3563
  type: 'did-finish-load';
3484
3564
  };
3485
3565
 
3566
+ /**
3567
+ * @interface
3568
+ */
3486
3569
  declare type DipRect = RectangleByEdgePositions & {
3487
3570
  dipRect: RectangleByEdgePositions;
3488
3571
  scaledRect: RectangleByEdgePositions;
@@ -3495,6 +3578,7 @@ declare type DipScaleRects = {
3495
3578
 
3496
3579
  /**
3497
3580
  * Generated after a change to a window's size and/or position is attempted while window movement is disabled.
3581
+ * @interface
3498
3582
  */
3499
3583
  declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
3500
3584
  type: 'disabled-movement-bounds-changed';
@@ -3502,12 +3586,13 @@ declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
3502
3586
 
3503
3587
  /**
3504
3588
  * Generated while a change to a window's size and/or position is attempted while window movement is disabled.
3589
+ * @interface
3505
3590
  */
3506
3591
  declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
3507
3592
  type: 'disabled-movement-bounds-changing';
3508
3593
  };
3509
3594
 
3510
- declare type DisconnectionListener = (providerIdentity: ProviderIdentity_3) => any;
3595
+ declare type DisconnectionListener = (providerIdentity: OpenFin_2.ProviderIdentity) => any;
3511
3596
 
3512
3597
  declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
3513
3598
 
@@ -3578,6 +3663,7 @@ declare type Dpi = {
3578
3663
 
3579
3664
  /**
3580
3665
  * Generated when a window has been embedded.
3666
+ * @interface
3581
3667
  */
3582
3668
  declare type EmbeddedEvent = NamedEvent & {
3583
3669
  type: 'embedded';
@@ -3688,6 +3774,7 @@ declare class EmitterMap {
3688
3774
 
3689
3775
  /**
3690
3776
  * Generated when a window ends loading.
3777
+ * @interface
3691
3778
  */
3692
3779
  declare type EndLoadEvent = NamedEvent & {
3693
3780
  type: 'end-load';
@@ -3695,7 +3782,7 @@ declare type EndLoadEvent = NamedEvent & {
3695
3782
  isMain: boolean;
3696
3783
  };
3697
3784
 
3698
- declare type EndpointIdentity = OpenFin_2.ClientIdentity | ProviderIdentity_4;
3785
+ declare type EndpointIdentity = OpenFin_2.ClientIdentity | ProviderIdentity_3;
3699
3786
 
3700
3787
  declare type EndpointPayload = {
3701
3788
  endpointIdentity: EndpointIdentity;
@@ -3703,6 +3790,7 @@ declare type EndpointPayload = {
3703
3790
 
3704
3791
  /**
3705
3792
  * Generated at the end of a user-driven change to a window's size or position.
3793
+ * @interface
3706
3794
  */
3707
3795
  declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
3708
3796
  type: 'end-user-bounds-changing';
@@ -3718,6 +3806,9 @@ declare type EntityInfo_2 = {
3718
3806
  entityType: EntityType;
3719
3807
  };
3720
3808
 
3809
+ /**
3810
+ * @interface
3811
+ */
3721
3812
  declare type EntityProcessDetails = FrameProcessDetails & {
3722
3813
  name: string;
3723
3814
  uuid: string;
@@ -3787,7 +3878,7 @@ declare interface Environment {
3787
3878
 
3788
3879
  declare type ErrorMiddleware = OpenFin_2.ErrorMiddleware;
3789
3880
 
3790
- declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_8 | ClientIdentity_2) => unknown;
3881
+ declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
3791
3882
 
3792
3883
  /**
3793
3884
  * This function converts JS errors into plain objects
@@ -3829,7 +3920,7 @@ declare type ExitCode = {
3829
3920
  /**
3830
3921
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
3831
3922
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
3832
- * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
3923
+ * Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
3833
3924
  *
3834
3925
  * Processes that can be wrapped as `ExternalApplication`s include the following:
3835
3926
  * - Processes which have connected to an OpenFin runtime via an adapter
@@ -3933,6 +4024,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
3933
4024
 
3934
4025
  /**
3935
4026
  * Generated when an external application has authenticated and is connected.
4027
+ * @interface
3936
4028
  */
3937
4029
  declare type ExternalApplicationConnectedEvent = BaseEvent & {
3938
4030
  type: 'connected';
@@ -3940,13 +4032,16 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
3940
4032
 
3941
4033
  /**
3942
4034
  * Generated when an external application has disconnected.
4035
+ * @interface
3943
4036
  */
3944
4037
  declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
3945
4038
  type: 'disconnected';
3946
4039
  };
3947
4040
 
3948
4041
  /**
3949
- * An external application event.
4042
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
4043
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
4044
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
3950
4045
  */
3951
4046
  declare type ExternalApplicationEvent = {
3952
4047
  topic: 'externalapplication';
@@ -3966,6 +4061,9 @@ declare type ExternalApplicationInfo = {
3966
4061
  parent: Identity_5;
3967
4062
  };
3968
4063
 
4064
+ /**
4065
+ * Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
4066
+ */
3969
4067
  declare class ExternalApplicationModule extends Base {
3970
4068
  /**
3971
4069
  * Asynchronously returns an External Application object that represents an external application.
@@ -4010,6 +4108,7 @@ declare type ExternalConnection = {
4010
4108
 
4011
4109
  /**
4012
4110
  * Generated when an external process has exited.
4111
+ * @interface
4013
4112
  */
4014
4113
  declare type ExternalProcessExitedEvent = NamedEvent & {
4015
4114
  type: 'external-process-exited';
@@ -4048,6 +4147,7 @@ declare type ExternalProcessRequestType = {
4048
4147
 
4049
4148
  /**
4050
4149
  * Generated when an external process has started.
4150
+ * @interface
4051
4151
  */
4052
4152
  declare type ExternalProcessStartedEvent = NamedEvent & {
4053
4153
  type: 'external-process-started';
@@ -4056,6 +4156,7 @@ declare type ExternalProcessStartedEvent = NamedEvent & {
4056
4156
 
4057
4157
  /**
4058
4158
  * Generated when page receives favicon urls.
4159
+ * @interface
4059
4160
  */
4060
4161
  declare type FaviconUpdatedEvent = NamedEvent & {
4061
4162
  type: 'page-favicon-updated';
@@ -4073,6 +4174,7 @@ declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
4073
4174
 
4074
4175
  /**
4075
4176
  * Generated when a file download has completed.
4177
+ * @interface
4076
4178
  */
4077
4179
  declare type FileDownloadCompletedEvent = FileDownloadEvent & {
4078
4180
  type: 'file-download-completed';
@@ -4081,6 +4183,7 @@ declare type FileDownloadCompletedEvent = FileDownloadEvent & {
4081
4183
 
4082
4184
  /**
4083
4185
  * A general file download event without event type.
4186
+ * @interface
4084
4187
  */
4085
4188
  declare type FileDownloadEvent = {
4086
4189
  /**
@@ -4132,6 +4235,8 @@ declare type FileDownloadEvent = {
4132
4235
  /**
4133
4236
  * Generated when setFileDownloadLocation api is called.
4134
4237
  * @remarks This event will not include the file download location itself. In order to get the new file download location, the user will have to access the secured query API 'getFileDownloadLocation'.
4238
+ *
4239
+ * @interface
4135
4240
  */
4136
4241
  declare type FileDownloadLocationChangedEvent = NamedEvent & {
4137
4242
  type: 'file-download-location-changed';
@@ -4139,6 +4244,7 @@ declare type FileDownloadLocationChangedEvent = NamedEvent & {
4139
4244
 
4140
4245
  /**
4141
4246
  * Generated during file download progress.
4247
+ * @interface
4142
4248
  */
4143
4249
  declare type FileDownloadProgressEvent = FileDownloadEvent & {
4144
4250
  type: 'file-download-progress';
@@ -4151,6 +4257,7 @@ declare type FileDownloadSettings = {
4151
4257
 
4152
4258
  /**
4153
4259
  * Generated when a file download has started.
4260
+ * @interface
4154
4261
  */
4155
4262
  declare type FileDownloadStartedEvent = FileDownloadEvent & {
4156
4263
  type: 'file-download-started';
@@ -4238,6 +4345,7 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
4238
4345
 
4239
4346
  /**
4240
4347
  * Generated when a WebContents gains focus.
4348
+ * @interface
4241
4349
  */
4242
4350
  declare type FocusedEvent = NamedEvent & {
4243
4351
  type: 'focused';
@@ -4245,6 +4353,7 @@ declare type FocusedEvent = NamedEvent & {
4245
4353
 
4246
4354
  /**
4247
4355
  * Generated when a result is available when calling findInPage.
4356
+ * @interface
4248
4357
  */
4249
4358
  declare type FoundInPageEvent = NamedEvent & {
4250
4359
  type: 'found-in-page';
@@ -4383,6 +4492,7 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
4383
4492
 
4384
4493
  /**
4385
4494
  * Generated when a frame is connected.
4495
+ * @interface
4386
4496
  */
4387
4497
  declare type FrameConnectedEvent = BaseFrameEvent & {
4388
4498
  type: 'connected';
@@ -4390,6 +4500,7 @@ declare type FrameConnectedEvent = BaseFrameEvent & {
4390
4500
 
4391
4501
  /**
4392
4502
  * Generated when a frame has disconnected.
4503
+ * @interface
4393
4504
  */
4394
4505
  declare type FrameDisconnectedEvent = BaseFrameEvent & {
4395
4506
  type: 'disconnected';
@@ -4415,7 +4526,9 @@ declare namespace FrameEvents {
4415
4526
  }
4416
4527
 
4417
4528
  /**
4418
- * A Frame event type.
4529
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
4530
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
4531
+ * under the {@link OpenFin.FrameEvents} namespace.
4419
4532
  */
4420
4533
  declare type FrameEventType = FrameEvent['type'];
4421
4534
 
@@ -4427,6 +4540,9 @@ declare type FrameInfo = {
4427
4540
  parent: Identity_5;
4428
4541
  };
4429
4542
 
4543
+ /**
4544
+ * Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
4545
+ */
4430
4546
  declare class _FrameModule extends Base {
4431
4547
  /**
4432
4548
  * Asynchronously returns a reference to the specified frame. The frame does not have to exist
@@ -4476,6 +4592,9 @@ declare class _FrameModule extends Base {
4476
4592
  getCurrentSync(): OpenFin_2.Frame;
4477
4593
  }
4478
4594
 
4595
+ /**
4596
+ * @interface
4597
+ */
4479
4598
  declare type FrameProcessDetails = ProcessDetails & {
4480
4599
  /**
4481
4600
  * Current URL associated with the process.
@@ -4619,7 +4738,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
4619
4738
  }
4620
4739
 
4621
4740
  /**
4622
- * A global hotkey event.
4741
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
4742
+ * discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
4743
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
4623
4744
  */
4624
4745
  declare type GlobalHotkeyEvent = {
4625
4746
  topic: 'global-hotkey';
@@ -4640,18 +4761,11 @@ declare type GpuInfo = {
4640
4761
  name: string;
4641
4762
  };
4642
4763
 
4643
- /**
4644
- * Generated when a window has been hidden.
4645
- */
4646
- declare type HiddenEvent = NamedEvent & {
4647
- type: 'hidden';
4648
- reason: 'closing' | 'hide' | 'hide-on-close';
4649
- };
4650
-
4651
4764
  /**
4652
4765
  * Generated when a View is hidden.
4766
+ * @interface
4653
4767
  */
4654
- declare type HiddenEvent_2 = BaseViewEvent & {
4768
+ declare type HiddenEvent = BaseViewEvent & {
4655
4769
  type: 'hidden';
4656
4770
  };
4657
4771
 
@@ -4718,6 +4832,7 @@ declare type Hotkey = {
4718
4832
  /**
4719
4833
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [View options](OpenFin.ViewOptions.html) is pressed inside the view.
4720
4834
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
4835
+ * @interface
4721
4836
  */
4722
4837
  declare type HotkeyEvent = BaseViewEvent & {
4723
4838
  type: 'hotkey';
@@ -4752,6 +4867,7 @@ declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<Add
4752
4867
 
4753
4868
  /**
4754
4869
  * An Identity event.
4870
+ * @interface
4755
4871
  */
4756
4872
  declare type IdentityEvent = BaseEvent & {
4757
4873
  uuid: string;
@@ -4764,6 +4880,7 @@ declare type IdentityEvent = BaseEvent & {
4764
4880
  * @remarks This method is continuously generated every minute while the user is in idle.
4765
4881
  * A user enters idle state when the computer is locked or when there has been no keyboard/mouse activity for 1 minute.
4766
4882
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
4883
+ * @interface
4767
4884
  */
4768
4885
  declare type IdleEvent = {
4769
4886
  type: 'idle-state-changed';
@@ -4792,6 +4909,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
4792
4909
 
4793
4910
  /**
4794
4911
  * Generated when an application has initialized.
4912
+ * @interface
4795
4913
  */
4796
4914
  declare type InitializedEvent = IdentityEvent & {
4797
4915
  type: 'initialized';
@@ -4822,6 +4940,7 @@ declare type InitPlatformOptions = {
4822
4940
 
4823
4941
  /**
4824
4942
  * Generated when the value of the element changes.
4943
+ * @interface
4825
4944
  */
4826
4945
  declare type InputEvent_2 = {
4827
4946
  inputType: 'keyUp' | 'keyDown';
@@ -4975,6 +5094,9 @@ declare class InterApplicationBus extends Base {
4975
5094
 
4976
5095
  declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
4977
5096
 
5097
+ /**
5098
+ * Define whether to enable interop action logging.
5099
+ */
4978
5100
  declare interface InteropActionLoggingOption {
4979
5101
  enabled: boolean;
4980
5102
  }
@@ -6344,6 +6466,138 @@ declare type LaunchIntoPlatformPayload = {
6344
6466
  manifest: any;
6345
6467
  };
6346
6468
 
6469
+ /**
6470
+ *
6471
+ * Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
6472
+ * enables the initialization and manipulation of a window's Layout. A Layout will
6473
+ * emit events locally on the DOM element representing the layout-container.
6474
+ *
6475
+ *
6476
+ * ### Layout.DOMEvents
6477
+ *
6478
+ * When a Layout is created, it emits events onto the DOM element representing the Layout container.
6479
+ * This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
6480
+ * You can use the built-in event emitter to listen to these events using [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener).
6481
+ * The events are emitted synchronously and only in the process where the Layout exists.
6482
+ * Any values returned by the called listeners are ignored and will be discarded.
6483
+ * If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
6484
+ *
6485
+ * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
6486
+ *
6487
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
6488
+ * Adds a listener to the end of the listeners array for the specified event.
6489
+ * @example
6490
+ * ```js
6491
+ * const myLayoutContainer = document.getElementById('layout-container');
6492
+ *
6493
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
6494
+ * const { tabSelector } = event.detail;
6495
+ * const tabElement = document.getElementById(tabSelector);
6496
+ * const existingColor = tabElement.style.backgroundColor;
6497
+ * tabElement.style.backgroundColor = "red";
6498
+ * setTimeout(() => {
6499
+ * tabElement.style.backgroundColor = existingColor;
6500
+ * }, 2000);
6501
+ * });
6502
+ * ```
6503
+ *
6504
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
6505
+ * Adds a listener to the end of the listeners array for the specified event.
6506
+ * @example
6507
+ * ```js
6508
+ * const myLayoutContainer = document.getElementById('layout-container');
6509
+ *
6510
+ * const listener = function(event) {
6511
+ * console.log(event.detail);
6512
+ * console.log('container-created event fired once, removing listener');
6513
+ * myLayoutContainer.removeEventListener('container-created', listener);
6514
+ * };
6515
+ *
6516
+ * myLayoutContainer.addEventListener('container-created', listener);
6517
+ * ```
6518
+ *
6519
+ * ### Supported event types are:
6520
+ *
6521
+ * * tab-created
6522
+ * * container-created
6523
+ * * layout-state-changed
6524
+ * * tab-closed
6525
+ * * tab-dropped
6526
+ *
6527
+ * ### Layout DOM Node Events
6528
+ *
6529
+ * #### tab-created
6530
+ * Generated when a tab is created. As a user drags and drops tabs within window, new tabs are created. A single view may have multiple tabs created and destroyed during its lifetime attached to a single window.
6531
+ * ```js
6532
+ * // The response has the following shape in event.detail:
6533
+ * {
6534
+ * containerSelector: "container-component_A",
6535
+ * name: "component_A",
6536
+ * tabSelector: "tab-component_A",
6537
+ * topic: "openfin-DOM-event",
6538
+ * type: "tab-created",
6539
+ * uuid: "OpenFin POC"
6540
+ * }
6541
+ * ```
6542
+ *
6543
+ * #### container-created
6544
+ * Generated when a container is created. A single view will have only one container during its lifetime attached to a single window and the container's lifecycle is tied to the view. To discover when the container is destroyed, please listen to view-detached event.
6545
+ * ```js
6546
+ * // The response has the following shape in event.detail:
6547
+ * {
6548
+ * containerSelector: "container-component_A",
6549
+ * name: "component_A",
6550
+ * tabSelector: "tab-component_A",
6551
+ * topic: "openfin-DOM-event",
6552
+ * type: "container-created",
6553
+ * uuid: "OpenFin POC"
6554
+ * }
6555
+ * ```
6556
+ *
6557
+ * ### layout-state-changed
6558
+ * Generated when the state of the layout changes in any way, such as a view added/removed/replaced. Note that this event can fire frequently as the underlying layout can change multiple components from all kinds of changes (resizing for example). Given this, it is recommended to debounce this event and then you can use the {@link Layout#getConfig Layout.getConfig} API to retrieve the most up-to-date state.
6559
+ * ```js
6560
+ * // The response has the following shape in event.detail
6561
+ * {
6562
+ * containerSelector: "container-component_A",
6563
+ * name: "component_A",
6564
+ * tabSelector: "tab-component_A",
6565
+ * topic: "openfin-DOM-event",
6566
+ * type: "layout-state-changed",
6567
+ * uuid: "OpenFin POC"
6568
+ * }
6569
+ * ```
6570
+ *
6571
+ * #### tab-closed
6572
+ * Generated when a tab is closed.
6573
+ * ```js
6574
+ * // The response has the following shape in event.detail:
6575
+ * {
6576
+ * containerSelector: "container-component_A",
6577
+ * name: "component_A",
6578
+ * tabSelector: "tab-component_A",
6579
+ * topic: "openfin-DOM-event",
6580
+ * type: "tab-closed",
6581
+ * uuid: "OpenFin POC",
6582
+ * url: "http://openfin.co" // The url of the view that was closed.
6583
+ * }
6584
+ * ```
6585
+ *
6586
+ * #### tab-dropped
6587
+ * Generated when a tab is dropped.
6588
+ * ```js
6589
+ * // The response has the following shape in event.detail:
6590
+ * {
6591
+ * containerSelector: "container-component_A",
6592
+ * name: "component_A",
6593
+ * tabSelector: "tab-component_A",
6594
+ * topic: "openfin-DOM-event",
6595
+ * type: "tab-dropped",
6596
+ * uuid: "OpenFin POC",
6597
+ * url: "http://openfin.co" // The url of the view linked to the dropped tab.
6598
+ * }
6599
+ * ```
6600
+ */
6347
6601
  declare class Layout extends Base {
6348
6602
  #private;
6349
6603
  /* Excluded from this release type: init */
@@ -6524,6 +6778,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
6524
6778
 
6525
6779
  /**
6526
6780
  * Generated when a window and all of its layout's views have either finished or failed navigation.
6781
+ * @interface
6527
6782
  */
6528
6783
  declare type LayoutInitializedEvent = NamedEvent & {
6529
6784
  type: 'layout-initialized';
@@ -6641,6 +6896,9 @@ declare class LayoutManager {
6641
6896
  private setComponentState;
6642
6897
  }
6643
6898
 
6899
+ /**
6900
+ * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
6901
+ */
6644
6902
  declare class LayoutModule extends Base {
6645
6903
  #private;
6646
6904
  /**
@@ -6837,6 +7095,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
6837
7095
 
6838
7096
  /**
6839
7097
  * Generated when a window and all of its layout's views have been created and can receive API calls.
7098
+ * @interface
6840
7099
  */
6841
7100
  declare type LayoutReadyEvent = NamedEvent & {
6842
7101
  type: 'layout-ready';
@@ -6944,6 +7203,7 @@ declare type Manifest = {
6944
7203
 
6945
7204
  /**
6946
7205
  * Generated when the RVM notifies an application that the manifest has changed.
7206
+ * @interface
6947
7207
  */
6948
7208
  declare type ManifestChangedEvent = IdentityEvent & {
6949
7209
  type: 'manifest-changed';
@@ -6987,6 +7247,7 @@ declare type MatchPattern = string;
6987
7247
 
6988
7248
  /**
6989
7249
  * Generated when a window is maximized.
7250
+ * @interface
6990
7251
  */
6991
7252
  declare type MaximizedEvent = NamedEvent & {
6992
7253
  type: 'maximized';
@@ -7059,6 +7320,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
7059
7320
 
7060
7321
  /**
7061
7322
  * Generated when a window is minimized.
7323
+ * @interface
7062
7324
  */
7063
7325
  declare type MinimizedEvent = NamedEvent & {
7064
7326
  type: 'minimized';
@@ -7104,6 +7366,7 @@ declare type MonitorDetails = {
7104
7366
  * Generated on changes of a monitor's size/location.
7105
7367
  * @remarks A monitor's size changes when the taskbar is resized or relocated.
7106
7368
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
7369
+ * @interface
7107
7370
  */
7108
7371
  declare type MonitorEvent = OpenFin_2.MonitorInfo & {
7109
7372
  type: 'monitor-info-changed';
@@ -7451,6 +7714,7 @@ declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => v
7451
7714
 
7452
7715
  /**
7453
7716
  * A Name event.
7717
+ * @interface
7454
7718
  */
7455
7719
  declare type NamedEvent = IdentityEvent & {
7456
7720
  name: string;
@@ -7462,6 +7726,7 @@ declare type NativeWindowIntegrationProviderAuthorization = {
7462
7726
 
7463
7727
  /**
7464
7728
  * Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
7729
+ * @interface
7465
7730
  */
7466
7731
  declare type NavigationRejectedEvent = NamedEvent & {
7467
7732
  type: 'navigation-rejected';
@@ -7482,6 +7747,9 @@ declare type NavigationRules = {
7482
7747
 
7483
7748
  declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
7484
7749
 
7750
+ /**
7751
+ * @interface
7752
+ */
7485
7753
  declare type NonAppProcessDetails = ProcessDetails & {
7486
7754
  name: string;
7487
7755
  };
@@ -7505,6 +7773,7 @@ declare type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
7505
7773
 
7506
7774
  /**
7507
7775
  * Generated when an application is not responding.
7776
+ * @interface
7508
7777
  */
7509
7778
  declare type NotRespondingEvent = IdentityEvent & {
7510
7779
  type: 'not-responding';
@@ -7512,6 +7781,9 @@ declare type NotRespondingEvent = IdentityEvent & {
7512
7781
 
7513
7782
  declare type OnlyIfCompatible<A, B, D = OverlapsOnlyIfMatching<A, B>> = D extends Record<any, never> ? keyof D extends never ? A | B : never : A | B;
7514
7783
 
7784
+ /**
7785
+ * @interface
7786
+ */
7515
7787
  declare type Opacity = TransitionBase & {
7516
7788
  /**
7517
7789
  * The opacity from 0.0 (transparent) to 1.0 (normal).
@@ -7746,7 +8018,7 @@ declare namespace OpenFin_2 {
7746
8018
  ContextForIntent,
7747
8019
  InfoForIntentOptions,
7748
8020
  FindIntentsByContextOptions,
7749
- ProviderIdentity_8 as ProviderIdentity,
8021
+ ProviderIdentity_7 as ProviderIdentity,
7750
8022
  RegisterUsageData,
7751
8023
  ViewsPreventingUnloadPayload,
7752
8024
  BeforeUnloadUserDecision,
@@ -7818,7 +8090,8 @@ declare namespace OpenFin_2 {
7818
8090
  InteropLoggingOptions,
7819
8091
  Me,
7820
8092
  CapturePageOptions,
7821
- ProcessLoggingOptions
8093
+ ProcessLoggingOptions,
8094
+ PositioningOptions
7822
8095
  }
7823
8096
  }
7824
8097
  export default OpenFin_2;
@@ -7834,6 +8107,7 @@ declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T>
7834
8107
  /**
7835
8108
  * Generated when page title is set during navigation.
7836
8109
  * @remarks explicitSet is false when title is synthesized from file url.
8110
+ * @interface
7837
8111
  */
7838
8112
  declare type PageTitleUpdatedEvent = NamedEvent & {
7839
8113
  type: 'page-title-updated';
@@ -7851,6 +8125,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
7851
8125
 
7852
8126
  /**
7853
8127
  * Generated when window finishes loading. Provides performance and navigation data.
8128
+ * @interface
7854
8129
  */
7855
8130
  declare type PerformanceReportEvent = Performance & NamedEvent & {
7856
8131
  type: 'performance-report';
@@ -8144,12 +8419,11 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
8144
8419
  */
8145
8420
  closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
8146
8421
  /**
8147
- * ***DEPRECATED - please use Platform.createView.***
8422
+ * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
8148
8423
  * Reparents a specified view in a new target window.
8149
8424
  * @param viewIdentity View identity
8150
8425
  * @param target new owner window identity
8151
8426
  *
8152
- * @tutorial Platform.createView
8153
8427
  */
8154
8428
  reparentView(viewIdentity: OpenFin_2.Identity, target: OpenFin_2.Identity): Promise<View>;
8155
8429
  /**
@@ -8489,6 +8763,7 @@ declare type Platform_2 = OpenFin_2.Platform;
8489
8763
 
8490
8764
  /**
8491
8765
  * Generated when a new Platform's API becomes responsive.
8766
+ * @interface
8492
8767
  */
8493
8768
  declare type PlatformApiReadyEvent = BaseEvent & {
8494
8769
  topic: 'application';
@@ -8496,7 +8771,9 @@ declare type PlatformApiReadyEvent = BaseEvent & {
8496
8771
  };
8497
8772
 
8498
8773
  /**
8499
- * A Platform event.
8774
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
8775
+ * discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
8776
+ * under the {@link OpenFin.PlatformEvents} namespace.
8500
8777
  */
8501
8778
  declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
8502
8779
 
@@ -8510,6 +8787,9 @@ declare namespace PlatformEvents {
8510
8787
  }
8511
8788
  }
8512
8789
 
8790
+ /**
8791
+ * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
8792
+ */
8513
8793
  declare class PlatformModule extends Base {
8514
8794
  private _channel;
8515
8795
  Layout: LayoutModule;
@@ -8666,6 +8946,7 @@ declare class PlatformModule extends Base {
8666
8946
  /**
8667
8947
  * The options object required by {@link Platform.PlatformModule#start Platform.start}
8668
8948
  * Any {@link ApplicationOptions Application option} is also a valid platform option
8949
+ * @interface
8669
8950
  */
8670
8951
  declare type PlatformOptions = ApplicationCreationOptions & {
8671
8952
  /**
@@ -9174,6 +9455,7 @@ declare interface PlatformProvider {
9174
9455
  * 3. If a window has a layout property, the 'layout-ready' event has fired
9175
9456
  *
9176
9457
  * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
9458
+ * @interface
9177
9459
  */
9178
9460
  declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9179
9461
  topic: 'application';
@@ -9182,6 +9464,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9182
9464
 
9183
9465
  declare type PlatformViewCreationOptions = Partial<ViewOptions>;
9184
9466
 
9467
+ /**
9468
+ * @interface
9469
+ */
9185
9470
  declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
9186
9471
  updateStateIfExists?: boolean;
9187
9472
  reason?: WindowCreationReason;
@@ -9192,6 +9477,7 @@ declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
9192
9477
  * Any {@link OpenFin.WindowCreationOptions Window option} is also a valid Default Window option
9193
9478
  * used by default in any window that is created in the current platform's scope.
9194
9479
  * Individual window options will override these defaults.
9480
+ * @interface
9195
9481
  */
9196
9482
  declare type PlatformWindowOptions = WindowCreationOptions & {
9197
9483
  /**
@@ -9230,35 +9516,117 @@ declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
9230
9516
 
9231
9517
  declare type PopupInteraction = 'clicked' | 'dismissed';
9232
9518
 
9519
+ /**
9520
+ * Popup window options.
9521
+ */
9233
9522
  declare interface PopupOptions {
9523
+ /**
9524
+ * Window creation options when using `showPopupWindow` to create a new window.
9525
+ */
9234
9526
  initialOptions?: Optional<WindowCreationOptions, 'name'>;
9527
+ /**
9528
+ * Updatable window options applied to new and existing windows when shown as popups.
9529
+ */
9235
9530
  additionalOptions?: UpdatableWindowOptions;
9531
+ /**
9532
+ * If a window with this `name` exists, it will be shown as a popup.
9533
+ * Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
9534
+ */
9236
9535
  name?: string;
9536
+ /**
9537
+ * Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
9538
+ */
9237
9539
  url?: string;
9540
+ /**
9541
+ * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
9542
+ * @defaultValue 300
9543
+ */
9238
9544
  height?: number;
9545
+ /**
9546
+ * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
9547
+ * @defaultValue 300
9548
+ */
9239
9549
  width?: number;
9550
+ /**
9551
+ * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
9552
+ * @defaultValue 0
9553
+ */
9240
9554
  x?: number;
9555
+ /**
9556
+ * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
9557
+ * @defaultValue 0
9558
+ */
9241
9559
  y?: number;
9560
+ /**
9561
+ * Determines what happens if the popup window is blurred.
9562
+ * * 'modal' restricts resizing and positioning in the caller.
9563
+ * * 'hide' hides the popup window on blur.
9564
+ * * 'close' closes the popup window on blur.
9565
+ * @defaultValue 'close'
9566
+ */
9242
9567
  blurBehavior?: PopupBlurBehavior;
9568
+ /**
9569
+ * Determines what happens when the popup window calls `dispatchPopupResult`.
9570
+ * * 'none' will do nothing.
9571
+ * * 'hide' hides the popup window on `dispatchPopupResult`.
9572
+ * * 'close' closes the popup window on `dispatchPopupResult`.
9573
+ * @defaultValue 'close'
9574
+ */
9243
9575
  resultDispatchBehavior?: PopupResultBehavior;
9576
+ /**
9577
+ * Hide the popup window instead of closing when `close` is called on it.
9578
+ * <br>Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
9579
+ * @defaultValue false
9580
+ */
9244
9581
  hideOnClose?: boolean;
9582
+ /**
9583
+ * Determines if the popup window should or should not be focused when it is shown.
9584
+ * @defaultValue true
9585
+ */
9245
9586
  focus?: boolean;
9587
+ /**
9588
+ * Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
9589
+ */
9246
9590
  onPopupReady?: (popupWindow: _Window) => any;
9591
+ /**
9592
+ * Executed when this window's popup calls `dispatchPopupResult`.
9593
+ * <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
9594
+ */
9247
9595
  onPopupResult?: (payload: PopupResult) => any;
9248
9596
  }
9249
9597
 
9598
+ /**
9599
+ * The Popup result.
9600
+ *
9601
+ * @typeParam T - Type of data the Popup result contains
9602
+ */
9250
9603
  declare interface PopupResult<T = any> {
9604
+ /**
9605
+ * `name` and `uuid` of the popup window that called dispatched this result.
9606
+ */
9251
9607
  identity: {
9252
9608
  name: string;
9253
9609
  uuid: string;
9254
9610
  };
9611
+ /**
9612
+ * Result of the user interaction with the popup window.
9613
+ */
9255
9614
  result: PopupInteraction;
9615
+ /**
9616
+ * Data passed to `dispatchPopupResult`.
9617
+ */
9256
9618
  data?: T;
9619
+ /**
9620
+ * The last dispatch result.
9621
+ */
9257
9622
  lastDispatchResult?: PopupResult;
9258
9623
  }
9259
9624
 
9260
9625
  declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
9261
9626
 
9627
+ /**
9628
+ * @interface
9629
+ */
9262
9630
  declare type Position = TransitionBase & {
9263
9631
  /**
9264
9632
  * Defaults to the window's current left position in virtual screen coordinates.
@@ -9270,6 +9638,26 @@ declare type Position = TransitionBase & {
9270
9638
  top: number;
9271
9639
  };
9272
9640
 
9641
+ /**
9642
+ * Leveraged by the following windowing apis to influence side effects of the positioning.
9643
+ * - {@link OpenFin.Window.moveBy}
9644
+ * - {@link OpenFin.Window.moveTo}
9645
+ * - {@link OpenFin.Window.setBounds}
9646
+ * - {@link OpenFin.Window.resizeBy}
9647
+ * - {@link OpenFin.Window.resizeTo}
9648
+ * @example ```js
9649
+ fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
9650
+ ```
9651
+ */
9652
+ declare interface PositioningOptions {
9653
+ /**
9654
+ * Windows Only.
9655
+ * If set to true, will not restore a maximized window before setting the bounds.
9656
+ * This will have the effect of the maximized window staying maximized and not immediately taking this new position.
9657
+ */
9658
+ skipRestore?: boolean;
9659
+ }
9660
+
9273
9661
  /**
9274
9662
  * Context menu item with an implementation provided by OpenFin.
9275
9663
  */
@@ -9312,6 +9700,7 @@ declare type PreloadScriptInfoRunning = {
9312
9700
  /**
9313
9701
  * Generated after the execution of all of a window's preload scripts.
9314
9702
  * @remarks Contains information about all window's preload scripts' final states.
9703
+ * @interface
9315
9704
  */
9316
9705
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
9317
9706
  type: 'preload-script-state-changed';
@@ -9319,6 +9708,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
9319
9708
 
9320
9709
  /**
9321
9710
  * A general preload scripts state change event without event type.
9711
+ * @interface
9322
9712
  */
9323
9713
  declare type PreloadScriptsStateChangeEvent = NamedEvent & {
9324
9714
  preloadScripts: (PreloadScriptInfoRunning & any)[];
@@ -9327,6 +9717,7 @@ declare type PreloadScriptsStateChangeEvent = NamedEvent & {
9327
9717
  /**
9328
9718
  * Generated during the execution of a window's preload script.
9329
9719
  * @remarks Contains information about a single window's preload script's state, for which the event has been raised.
9720
+ * @interface
9330
9721
  */
9331
9722
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
9332
9723
  type: 'preload-script-state-changing';
@@ -9463,10 +9854,25 @@ declare type ProcessDetails = {
9463
9854
  pid: number;
9464
9855
  };
9465
9856
 
9857
+ /**
9858
+ * Process logging options
9859
+ */
9466
9860
  declare interface ProcessLoggingOptions {
9861
+ /**
9862
+ * Periodic Logging Interval (in seconds)
9863
+ */
9467
9864
  interval?: number;
9865
+ /**
9866
+ * Outlier Detection options
9867
+ */
9468
9868
  outlierDetection?: {
9869
+ /**
9870
+ * Outlier Interval (in seconds)
9871
+ */
9469
9872
  interval?: number;
9873
+ /**
9874
+ * Number of Process Info entries to collect for outlier analysis
9875
+ */
9470
9876
  entries?: number;
9471
9877
  };
9472
9878
  }
@@ -9709,6 +10115,25 @@ declare interface ProtocolMap extends ProtocolMapBase {
9709
10115
  'set-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity & {
9710
10116
  domainSettings: OpenFin_2.DefaultDomainSettings;
9711
10117
  }, void>;
10118
+ 'move-window-by': IdentityCall<WithPositioningOptions<{
10119
+ deltaLeft: number;
10120
+ deltaTop: number;
10121
+ }>>;
10122
+ 'move-window': IdentityCall<WithPositioningOptions<{
10123
+ left: number;
10124
+ top: number;
10125
+ }>>;
10126
+ 'resize-window-by': IdentityCall<WithPositioningOptions<{
10127
+ deltaWidth: number;
10128
+ deltaHeight: number;
10129
+ anchor: OpenFin_2.AnchorType;
10130
+ }>>;
10131
+ 'resize-window': IdentityCall<WithPositioningOptions<{
10132
+ width: number;
10133
+ height: number;
10134
+ anchor: OpenFin_2.AnchorType;
10135
+ }>>;
10136
+ 'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
9712
10137
  }
9713
10138
 
9714
10139
  declare interface ProtocolMapBase {
@@ -9740,12 +10165,11 @@ declare type ProviderIdentity_5 = OpenFin_2.ProviderIdentity;
9740
10165
 
9741
10166
  declare type ProviderIdentity_6 = OpenFin_2.ProviderIdentity;
9742
10167
 
9743
- declare type ProviderIdentity_7 = OpenFin_2.ProviderIdentity;
9744
-
9745
10168
  /**
9746
10169
  * Identity of a channel provider.
10170
+ * @interface
9747
10171
  */
9748
- declare type ProviderIdentity_8 = Identity_5 & {
10172
+ declare type ProviderIdentity_7 = Identity_5 & {
9749
10173
  /**
9750
10174
  * Identifier of the channel.
9751
10175
  */
@@ -9812,6 +10236,9 @@ declare type QueryPermissionResult = {
9812
10236
  rawValue?: unknown;
9813
10237
  };
9814
10238
 
10239
+ /**
10240
+ * @interface
10241
+ */
9815
10242
  declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
9816
10243
 
9817
10244
  /**
@@ -9847,6 +10274,7 @@ declare type RectangleByEdgePositions = {
9847
10274
 
9848
10275
  /**
9849
10276
  * Generated when a hotkey has been registered with the operating system.
10277
+ * @interface
9850
10278
  */
9851
10279
  declare type RegisteredEvent = BaseEvent & {
9852
10280
  type: 'registered';
@@ -9869,6 +10297,7 @@ declare type RegistryInfo_2 = {
9869
10297
 
9870
10298
  /**
9871
10299
  * Generated when a window has been reloaded.
10300
+ * @interface
9872
10301
  */
9873
10302
  declare type ReloadedEvent = NamedEvent & {
9874
10303
  type: 'reloaded';
@@ -9954,6 +10383,7 @@ declare type ResizeRegion = {
9954
10383
 
9955
10384
  /**
9956
10385
  * Generated when an HTTP load was cancelled or failed.
10386
+ * @interface
9957
10387
  */
9958
10388
  declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
9959
10389
  type: 'resource-load-failed';
@@ -9961,6 +10391,7 @@ declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
9961
10391
 
9962
10392
  /**
9963
10393
  * Generated when an HTTP resource request has received response details.
10394
+ * @interface
9964
10395
  */
9965
10396
  declare type ResourceResponseReceivedEvent = NamedEvent & {
9966
10397
  type: 'resource-response-received';
@@ -9976,6 +10407,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
9976
10407
 
9977
10408
  /**
9978
10409
  * Generated when an application is responding.
10410
+ * @interface
9979
10411
  */
9980
10412
  declare type RespondingEvent = IdentityEvent & {
9981
10413
  type: 'responding';
@@ -9989,7 +10421,10 @@ declare type RGB = {
9989
10421
  green: number;
9990
10422
  };
9991
10423
 
9992
- declare type RoutingInfo = ProviderIdentity_3 & {
10424
+ /**
10425
+ * @interface
10426
+ */
10427
+ declare type RoutingInfo = OpenFin_2.ProviderIdentity & {
9993
10428
  endpointId: string;
9994
10429
  };
9995
10430
 
@@ -10015,7 +10450,7 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
10015
10450
  declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload> {
10016
10451
  #private;
10017
10452
  onEndpointDisconnect(endpointId: string, listener: () => void): void;
10018
- receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_6) => Promise<any>): void;
10453
+ receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
10019
10454
  send: (endpointId: string, action: string, payload: any) => Promise<any>;
10020
10455
  close: () => Promise<void>;
10021
10456
  private getEndpointById;
@@ -10027,7 +10462,7 @@ declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload>
10027
10462
  }
10028
10463
 
10029
10464
  declare interface RTCStrategyEndpointPayload {
10030
- endpointIdentity: OpenFin_2.ClientIdentity | ProviderIdentity_6;
10465
+ endpointIdentity: OpenFin_2.ClientIdentity | ProviderIdentity_5;
10031
10466
  rtc: RTCPacket;
10032
10467
  }
10033
10468
 
@@ -10035,6 +10470,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
10035
10470
 
10036
10471
  /**
10037
10472
  * Generated when Application.run() is called for an already running application.
10473
+ * @interface
10038
10474
  */
10039
10475
  declare type RunRequestedEvent_2 = IdentityEvent & {
10040
10476
  type: 'run-requested';
@@ -10186,6 +10622,7 @@ declare type ServiceIdentifier = {
10186
10622
 
10187
10623
  /**
10188
10624
  * Generated on changes to a user’s local computer session.
10625
+ * @interface
10189
10626
  */
10190
10627
  declare type SessionChangedEvent = {
10191
10628
  type: 'session-changed';
@@ -10236,12 +10673,16 @@ declare type ShortCutConfig = {
10236
10673
  systemStartup?: boolean;
10237
10674
  };
10238
10675
 
10676
+ /**
10677
+ * @interface
10678
+ */
10239
10679
  declare type ShortcutOverride = Hotkey & {
10240
10680
  command: string;
10241
10681
  };
10242
10682
 
10243
10683
  /**
10244
10684
  * Generated when a View is shown. This event will fire during creation of a View.
10685
+ * @interface
10245
10686
  */
10246
10687
  declare type ShownEvent = BaseViewEvent & {
10247
10688
  type: 'shown';
@@ -10255,6 +10696,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
10255
10696
 
10256
10697
  /**
10257
10698
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
10699
+ * @interface
10258
10700
  */
10259
10701
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
10260
10702
  /**
@@ -10271,6 +10713,9 @@ declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
10271
10713
  paintIntervalMs?: number;
10272
10714
  };
10273
10715
 
10716
+ /**
10717
+ * @interface
10718
+ */
10274
10719
  declare type Size = TransitionBase & {
10275
10720
  /**
10276
10721
  * Optional if height is present. Defaults to the window's current width.
@@ -10347,6 +10792,9 @@ declare class SnapshotSource<T = any> extends Base {
10347
10792
  applySnapshot(snapshot: T): Promise<void>;
10348
10793
  }
10349
10794
 
10795
+ /**
10796
+ * Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
10797
+ */
10350
10798
  declare class SnapshotSourceModule extends Base {
10351
10799
  /**
10352
10800
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
@@ -10425,6 +10873,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
10425
10873
 
10426
10874
  /**
10427
10875
  * Generated when an application has started.
10876
+ * @interface
10428
10877
  */
10429
10878
  declare type StartedEvent = IdentityEvent & {
10430
10879
  type: 'started';
@@ -11883,7 +12332,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
11883
12332
  }
11884
12333
 
11885
12334
  /**
11886
- * A system event.
12335
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
12336
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
12337
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
12338
+ * from which they propagate).
11887
12339
  */
11888
12340
  declare type SystemEvent = {
11889
12341
  topic: 'system';
@@ -12153,12 +12605,16 @@ declare type TargetApp = string | AppMetadata;
12153
12605
  * Generated when a View changes its window target.
12154
12606
  * @remarks This event will fire during creation of a View.
12155
12607
  * In that case, previousTarget identity will be the same as target identity.
12608
+ * @interface
12156
12609
  */
12157
12610
  declare type TargetChangedEvent = BaseViewEvent & {
12158
12611
  type: 'target-changed';
12159
12612
  previousTarget: OpenFin_2.Identity;
12160
12613
  };
12161
12614
 
12615
+ /**
12616
+ * @interface
12617
+ */
12162
12618
  declare type TaskBar = DipScaleRects & {
12163
12619
  /**
12164
12620
  * Which edge of a monitor the taskbar is on
@@ -12281,6 +12737,7 @@ declare class Transport<MeType extends EntityType_3 = EntityType_3> extends Even
12281
12737
 
12282
12738
  /**
12283
12739
  * Generated when the tray icon is clicked.
12740
+ * @interface
12284
12741
  */
12285
12742
  declare type TrayIconClickedEvent = IdentityEvent & {
12286
12743
  type: 'tray-icon-clicked';
@@ -12332,6 +12789,7 @@ declare interface TypedEventEmitter<Event extends {
12332
12789
 
12333
12790
  /**
12334
12791
  * Generated when a hotkey has been unregistered with the operating system.
12792
+ * @interface
12335
12793
  */
12336
12794
  declare type UnregisteredEvent = BaseEvent & {
12337
12795
  type: 'unregistered';
@@ -12348,6 +12806,7 @@ declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
12348
12806
  * Generated when navigation or redirect is completed.
12349
12807
  * @remarks Also emitted for in-page navigations, examples of this occurring are when anchor links are clicked or when the DOM hashchange event is triggered, indicated by isInPage=true.
12350
12808
  * Note that navigating to a url with an anchor in it like http://openfin.co/#my-inpage-anchor will fire 2 events indicating the original navigation (isInPage=false) and then the in-page navigation event (isInPage=true).
12809
+ * @interface
12351
12810
  */
12352
12811
  declare type UrlChangedEvent = BaseUrlEvent & ({
12353
12812
  isInPage: true;
@@ -12359,6 +12818,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
12359
12818
 
12360
12819
  /**
12361
12820
  * A general user bounds change event without event type.
12821
+ * @interface
12362
12822
  */
12363
12823
  declare type UserBoundsChangeEvent = NamedEvent & {
12364
12824
  height: number;
@@ -12370,6 +12830,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
12370
12830
 
12371
12831
  /**
12372
12832
  * Generated when a window's user movement becomes disabled.
12833
+ * @interface
12373
12834
  */
12374
12835
  declare type UserMovementDisabledEvent = NamedEvent & {
12375
12836
  type: 'user-movement-disabled';
@@ -12377,6 +12838,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
12377
12838
 
12378
12839
  /**
12379
12840
  * Generated when a window's user movement becomes enabled.
12841
+ * @interface
12380
12842
  */
12381
12843
  declare type UserMovementEnabledEvent = NamedEvent & {
12382
12844
  type: 'user-movement-enabled';
@@ -12949,6 +13411,7 @@ declare interface ViewComponent extends GoldenLayout.ContentItem {
12949
13411
  *
12950
13412
  * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
12951
13413
  * (defaults to `"about:blank"` when omitted).
13414
+ * @interface
12952
13415
  */
12953
13416
  declare type ViewCreationOptions = Partial<ViewOptions> & {
12954
13417
  name: string;
@@ -12961,6 +13424,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
12961
13424
  /**
12962
13425
  * Generated when a window has a view detached from it.
12963
13426
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
13427
+ * @interface
12964
13428
  */
12965
13429
  declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
12966
13430
  type: 'view-detached';
@@ -12968,7 +13432,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
12968
13432
  };
12969
13433
 
12970
13434
  /**
12971
- * A View event.
13435
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
13436
+ * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
13437
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
12972
13438
  */
12973
13439
  declare type ViewEvent = {
12974
13440
  topic: 'view';
@@ -12984,7 +13450,7 @@ declare namespace ViewEvents {
12984
13450
  AttachedEvent,
12985
13451
  CreatedEvent,
12986
13452
  DestroyedEvent,
12987
- HiddenEvent_2 as HiddenEvent,
13453
+ HiddenEvent,
12988
13454
  HotkeyEvent,
12989
13455
  ShownEvent,
12990
13456
  WillPropagateViewEvent,
@@ -13009,6 +13475,9 @@ declare type ViewInfo = {
13009
13475
  favicons: string[];
13010
13476
  };
13011
13477
 
13478
+ /**
13479
+ * Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
13480
+ */
13012
13481
  declare class ViewModule extends Base {
13013
13482
  /**
13014
13483
  * Creates a new View.
@@ -13091,6 +13560,7 @@ declare class ViewModule extends Base {
13091
13560
 
13092
13561
  /**
13093
13562
  * User-facing options for a view.
13563
+ * @interface
13094
13564
  */
13095
13565
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
13096
13566
 
@@ -13128,6 +13598,9 @@ declare class ViewOverlay {
13128
13598
  setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
13129
13599
  }
13130
13600
 
13601
+ /**
13602
+ * Represents the payload shape for Views that are trying to prevent an unload.
13603
+ */
13131
13604
  declare interface ViewsPreventingUnloadPayload {
13132
13605
  /**
13133
13606
  * Specifies if the Window should close.
@@ -13151,6 +13624,9 @@ declare interface ViewsPreventingUnloadPayload {
13151
13624
  closeType: 'view' | 'window';
13152
13625
  }
13153
13626
 
13627
+ /**
13628
+ * @interface
13629
+ */
13154
13630
  declare type ViewState = ViewCreationOptions & {
13155
13631
  backgroundThrottling: boolean;
13156
13632
  componentName: 'view';
@@ -13158,6 +13634,9 @@ declare type ViewState = ViewCreationOptions & {
13158
13634
  minWidth?: number;
13159
13635
  };
13160
13636
 
13637
+ /**
13638
+ * The statuses of views specifying which of them are trying to prevent an unload and which are not.
13639
+ */
13161
13640
  declare interface ViewStatuses {
13162
13641
  /**
13163
13642
  * Identities of the Views that are preventing an unload.
@@ -14120,6 +14599,7 @@ declare type WebRequestHeader = {
14120
14599
  /**
14121
14600
  * Generated when a window is being moved by the user.
14122
14601
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
14602
+ * @interface
14123
14603
  */
14124
14604
  declare type WillMoveEvent = WillMoveOrResizeEvent & {
14125
14605
  type: 'will-move';
@@ -14127,6 +14607,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
14127
14607
 
14128
14608
  /**
14129
14609
  * A general will-move or will-resize event without event type.
14610
+ * @interface
14130
14611
  */
14131
14612
  declare type WillMoveOrResizeEvent = NamedEvent & {
14132
14613
  height: number;
@@ -14144,7 +14625,7 @@ declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedE
14144
14625
  /**
14145
14626
  * A View event that does propagate to (republish on) parent topics.
14146
14627
  */
14147
- declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent_2 | HotkeyEvent | ShownEvent | TargetChangedEvent;
14628
+ declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
14148
14629
 
14149
14630
  /**
14150
14631
  * A WebContents event that does propagate to (republish on) parent topics.
@@ -14154,10 +14635,11 @@ declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelection
14154
14635
  /**
14155
14636
  * A Window event that does propagate to (republish on) parent topics.
14156
14637
  */
14157
- declare type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewAttachedEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent_2 | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent;
14638
+ declare type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewAttachedEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | WindowHiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent_2 | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent;
14158
14639
 
14159
14640
  /**
14160
14641
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
14642
+ * @interface
14161
14643
  */
14162
14644
  declare type WillRedirectEvent = NamedEvent & {
14163
14645
  type: 'will-redirect';
@@ -14170,6 +14652,7 @@ declare type WillRedirectEvent = NamedEvent & {
14170
14652
  * Generated when a window is being resized by the user.
14171
14653
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
14172
14654
  * The event will fire when a user resize is blocked by window options such as maxWidth or minHeight but not if the window is not resizable.
14655
+ * @interface
14173
14656
  */
14174
14657
  declare type WillResizeEvent = WillMoveOrResizeEvent & {
14175
14658
  type: 'will-resize';
@@ -15241,7 +15724,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15241
15724
  * moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
15242
15725
  * ```
15243
15726
  */
15244
- moveBy(deltaLeft: number, deltaTop: number): Promise<void>;
15727
+ moveBy(deltaLeft: number, deltaTop: number, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15245
15728
  /**
15246
15729
  * Moves the window to a specified location.
15247
15730
  * @param left The left position of the window
@@ -15267,7 +15750,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15267
15750
  * moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
15268
15751
  * ```
15269
15752
  */
15270
- moveTo(left: number, top: number): Promise<void>;
15753
+ moveTo(left: number, top: number, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15271
15754
  /**
15272
15755
  * Resizes the window by a specified amount.
15273
15756
  * @param deltaWidth The change in the width of the window
@@ -15296,7 +15779,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15296
15779
  * resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
15297
15780
  * ```
15298
15781
  */
15299
- resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin_2.AnchorType): Promise<void>;
15782
+ resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin_2.AnchorType, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15300
15783
  /**
15301
15784
  * Resizes the window to the specified dimensions.
15302
15785
  * @param width The change in the width of the window
@@ -15325,7 +15808,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15325
15808
  * resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
15326
15809
  * ```
15327
15810
  */
15328
- resizeTo(width: number, height: number, anchor: OpenFin_2.AnchorType): Promise<void>;
15811
+ resizeTo(width: number, height: number, anchor: OpenFin_2.AnchorType, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15329
15812
  /**
15330
15813
  * Restores the window to its normal state (i.e., unminimized, unmaximized).
15331
15814
  *
@@ -15376,7 +15859,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15376
15859
  setAsForeground(): Promise<void>;
15377
15860
  /**
15378
15861
  * Sets the window's size and position.
15379
- * @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
15380
15862
  *
15381
15863
  * @example
15382
15864
  * ```js
@@ -15403,7 +15885,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15403
15885
  * }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
15404
15886
  * ```
15405
15887
  */
15406
- setBounds(bounds: Partial<OpenFin_2.Bounds>): Promise<void>;
15888
+ setBounds(bounds: Partial<OpenFin_2.Bounds>, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15407
15889
  /**
15408
15890
  * Shows the window if it is hidden.
15409
15891
  * @param force Show will be prevented from showing when force is false and
@@ -15612,6 +16094,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15612
16094
  */
15613
16095
  closePopupMenu(): Promise<void>;
15614
16096
  /**
16097
+ * @PORTED
15615
16098
  * @typedef {object} PopupOptions@typedef {object} PopupOptions
15616
16099
  * @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
15617
16100
  * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -15629,6 +16112,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15629
16112
  * @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
15630
16113
  */
15631
16114
  /**
16115
+ * @PORTED
15632
16116
  * @typedef {object} PopupResult@typedef {object} PopupResult
15633
16117
  * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
15634
16118
  * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -15694,6 +16178,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15694
16178
 
15695
16179
  /**
15696
16180
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
16181
+ * @interface
15697
16182
  */
15698
16183
  declare type WindowAlertRequestedEvent = NamedEvent & {
15699
16184
  type: 'window-alert-requested';
@@ -15701,6 +16186,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15701
16186
 
15702
16187
  /**
15703
16188
  * Returned from getBounds call. bottom and right are never used for setting.
16189
+ * @interface
15704
16190
  */
15705
16191
  declare type WindowBounds = Bounds & {
15706
16192
  bottom: number;
@@ -15709,6 +16195,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15709
16195
 
15710
16196
  /**
15711
16197
  * Generated when a window has closed.
16198
+ * @interface
15712
16199
  */
15713
16200
  declare type WindowClosedEvent = NamedEvent & {
15714
16201
  type: 'closed';
@@ -15717,6 +16204,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15717
16204
  /**
15718
16205
  * Generated when a window has been prevented from closing.
15719
16206
  * @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
16207
+ * @interface
15720
16208
  */
15721
16209
  declare type WindowCloseRequestedEvent = NamedEvent & {
15722
16210
  type: 'close-requested';
@@ -15724,6 +16212,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15724
16212
 
15725
16213
  /**
15726
16214
  * Generated when a window has initiated the closing routine.
16215
+ * @interface
15727
16216
  */
15728
16217
  declare type WindowClosingEvent = NamedEvent & {
15729
16218
  type: 'closing';
@@ -15731,6 +16220,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15731
16220
 
15732
16221
  /**
15733
16222
  * Generated when a child window is created.
16223
+ * @interface
15734
16224
  */
15735
16225
  declare type WindowCreatedEvent = NamedEvent & {
15736
16226
  type: 'window-created';
@@ -15741,6 +16231,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15741
16231
  *
15742
16232
  * Note that `name` is the only required property — albeit the `url` property is usually provided as well
15743
16233
  * (defaults to `"about:blank"` when omitted).
16234
+ * @interface
15744
16235
  */
15745
16236
  declare type WindowCreationOptions = Partial<WindowOptions> & {
15746
16237
  name: string;
@@ -15767,7 +16258,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15767
16258
  */
15768
16259
  name: string;
15769
16260
  /**
15770
- * The right-most coordinate of the window
16261
+ * The right-most coordinate of the window.
15771
16262
  */
15772
16263
  right: number;
15773
16264
  state: string;
@@ -15783,13 +16274,16 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15783
16274
 
15784
16275
  /**
15785
16276
  * Generated when a child window ends loading.
16277
+ * @interface
15786
16278
  */
15787
16279
  declare type WindowEndLoadEvent = NamedEvent & {
15788
16280
  type: 'window-end-load';
15789
16281
  };
15790
16282
 
15791
16283
  /**
15792
- * A Window event.
16284
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
16285
+ * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
16286
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
15793
16287
  */
15794
16288
  declare type WindowEvent = {
15795
16289
  topic: 'window';
@@ -15807,7 +16301,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15807
16301
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
15808
16302
  ExternalProcessExitedEvent,
15809
16303
  ExternalProcessStartedEvent,
15810
- HiddenEvent,
16304
+ WindowHiddenEvent,
15811
16305
  PreloadScriptInfoRunning,
15812
16306
  PreloadScriptInfo,
15813
16307
  PreloadScriptsStateChangeEvent,
@@ -15857,9 +16351,19 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15857
16351
  */
15858
16352
  declare type WindowEventType = WindowEvent['type'];
15859
16353
 
16354
+ /**
16355
+ * Generated when a window has been hidden.
16356
+ * @interface
16357
+ */
16358
+ declare type WindowHiddenEvent = NamedEvent & {
16359
+ type: 'hidden';
16360
+ reason: 'closing' | 'hide' | 'hide-on-close';
16361
+ };
16362
+
15860
16363
  /**
15861
16364
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
15862
16365
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
16366
+ * @interface
15863
16367
  */
15864
16368
  declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
15865
16369
  type: 'hotkey';
@@ -15875,11 +16379,15 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15875
16379
 
15876
16380
  /**
15877
16381
  * Generated when a window is initialized.
16382
+ * @interface
15878
16383
  */
15879
16384
  declare type WindowInitializedEvent = NamedEvent & {
15880
16385
  type: 'initialized';
15881
16386
  };
15882
16387
 
16388
+ /**
16389
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
16390
+ */
15883
16391
  declare class _WindowModule extends Base {
15884
16392
  /**
15885
16393
  * Asynchronously returns a Window object that represents an existing window.
@@ -15970,6 +16478,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15970
16478
 
15971
16479
  /**
15972
16480
  * Generated when a child window is not responding.
16481
+ * @interface
15973
16482
  */
15974
16483
  declare type WindowNotRespondingEvent = NamedEvent & {
15975
16484
  type: 'window-not-responding';
@@ -15982,6 +16491,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15982
16491
  };
15983
16492
  };
15984
16493
 
16494
+ /**
16495
+ * @interface
16496
+ */
15985
16497
  declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
15986
16498
 
15987
16499
  declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
@@ -15989,6 +16501,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15989
16501
  /**
15990
16502
  * Generated after window options are changed using the window.updateOptions method.
15991
16503
  * @remarks Will not fire if the diff object is empty.
16504
+ * @interface
15992
16505
  */
15993
16506
  declare type WindowOptionsChangedEvent_2 = NamedEvent & {
15994
16507
  type: 'options-changed';
@@ -16000,6 +16513,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16000
16513
 
16001
16514
  /**
16002
16515
  * Generated when a child window is responding.
16516
+ * @interface
16003
16517
  */
16004
16518
  declare type WindowRespondingEvent = NamedEvent & {
16005
16519
  type: 'window-responding';
@@ -16007,6 +16521,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16007
16521
 
16008
16522
  /**
16009
16523
  * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
16524
+ * @interface
16010
16525
  */
16011
16526
  declare type WindowRestoredEvent = NamedEvent & {
16012
16527
  type: 'restored';
@@ -16014,6 +16529,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16014
16529
 
16015
16530
  /**
16016
16531
  * Generated when a hidden window has been shown.
16532
+ * @interface
16017
16533
  */
16018
16534
  declare type WindowShownEvent = NamedEvent & {
16019
16535
  type: 'shown';
@@ -16022,6 +16538,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16022
16538
  /**
16023
16539
  * Generated when a window has been prevented from showing.
16024
16540
  * @remarks A window will be prevented from showing by default, either through the API or by a user when ‘show-requested’ has been subscribed to on the window or 'window-show-requested' on the parent application and the Window.show(force) flag is false.
16541
+ * @interface
16025
16542
  */
16026
16543
  declare type WindowShowRequestedEvent = NamedEvent & {
16027
16544
  type: 'show-requested';
@@ -16029,6 +16546,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16029
16546
 
16030
16547
  /**
16031
16548
  * Generated when a child window starts loading.
16549
+ * @interface
16032
16550
  */
16033
16551
  declare type WindowStartLoadEvent = NamedEvent & {
16034
16552
  type: 'window-start-load';
@@ -16064,6 +16582,10 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16064
16582
 
16065
16583
  /* Excluded from this release type: WithoutId */
16066
16584
 
16585
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
16586
+ positioningOptions?: OpenFin_2.PositioningOptions;
16587
+ };
16588
+
16067
16589
  declare type WorkspacePlatformOptions = {
16068
16590
  /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
16069
16591
  [key: string]: any;
@@ -16071,6 +16593,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16071
16593
 
16072
16594
  /**
16073
16595
  * A generic request to write any supported data to the clipboard.
16596
+ * @interface
16074
16597
  */
16075
16598
  declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
16076
16599
  data: {
@@ -16089,6 +16612,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16089
16612
 
16090
16613
  /**
16091
16614
  * A request to write data to the clipboard.
16615
+ * @interface
16092
16616
  */
16093
16617
  declare type WriteClipboardRequest = BaseClipboardRequest & {
16094
16618
  /**
@@ -16097,6 +16621,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16097
16621
  data: string;
16098
16622
  };
16099
16623
 
16624
+ /**
16625
+ * @interface
16626
+ */
16100
16627
  declare type WriteImageClipboardRequest = BaseClipboardRequest & {
16101
16628
  /**
16102
16629
  * Can be either a base64 string, or a DataURL string. If using DataURL, the