@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.
package/out/mock.d.ts CHANGED
@@ -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';
@@ -816,6 +817,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
816
817
 
817
818
  /**
818
819
  * Generated when an application has authenticated and is connected.
820
+ * @interface
819
821
  */
820
822
  declare type ApplicationConnectedEvent = IdentityEvent & {
821
823
  type: 'connected';
@@ -823,6 +825,7 @@ declare type ApplicationConnectedEvent = IdentityEvent & {
823
825
 
824
826
  /**
825
827
  * Generated when an application is created.
828
+ * @interface
826
829
  */
827
830
  declare type ApplicationCreatedEvent = IdentityEvent & {
828
831
  type: 'application-created';
@@ -837,11 +840,10 @@ declare type ApplicationCreatedEvent = IdentityEvent & {
837
840
  * * `url` is optional in both the app manifest {@link Application.ApplicationModule.start Application.start} and but is usually given
838
841
  * (defaults to `"about:blank"` when omitted).
839
842
  *
840
- * _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
841
- *
842
843
  * **IMPORTANT NOTE:**
843
844
  * This object inherits all the properties of the window creation {@link OpenFin.WindowCreationOptions options} object,
844
845
  * which will take priority over those of the same name that may be provided in `mainWindowOptions`.
846
+ * @interface
845
847
  */
846
848
  declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
847
849
  name: string;
@@ -849,7 +851,10 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
849
851
  };
850
852
 
851
853
  /**
852
- * An Application event.
854
+ * [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
855
+ * discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
856
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
857
+ * from which they propagate).
853
858
  */
854
859
  declare type ApplicationEvent = {
855
860
  topic: 'application';
@@ -909,6 +914,9 @@ declare type ApplicationInfo = {
909
914
  };
910
915
  };
911
916
 
917
+ /**
918
+ * Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
919
+ */
912
920
  declare class ApplicationModule extends Base {
913
921
  /**
914
922
  * Asynchronously returns an Application object that represents an existing application.
@@ -1089,6 +1097,7 @@ declare class ApplicationModule extends Base {
1089
1097
 
1090
1098
  /**
1091
1099
  * The complete set of options for an application.
1100
+ * @interface
1092
1101
  */
1093
1102
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1094
1103
  /**
@@ -1282,6 +1291,10 @@ declare type AppProcessInfo = {
1282
1291
  entities: EntityProcessDetails[];
1283
1292
  };
1284
1293
 
1294
+ /**
1295
+ * Generated when system app versioning is successfully completed.
1296
+ * @interface
1297
+ */
1285
1298
  declare type AppVersionCompleteEvent = {
1286
1299
  type: 'app-version-complete';
1287
1300
  } & AppVersionProgress;
@@ -1291,6 +1304,10 @@ declare type AppVersionError = {
1291
1304
  srcManifest: string;
1292
1305
  };
1293
1306
 
1307
+ /**
1308
+ * Generated when none of fallback manifests is compatible to the system.
1309
+ * @interface
1310
+ */
1294
1311
  declare type AppVersionErrorEvent = {
1295
1312
  type: 'app-version-error';
1296
1313
  } & AppVersionError;
@@ -1315,6 +1332,10 @@ declare type AppVersionProgress = {
1315
1332
  srcManifest: string;
1316
1333
  };
1317
1334
 
1335
+ /**
1336
+ * Generated during the progress of system app versioning.
1337
+ * @interface
1338
+ */
1318
1339
  declare type AppVersionProgressEvent = {
1319
1340
  type: 'app-version-progress';
1320
1341
  } & AppVersionProgress;
@@ -1328,6 +1349,10 @@ declare type AppVersionRuntimeInfo = {
1328
1349
  error: string | null;
1329
1350
  };
1330
1351
 
1352
+ /**
1353
+ * Generated when checking a runtime availability.
1354
+ * @interface
1355
+ */
1331
1356
  declare type AppVersionRuntimeStatusEvent = {
1332
1357
  type: 'runtime-status';
1333
1358
  } & AppVersionRuntimeInfo;
@@ -1341,6 +1366,7 @@ declare type AppVersionTypeFromIdEvent<T extends IdEventType> = Extract<AppVersi
1341
1366
 
1342
1367
  /**
1343
1368
  * Generated when a View is attached to a window.
1369
+ * @interface
1344
1370
  */
1345
1371
  declare type AttachedEvent = BaseViewEvent & {
1346
1372
  type: 'attached';
@@ -1413,6 +1439,7 @@ declare interface AuthorizationPayload {
1413
1439
  * }
1414
1440
  * });
1415
1441
  * ```
1442
+ * @interface
1416
1443
  */
1417
1444
  declare type AuthRequestedEvent = NamedEvent & {
1418
1445
  type: 'auth-requested';
@@ -1470,6 +1497,7 @@ declare class Base {
1470
1497
 
1471
1498
  /**
1472
1499
  * A base Channel event.
1500
+ * @interface
1473
1501
  */
1474
1502
  declare type BaseChannelEvent = NamedEvent & {
1475
1503
  channelName: string;
@@ -1536,6 +1564,7 @@ declare namespace BaseEvents {
1536
1564
 
1537
1565
  /**
1538
1566
  * The base frame event.
1567
+ * @interface
1539
1568
  */
1540
1569
  declare type BaseFrameEvent = NamedEvent & {
1541
1570
  entityType: 'iframe';
@@ -1556,12 +1585,16 @@ declare type BaseUrlEvent = NamedEvent & {
1556
1585
 
1557
1586
  /**
1558
1587
  * A base View event.
1588
+ * @interface
1559
1589
  */
1560
1590
  declare type BaseViewEvent = NamedEvent & {
1561
1591
  target: OpenFin_2.Identity;
1562
1592
  viewIdentity: OpenFin_2.Identity;
1563
1593
  };
1564
1594
 
1595
+ /**
1596
+ * User decision of whether a Window or specific View should close when trying to prevent an unload.
1597
+ */
1565
1598
  declare interface BeforeUnloadUserDecision {
1566
1599
  /**
1567
1600
  * Specifies if the Window should close.
@@ -1575,6 +1608,7 @@ declare interface BeforeUnloadUserDecision {
1575
1608
 
1576
1609
  /**
1577
1610
  * Generated at the beginning of a user-driven change to a window's size or position.
1611
+ * @interface
1578
1612
  */
1579
1613
  declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1580
1614
  type: 'begin-user-bounds-changing';
@@ -1582,6 +1616,7 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1582
1616
 
1583
1617
  /**
1584
1618
  * Generated when a WebContents loses focus.
1619
+ * @interface
1585
1620
  */
1586
1621
  declare type BlurredEvent = NamedEvent & {
1587
1622
  type: 'blurred';
@@ -1596,6 +1631,7 @@ declare type Bounds = {
1596
1631
 
1597
1632
  /**
1598
1633
  * Generated after changes in a window's size and/or position.
1634
+ * @interface
1599
1635
  */
1600
1636
  declare type BoundsChangedEvent = BoundsChangeEvent & {
1601
1637
  type: 'bounds-changed';
@@ -1603,6 +1639,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1603
1639
 
1604
1640
  /**
1605
1641
  * A general bounds change event without event type.
1642
+ * @interface
1606
1643
  */
1607
1644
  declare type BoundsChangeEvent = NamedEvent & {
1608
1645
  changeType: 0 | 1 | 2;
@@ -1615,6 +1652,7 @@ declare type BoundsChangeEvent = NamedEvent & {
1615
1652
 
1616
1653
  /**
1617
1654
  * Generated during changes to a window's size and/or position.
1655
+ * @interface
1618
1656
  */
1619
1657
  declare type BoundsChangingEvent = BoundsChangeEvent & {
1620
1658
  type: 'bounds-changing';
@@ -1657,6 +1695,7 @@ declare type Certificate = {
1657
1695
 
1658
1696
  /**
1659
1697
  * Generated when navigating to a URL that fails certificate validation.
1698
+ * @interface
1660
1699
  */
1661
1700
  declare type CertificateErrorEvent = NamedEvent & {
1662
1701
  type: 'certificate-error';
@@ -1676,6 +1715,7 @@ declare type CertificatePrincipal = {
1676
1715
 
1677
1716
  /**
1678
1717
  * Generated when the certificate selection dialog is shown.
1718
+ * @interface
1679
1719
  */
1680
1720
  declare type CertificateSelectionShownEvent = NamedEvent & {
1681
1721
  type: 'certificate-selection-shown';
@@ -1880,7 +1920,7 @@ declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
1880
1920
 
1881
1921
  declare type ChannelAction = OpenFin_2.ChannelAction;
1882
1922
 
1883
- declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_8 | ClientIdentity_2) => unknown;
1923
+ declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
1884
1924
 
1885
1925
  declare class ChannelBase {
1886
1926
  protected subscriptions: Map<string, ChannelAction>;
@@ -2159,17 +2199,17 @@ declare class ChannelBase {
2159
2199
  * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
2160
2200
  * from the provider by registering an action via {@link ChannelClient#register register}.
2161
2201
  *
2162
- * Synchronous Methods:
2202
+ * ### Synchronous Methods:
2163
2203
  * * {@link ChannelClient#onDisconnection onDisconnection(listener)}
2164
2204
  * * {@link ChannelClient#register register(action, listener)}
2165
2205
  * * {@link ChannelClient#remove remove(action)}
2166
2206
  *
2167
- * Asynchronous Methods:
2207
+ * ### Asynchronous Methods:
2168
2208
  * * {@link ChannelClient#disconnect disconnect()}
2169
2209
  * * {@link ChannelClient#dispatch dispatch(action, payload)}
2170
2210
  *
2171
- * Middleware:
2172
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
2211
+ * ### Middleware:
2212
+ * Middleware functions receive the following arguments: (action, payload, senderId).
2173
2213
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
2174
2214
  * unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
2175
2215
  * * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
@@ -2189,16 +2229,16 @@ declare class ChannelClient extends ChannelBase {
2189
2229
  * @internal
2190
2230
  * closes the corresponding channel and invokes the disconnect listener if an event payload is passed.
2191
2231
  */
2192
- static handleProviderDisconnect(eventPayload: ProviderIdentity_3): void;
2232
+ static handleProviderDisconnect(eventPayload: OpenFin_2.ProviderIdentity): void;
2193
2233
  /**
2194
2234
  * @internal
2195
2235
  */
2196
2236
  constructor(routingInfo: RoutingInfo, wire: Transport, strategy: AnyStrategy);
2197
- protected processAction: (action: string, payload: any, senderIdentity: ProviderIdentity_3 | OpenFin_2.ClientIdentity) => Promise<any>;
2237
+ protected processAction: (action: string, payload: any, senderIdentity: OpenFin_2.ProviderIdentity | OpenFin_2.ClientIdentity) => Promise<any>;
2198
2238
  /**
2199
2239
  * a read-only provider identity
2200
2240
  */
2201
- get providerIdentity(): ProviderIdentity_3;
2241
+ get providerIdentity(): OpenFin_2.ProviderIdentity;
2202
2242
  /**
2203
2243
  * Dispatch the given action to the channel provider. Returns a promise that resolves with the response from
2204
2244
  * the provider for that action.
@@ -2265,6 +2305,7 @@ declare type ChannelClient_2 = OpenFin_2.ChannelClient;
2265
2305
 
2266
2306
  /**
2267
2307
  * Generated when a Channel client is connected.
2308
+ * @interface
2268
2309
  */
2269
2310
  declare type ChannelConnectedEvent = BaseChannelEvent & {
2270
2311
  type: 'connected';
@@ -2273,6 +2314,7 @@ declare type ChannelConnectedEvent = BaseChannelEvent & {
2273
2314
  /**
2274
2315
  * Options provided on a client connection to a channel.
2275
2316
  *
2317
+ * @interface
2276
2318
  */
2277
2319
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2278
2320
  /**
@@ -2299,6 +2341,7 @@ declare type ChannelCreateOptions = {
2299
2341
 
2300
2342
  /**
2301
2343
  * Generated when a Channel client has disconnected.
2344
+ * @interface
2302
2345
  */
2303
2346
  declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2304
2347
  type: 'disconnected';
@@ -2324,33 +2367,35 @@ declare namespace ChannelEvents {
2324
2367
  }
2325
2368
 
2326
2369
  /**
2327
- * A Channel event type.
2370
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
2371
+ * discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
2372
+ * under the {@link OpenFin.ChannelEvents} namespace.
2328
2373
  */
2329
2374
  declare type ChannelEventType = ChannelEvent['type'];
2330
2375
 
2331
2376
  declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
2332
2377
 
2333
- declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_8 | ClientIdentity_2) => Promise<unknown> | unknown;
2378
+ declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity_2) => Promise<unknown> | unknown;
2334
2379
 
2335
2380
  /**
2336
2381
  * Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
2337
2382
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
2338
2383
  * and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
2339
2384
  *
2340
- * Synchronous Methods:
2385
+ * ### Synchronous Methods:
2341
2386
  * * {@link ChannelProvider#onConnection onConnection(listener)}
2342
2387
  * * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
2343
2388
  * * {@link ChannelProvider#publish publish(action, payload)}
2344
2389
  * * {@link ChannelProvider#register register(action, listener)}
2345
2390
  * * {@link ChannelProvider#remove remove(action)}
2346
2391
  *
2347
- * Asynchronous Methods:
2392
+ * ### Asynchronous Methods:
2348
2393
  * * {@link ChannelProvider#destroy destroy()}
2349
2394
  * * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
2350
2395
  * * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
2351
2396
  *
2352
- * Middleware:
2353
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
2397
+ * ### Middleware:
2398
+ * Middleware functions receive the following arguments: (action, payload, senderId).
2354
2399
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
2355
2400
  * unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
2356
2401
  * * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
@@ -2372,7 +2417,7 @@ declare class ChannelProvider extends ChannelBase {
2372
2417
  /**
2373
2418
  * @internal
2374
2419
  */
2375
- constructor(providerIdentity: ProviderIdentity_7, wire: Transport, strategy: AnyStrategy);
2420
+ constructor(providerIdentity: ProviderIdentity_6, wire: Transport, strategy: AnyStrategy);
2376
2421
  /**
2377
2422
  * Dispatch an action to a specified client. Returns a promise for the result of executing that action on the client side.
2378
2423
  *
@@ -2543,6 +2588,7 @@ declare interface ChannelStrategy<T extends unknown> {
2543
2588
 
2544
2589
  /**
2545
2590
  * Generated when a child content is blocked to load.
2591
+ * @interface
2546
2592
  */
2547
2593
  declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
2548
2594
  type: 'child-content-blocked';
@@ -2550,6 +2596,7 @@ declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
2550
2596
 
2551
2597
  /**
2552
2598
  * Generated when a child content is loaded into a browser.
2599
+ * @interface
2553
2600
  */
2554
2601
  declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
2555
2602
  type: 'child-content-opened-in-browser';
@@ -2562,6 +2609,7 @@ declare interface ChildContentOptions {
2562
2609
 
2563
2610
  /**
2564
2611
  * Generated when a child View is created.
2612
+ * @interface
2565
2613
  */
2566
2614
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
2567
2615
  type: 'child-view-created';
@@ -2573,6 +2621,7 @@ declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
2573
2621
 
2574
2622
  /**
2575
2623
  * Generated when a child Window is created.
2624
+ * @interface
2576
2625
  */
2577
2626
  declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
2578
2627
  type: 'child-window-created';
@@ -2597,9 +2646,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
2597
2646
  private endpointId;
2598
2647
  private providerIdentity;
2599
2648
  constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
2600
- providerIdentity: ProviderIdentity_5);
2649
+ providerIdentity: ProviderIdentity_4);
2601
2650
  onEndpointDisconnect(endpointId: string, listener: () => void): void;
2602
- receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
2651
+ receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
2603
2652
  send: (endpointId: string, action: string, payload: any) => Promise<any>;
2604
2653
  close: () => Promise<void>;
2605
2654
  closeEndpoint(endpointId: string): Promise<void>;
@@ -2632,12 +2681,16 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
2632
2681
  data: T;
2633
2682
  };
2634
2683
 
2684
+ /**
2685
+ * @interface
2686
+ */
2635
2687
  declare type ClientConnectionPayload = ClientIdentity_2 & ClientInfo;
2636
2688
 
2637
2689
  declare type ClientIdentity = OpenFin_2.ClientIdentity;
2638
2690
 
2639
2691
  /**
2640
2692
  * Identity of a channel client
2693
+ * @interface
2641
2694
  */
2642
2695
  declare type ClientIdentity_2 = Identity_5 & {
2643
2696
  /**
@@ -2647,12 +2700,16 @@ declare type ClientIdentity_2 = Identity_5 & {
2647
2700
  isLocalEndpointId: boolean;
2648
2701
  };
2649
2702
 
2703
+ /**
2704
+ * @interface
2705
+ */
2650
2706
  declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
2651
2707
  runtimeUuid: string;
2652
2708
  };
2653
2709
 
2654
2710
  /**
2655
2711
  * Extended channel client information
2712
+ * @interface
2656
2713
  */
2657
2714
  declare type ClientInfo = Omit<ClientIdentity_2, 'isLocalEndpointId'> & {
2658
2715
  /**
@@ -2844,6 +2901,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
2844
2901
 
2845
2902
  /**
2846
2903
  * Generated when an application is closed.
2904
+ * @interface
2847
2905
  */
2848
2906
  declare type ClosedEvent = IdentityEvent & {
2849
2907
  type: 'closed';
@@ -2860,6 +2918,9 @@ declare type CloseViewPayload = {
2860
2918
  view: Identity_5;
2861
2919
  };
2862
2920
 
2921
+ /**
2922
+ * Represents the shape of payload that contains the Window Identity and related options.
2923
+ */
2863
2924
  declare interface CloseWindowPayload {
2864
2925
  /**
2865
2926
  *
@@ -3296,6 +3357,9 @@ declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
3296
3357
  data?: unknown;
3297
3358
  };
3298
3359
 
3360
+ /**
3361
+ * @interface
3362
+ */
3299
3363
  declare type ContentCreationRulesEvent = NamedEvent & {
3300
3364
  /**
3301
3365
  * The absolute url which triggered this event.
@@ -3354,6 +3418,9 @@ declare type Context = {
3354
3418
  type: string;
3355
3419
  };
3356
3420
 
3421
+ /**
3422
+ * @interface
3423
+ */
3357
3424
  declare type ContextForIntent<MetadataType = any> = Context & {
3358
3425
  metadata?: MetadataType;
3359
3426
  };
@@ -3456,6 +3523,7 @@ declare type CpuInfo = {
3456
3523
 
3457
3524
  /**
3458
3525
  * Generated when an application has crashed.
3526
+ * @interface
3459
3527
  */
3460
3528
  declare type CrashedEvent = NamedEvent & {
3461
3529
  type: 'crashed';
@@ -3475,6 +3543,9 @@ declare type CrashReporterOptions = {
3475
3543
  diagnosticsMode: boolean;
3476
3544
  };
3477
3545
 
3546
+ /**
3547
+ * @interface
3548
+ */
3478
3549
  declare type CrashReporterState = CrashReporterOptions & {
3479
3550
  /**
3480
3551
  * Whether the crash reporter is running
@@ -3485,6 +3556,7 @@ declare type CrashReporterState = CrashReporterOptions & {
3485
3556
 
3486
3557
  /**
3487
3558
  * Generated when a View is created.
3559
+ * @interface
3488
3560
  */
3489
3561
  declare type CreatedEvent = BaseViewEvent & {
3490
3562
  type: 'created';
@@ -3502,6 +3574,9 @@ declare type CreateViewPayload = {
3502
3574
  targetView?: Identity_5;
3503
3575
  };
3504
3576
 
3577
+ /**
3578
+ * @interface
3579
+ */
3505
3580
  declare type CreateViewTarget = Identity_5 & {
3506
3581
  /**
3507
3582
  * If specified, view creation will not attach to a window and caller must
@@ -3541,6 +3616,7 @@ declare type DefaultDomainSettingsRule = {
3541
3616
 
3542
3617
  /**
3543
3618
  * Generated when the desktop icon is clicked while it's already running.
3619
+ * @interface
3544
3620
  */
3545
3621
  declare type DesktopIconClickedEvent = BaseEvent & {
3546
3622
  type: 'desktop-icon-clicked';
@@ -3548,6 +3624,7 @@ declare type DesktopIconClickedEvent = BaseEvent & {
3548
3624
 
3549
3625
  /**
3550
3626
  * Generated when a View is destroyed.
3627
+ * @interface
3551
3628
  */
3552
3629
  declare type DestroyedEvent = BaseViewEvent & {
3553
3630
  type: 'destroyed';
@@ -3555,6 +3632,7 @@ declare type DestroyedEvent = BaseViewEvent & {
3555
3632
 
3556
3633
  /**
3557
3634
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
3635
+ * @interface
3558
3636
  */
3559
3637
  declare type DidChangeThemeColorEvent = NamedEvent & {
3560
3638
  type: 'did-change-theme-color';
@@ -3562,6 +3640,7 @@ declare type DidChangeThemeColorEvent = NamedEvent & {
3562
3640
 
3563
3641
  /**
3564
3642
  * Generated when load failed.
3643
+ * @interface
3565
3644
  */
3566
3645
  declare type DidFailLoadEvent = BaseLoadFailedEvent & {
3567
3646
  type: 'did-fail-load';
@@ -3569,11 +3648,15 @@ declare type DidFailLoadEvent = BaseLoadFailedEvent & {
3569
3648
 
3570
3649
  /**
3571
3650
  * Generated when the navigation is done, i.e. the spinner of the tab will stop spinning, and the onload event is dispatched.
3651
+ * @interface
3572
3652
  */
3573
3653
  declare type DidFinishLoadEvent = NamedEvent & {
3574
3654
  type: 'did-finish-load';
3575
3655
  };
3576
3656
 
3657
+ /**
3658
+ * @interface
3659
+ */
3577
3660
  declare type DipRect = RectangleByEdgePositions & {
3578
3661
  dipRect: RectangleByEdgePositions;
3579
3662
  scaledRect: RectangleByEdgePositions;
@@ -3586,6 +3669,7 @@ declare type DipScaleRects = {
3586
3669
 
3587
3670
  /**
3588
3671
  * Generated after a change to a window's size and/or position is attempted while window movement is disabled.
3672
+ * @interface
3589
3673
  */
3590
3674
  declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
3591
3675
  type: 'disabled-movement-bounds-changed';
@@ -3593,12 +3677,13 @@ declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
3593
3677
 
3594
3678
  /**
3595
3679
  * Generated while a change to a window's size and/or position is attempted while window movement is disabled.
3680
+ * @interface
3596
3681
  */
3597
3682
  declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
3598
3683
  type: 'disabled-movement-bounds-changing';
3599
3684
  };
3600
3685
 
3601
- declare type DisconnectionListener = (providerIdentity: ProviderIdentity_3) => any;
3686
+ declare type DisconnectionListener = (providerIdentity: OpenFin_2.ProviderIdentity) => any;
3602
3687
 
3603
3688
  declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
3604
3689
 
@@ -3669,6 +3754,7 @@ declare type Dpi = {
3669
3754
 
3670
3755
  /**
3671
3756
  * Generated when a window has been embedded.
3757
+ * @interface
3672
3758
  */
3673
3759
  declare type EmbeddedEvent = NamedEvent & {
3674
3760
  type: 'embedded';
@@ -3779,6 +3865,7 @@ declare class EmitterMap {
3779
3865
 
3780
3866
  /**
3781
3867
  * Generated when a window ends loading.
3868
+ * @interface
3782
3869
  */
3783
3870
  declare type EndLoadEvent = NamedEvent & {
3784
3871
  type: 'end-load';
@@ -3786,7 +3873,7 @@ declare type EndLoadEvent = NamedEvent & {
3786
3873
  isMain: boolean;
3787
3874
  };
3788
3875
 
3789
- declare type EndpointIdentity = OpenFin_2.ClientIdentity | ProviderIdentity_4;
3876
+ declare type EndpointIdentity = OpenFin_2.ClientIdentity | ProviderIdentity_3;
3790
3877
 
3791
3878
  declare type EndpointPayload = {
3792
3879
  endpointIdentity: EndpointIdentity;
@@ -3794,6 +3881,7 @@ declare type EndpointPayload = {
3794
3881
 
3795
3882
  /**
3796
3883
  * Generated at the end of a user-driven change to a window's size or position.
3884
+ * @interface
3797
3885
  */
3798
3886
  declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
3799
3887
  type: 'end-user-bounds-changing';
@@ -3809,6 +3897,9 @@ declare type EntityInfo_2 = {
3809
3897
  entityType: EntityType;
3810
3898
  };
3811
3899
 
3900
+ /**
3901
+ * @interface
3902
+ */
3812
3903
  declare type EntityProcessDetails = FrameProcessDetails & {
3813
3904
  name: string;
3814
3905
  uuid: string;
@@ -3878,7 +3969,7 @@ declare interface Environment {
3878
3969
 
3879
3970
  declare type ErrorMiddleware = OpenFin_2.ErrorMiddleware;
3880
3971
 
3881
- declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_8 | ClientIdentity_2) => unknown;
3972
+ declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
3882
3973
 
3883
3974
  /**
3884
3975
  * This function converts JS errors into plain objects
@@ -3936,7 +4027,7 @@ declare type ExitCode = {
3936
4027
  /**
3937
4028
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
3938
4029
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
3939
- * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
4030
+ * Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
3940
4031
  *
3941
4032
  * Processes that can be wrapped as `ExternalApplication`s include the following:
3942
4033
  * - Processes which have connected to an OpenFin runtime via an adapter
@@ -4043,6 +4134,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
4043
4134
 
4044
4135
  /**
4045
4136
  * Generated when an external application has authenticated and is connected.
4137
+ * @interface
4046
4138
  */
4047
4139
  declare type ExternalApplicationConnectedEvent = BaseEvent & {
4048
4140
  type: 'connected';
@@ -4050,13 +4142,16 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
4050
4142
 
4051
4143
  /**
4052
4144
  * Generated when an external application has disconnected.
4145
+ * @interface
4053
4146
  */
4054
4147
  declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
4055
4148
  type: 'disconnected';
4056
4149
  };
4057
4150
 
4058
4151
  /**
4059
- * An external application event.
4152
+ * [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
4153
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
4154
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
4060
4155
  */
4061
4156
  declare type ExternalApplicationEvent = {
4062
4157
  topic: 'externalapplication';
@@ -4076,6 +4171,9 @@ declare type ExternalApplicationInfo = {
4076
4171
  parent: Identity_5;
4077
4172
  };
4078
4173
 
4174
+ /**
4175
+ * Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
4176
+ */
4079
4177
  declare class ExternalApplicationModule extends Base {
4080
4178
  /**
4081
4179
  * Asynchronously returns an External Application object that represents an external application.
@@ -4120,6 +4218,7 @@ declare type ExternalConnection = {
4120
4218
 
4121
4219
  /**
4122
4220
  * Generated when an external process has exited.
4221
+ * @interface
4123
4222
  */
4124
4223
  declare type ExternalProcessExitedEvent = NamedEvent & {
4125
4224
  type: 'external-process-exited';
@@ -4158,6 +4257,7 @@ declare type ExternalProcessRequestType = {
4158
4257
 
4159
4258
  /**
4160
4259
  * Generated when an external process has started.
4260
+ * @interface
4161
4261
  */
4162
4262
  declare type ExternalProcessStartedEvent = NamedEvent & {
4163
4263
  type: 'external-process-started';
@@ -4166,6 +4266,7 @@ declare type ExternalProcessStartedEvent = NamedEvent & {
4166
4266
 
4167
4267
  /**
4168
4268
  * Generated when page receives favicon urls.
4269
+ * @interface
4169
4270
  */
4170
4271
  declare type FaviconUpdatedEvent = NamedEvent & {
4171
4272
  type: 'page-favicon-updated';
@@ -4183,6 +4284,7 @@ declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
4183
4284
 
4184
4285
  /**
4185
4286
  * Generated when a file download has completed.
4287
+ * @interface
4186
4288
  */
4187
4289
  declare type FileDownloadCompletedEvent = FileDownloadEvent & {
4188
4290
  type: 'file-download-completed';
@@ -4191,6 +4293,7 @@ declare type FileDownloadCompletedEvent = FileDownloadEvent & {
4191
4293
 
4192
4294
  /**
4193
4295
  * A general file download event without event type.
4296
+ * @interface
4194
4297
  */
4195
4298
  declare type FileDownloadEvent = {
4196
4299
  /**
@@ -4242,6 +4345,8 @@ declare type FileDownloadEvent = {
4242
4345
  /**
4243
4346
  * Generated when setFileDownloadLocation api is called.
4244
4347
  * @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'.
4348
+ *
4349
+ * @interface
4245
4350
  */
4246
4351
  declare type FileDownloadLocationChangedEvent = NamedEvent & {
4247
4352
  type: 'file-download-location-changed';
@@ -4249,6 +4354,7 @@ declare type FileDownloadLocationChangedEvent = NamedEvent & {
4249
4354
 
4250
4355
  /**
4251
4356
  * Generated during file download progress.
4357
+ * @interface
4252
4358
  */
4253
4359
  declare type FileDownloadProgressEvent = FileDownloadEvent & {
4254
4360
  type: 'file-download-progress';
@@ -4261,6 +4367,7 @@ declare type FileDownloadSettings = {
4261
4367
 
4262
4368
  /**
4263
4369
  * Generated when a file download has started.
4370
+ * @interface
4264
4371
  */
4265
4372
  declare type FileDownloadStartedEvent = FileDownloadEvent & {
4266
4373
  type: 'file-download-started';
@@ -4348,6 +4455,7 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
4348
4455
 
4349
4456
  /**
4350
4457
  * Generated when a WebContents gains focus.
4458
+ * @interface
4351
4459
  */
4352
4460
  declare type FocusedEvent = NamedEvent & {
4353
4461
  type: 'focused';
@@ -4355,6 +4463,7 @@ declare type FocusedEvent = NamedEvent & {
4355
4463
 
4356
4464
  /**
4357
4465
  * Generated when a result is available when calling findInPage.
4466
+ * @interface
4358
4467
  */
4359
4468
  declare type FoundInPageEvent = NamedEvent & {
4360
4469
  type: 'found-in-page';
@@ -4496,6 +4605,7 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
4496
4605
 
4497
4606
  /**
4498
4607
  * Generated when a frame is connected.
4608
+ * @interface
4499
4609
  */
4500
4610
  declare type FrameConnectedEvent = BaseFrameEvent & {
4501
4611
  type: 'connected';
@@ -4503,6 +4613,7 @@ declare type FrameConnectedEvent = BaseFrameEvent & {
4503
4613
 
4504
4614
  /**
4505
4615
  * Generated when a frame has disconnected.
4616
+ * @interface
4506
4617
  */
4507
4618
  declare type FrameDisconnectedEvent = BaseFrameEvent & {
4508
4619
  type: 'disconnected';
@@ -4528,7 +4639,9 @@ declare namespace FrameEvents {
4528
4639
  }
4529
4640
 
4530
4641
  /**
4531
- * A Frame event type.
4642
+ * [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
4643
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
4644
+ * under the {@link OpenFin.FrameEvents} namespace.
4532
4645
  */
4533
4646
  declare type FrameEventType = FrameEvent['type'];
4534
4647
 
@@ -4540,6 +4653,9 @@ declare type FrameInfo = {
4540
4653
  parent: Identity_5;
4541
4654
  };
4542
4655
 
4656
+ /**
4657
+ * Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
4658
+ */
4543
4659
  declare class _FrameModule extends Base {
4544
4660
  /**
4545
4661
  * Asynchronously returns a reference to the specified frame. The frame does not have to exist
@@ -4589,6 +4705,9 @@ declare class _FrameModule extends Base {
4589
4705
  getCurrentSync(): OpenFin_2.Frame;
4590
4706
  }
4591
4707
 
4708
+ /**
4709
+ * @interface
4710
+ */
4592
4711
  declare type FrameProcessDetails = ProcessDetails & {
4593
4712
  /**
4594
4713
  * Current URL associated with the process.
@@ -4735,7 +4854,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
4735
4854
  }
4736
4855
 
4737
4856
  /**
4738
- * A global hotkey event.
4857
+ * [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
4858
+ * discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
4859
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
4739
4860
  */
4740
4861
  declare type GlobalHotkeyEvent = {
4741
4862
  topic: 'global-hotkey';
@@ -4756,18 +4877,11 @@ declare type GpuInfo = {
4756
4877
  name: string;
4757
4878
  };
4758
4879
 
4759
- /**
4760
- * Generated when a window has been hidden.
4761
- */
4762
- declare type HiddenEvent = NamedEvent & {
4763
- type: 'hidden';
4764
- reason: 'closing' | 'hide' | 'hide-on-close';
4765
- };
4766
-
4767
4880
  /**
4768
4881
  * Generated when a View is hidden.
4882
+ * @interface
4769
4883
  */
4770
- declare type HiddenEvent_2 = BaseViewEvent & {
4884
+ declare type HiddenEvent = BaseViewEvent & {
4771
4885
  type: 'hidden';
4772
4886
  };
4773
4887
 
@@ -4834,6 +4948,7 @@ declare type Hotkey = {
4834
4948
  /**
4835
4949
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [View options](OpenFin.ViewOptions.html) is pressed inside the view.
4836
4950
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
4951
+ * @interface
4837
4952
  */
4838
4953
  declare type HotkeyEvent = BaseViewEvent & {
4839
4954
  type: 'hotkey';
@@ -4868,6 +4983,7 @@ declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<Add
4868
4983
 
4869
4984
  /**
4870
4985
  * An Identity event.
4986
+ * @interface
4871
4987
  */
4872
4988
  declare type IdentityEvent = BaseEvent & {
4873
4989
  uuid: string;
@@ -4883,6 +4999,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
4883
4999
  * @remarks This method is continuously generated every minute while the user is in idle.
4884
5000
  * A user enters idle state when the computer is locked or when there has been no keyboard/mouse activity for 1 minute.
4885
5001
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
5002
+ * @interface
4886
5003
  */
4887
5004
  declare type IdleEvent = {
4888
5005
  type: 'idle-state-changed';
@@ -4911,6 +5028,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
4911
5028
 
4912
5029
  /**
4913
5030
  * Generated when an application has initialized.
5031
+ * @interface
4914
5032
  */
4915
5033
  declare type InitializedEvent = IdentityEvent & {
4916
5034
  type: 'initialized';
@@ -4941,6 +5059,7 @@ declare type InitPlatformOptions = {
4941
5059
 
4942
5060
  /**
4943
5061
  * Generated when the value of the element changes.
5062
+ * @interface
4944
5063
  */
4945
5064
  declare type InputEvent_2 = {
4946
5065
  inputType: 'keyUp' | 'keyDown';
@@ -5106,6 +5225,9 @@ declare class InterAppPayload {
5106
5225
 
5107
5226
  declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
5108
5227
 
5228
+ /**
5229
+ * Define whether to enable interop action logging.
5230
+ */
5109
5231
  declare interface InteropActionLoggingOption {
5110
5232
  enabled: boolean;
5111
5233
  }
@@ -6481,6 +6603,138 @@ declare type LaunchIntoPlatformPayload = {
6481
6603
  manifest: any;
6482
6604
  };
6483
6605
 
6606
+ /**
6607
+ *
6608
+ * Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
6609
+ * enables the initialization and manipulation of a window's Layout. A Layout will
6610
+ * emit events locally on the DOM element representing the layout-container.
6611
+ *
6612
+ *
6613
+ * ### Layout.DOMEvents
6614
+ *
6615
+ * When a Layout is created, it emits events onto the DOM element representing the Layout container.
6616
+ * This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
6617
+ * 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).
6618
+ * The events are emitted synchronously and only in the process where the Layout exists.
6619
+ * Any values returned by the called listeners are ignored and will be discarded.
6620
+ * If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
6621
+ *
6622
+ * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
6623
+ *
6624
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
6625
+ * Adds a listener to the end of the listeners array for the specified event.
6626
+ * @example
6627
+ * ```js
6628
+ * const myLayoutContainer = document.getElementById('layout-container');
6629
+ *
6630
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
6631
+ * const { tabSelector } = event.detail;
6632
+ * const tabElement = document.getElementById(tabSelector);
6633
+ * const existingColor = tabElement.style.backgroundColor;
6634
+ * tabElement.style.backgroundColor = "red";
6635
+ * setTimeout(() => {
6636
+ * tabElement.style.backgroundColor = existingColor;
6637
+ * }, 2000);
6638
+ * });
6639
+ * ```
6640
+ *
6641
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
6642
+ * Adds a listener to the end of the listeners array for the specified event.
6643
+ * @example
6644
+ * ```js
6645
+ * const myLayoutContainer = document.getElementById('layout-container');
6646
+ *
6647
+ * const listener = function(event) {
6648
+ * console.log(event.detail);
6649
+ * console.log('container-created event fired once, removing listener');
6650
+ * myLayoutContainer.removeEventListener('container-created', listener);
6651
+ * };
6652
+ *
6653
+ * myLayoutContainer.addEventListener('container-created', listener);
6654
+ * ```
6655
+ *
6656
+ * ### Supported event types are:
6657
+ *
6658
+ * * tab-created
6659
+ * * container-created
6660
+ * * layout-state-changed
6661
+ * * tab-closed
6662
+ * * tab-dropped
6663
+ *
6664
+ * ### Layout DOM Node Events
6665
+ *
6666
+ * #### tab-created
6667
+ * 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.
6668
+ * ```js
6669
+ * // The response has the following shape in event.detail:
6670
+ * {
6671
+ * containerSelector: "container-component_A",
6672
+ * name: "component_A",
6673
+ * tabSelector: "tab-component_A",
6674
+ * topic: "openfin-DOM-event",
6675
+ * type: "tab-created",
6676
+ * uuid: "OpenFin POC"
6677
+ * }
6678
+ * ```
6679
+ *
6680
+ * #### container-created
6681
+ * 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.
6682
+ * ```js
6683
+ * // The response has the following shape in event.detail:
6684
+ * {
6685
+ * containerSelector: "container-component_A",
6686
+ * name: "component_A",
6687
+ * tabSelector: "tab-component_A",
6688
+ * topic: "openfin-DOM-event",
6689
+ * type: "container-created",
6690
+ * uuid: "OpenFin POC"
6691
+ * }
6692
+ * ```
6693
+ *
6694
+ * ### layout-state-changed
6695
+ * 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.
6696
+ * ```js
6697
+ * // The response has the following shape in event.detail
6698
+ * {
6699
+ * containerSelector: "container-component_A",
6700
+ * name: "component_A",
6701
+ * tabSelector: "tab-component_A",
6702
+ * topic: "openfin-DOM-event",
6703
+ * type: "layout-state-changed",
6704
+ * uuid: "OpenFin POC"
6705
+ * }
6706
+ * ```
6707
+ *
6708
+ * #### tab-closed
6709
+ * Generated when a tab is closed.
6710
+ * ```js
6711
+ * // The response has the following shape in event.detail:
6712
+ * {
6713
+ * containerSelector: "container-component_A",
6714
+ * name: "component_A",
6715
+ * tabSelector: "tab-component_A",
6716
+ * topic: "openfin-DOM-event",
6717
+ * type: "tab-closed",
6718
+ * uuid: "OpenFin POC",
6719
+ * url: "http://openfin.co" // The url of the view that was closed.
6720
+ * }
6721
+ * ```
6722
+ *
6723
+ * #### tab-dropped
6724
+ * Generated when a tab is dropped.
6725
+ * ```js
6726
+ * // The response has the following shape in event.detail:
6727
+ * {
6728
+ * containerSelector: "container-component_A",
6729
+ * name: "component_A",
6730
+ * tabSelector: "tab-component_A",
6731
+ * topic: "openfin-DOM-event",
6732
+ * type: "tab-dropped",
6733
+ * uuid: "OpenFin POC",
6734
+ * url: "http://openfin.co" // The url of the view linked to the dropped tab.
6735
+ * }
6736
+ * ```
6737
+ */
6484
6738
  declare class Layout extends Base {
6485
6739
  #private;
6486
6740
  /**
@@ -6781,6 +7035,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
6781
7035
 
6782
7036
  /**
6783
7037
  * Generated when a window and all of its layout's views have either finished or failed navigation.
7038
+ * @interface
6784
7039
  */
6785
7040
  declare type LayoutInitializedEvent = NamedEvent & {
6786
7041
  type: 'layout-initialized';
@@ -6902,6 +7157,9 @@ declare class LayoutManager {
6902
7157
  private setComponentState;
6903
7158
  }
6904
7159
 
7160
+ /**
7161
+ * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
7162
+ */
6905
7163
  declare class LayoutModule extends Base {
6906
7164
  #private;
6907
7165
  /**
@@ -7255,6 +7513,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
7255
7513
 
7256
7514
  /**
7257
7515
  * Generated when a window and all of its layout's views have been created and can receive API calls.
7516
+ * @interface
7258
7517
  */
7259
7518
  declare type LayoutReadyEvent = NamedEvent & {
7260
7519
  type: 'layout-ready';
@@ -7362,6 +7621,7 @@ declare type Manifest = {
7362
7621
 
7363
7622
  /**
7364
7623
  * Generated when the RVM notifies an application that the manifest has changed.
7624
+ * @interface
7365
7625
  */
7366
7626
  declare type ManifestChangedEvent = IdentityEvent & {
7367
7627
  type: 'manifest-changed';
@@ -7405,6 +7665,7 @@ declare type MatchPattern = string;
7405
7665
 
7406
7666
  /**
7407
7667
  * Generated when a window is maximized.
7668
+ * @interface
7408
7669
  */
7409
7670
  declare type MaximizedEvent = NamedEvent & {
7410
7671
  type: 'maximized';
@@ -7477,6 +7738,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
7477
7738
 
7478
7739
  /**
7479
7740
  * Generated when a window is minimized.
7741
+ * @interface
7480
7742
  */
7481
7743
  declare type MinimizedEvent = NamedEvent & {
7482
7744
  type: 'minimized';
@@ -7522,6 +7784,7 @@ declare type MonitorDetails = {
7522
7784
  * Generated on changes of a monitor's size/location.
7523
7785
  * @remarks A monitor's size changes when the taskbar is resized or relocated.
7524
7786
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
7787
+ * @interface
7525
7788
  */
7526
7789
  declare type MonitorEvent = OpenFin_2.MonitorInfo & {
7527
7790
  type: 'monitor-info-changed';
@@ -7877,6 +8140,7 @@ declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => v
7877
8140
 
7878
8141
  /**
7879
8142
  * A Name event.
8143
+ * @interface
7880
8144
  */
7881
8145
  declare type NamedEvent = IdentityEvent & {
7882
8146
  name: string;
@@ -7888,6 +8152,7 @@ declare type NativeWindowIntegrationProviderAuthorization = {
7888
8152
 
7889
8153
  /**
7890
8154
  * Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
8155
+ * @interface
7891
8156
  */
7892
8157
  declare type NavigationRejectedEvent = NamedEvent & {
7893
8158
  type: 'navigation-rejected';
@@ -7908,6 +8173,9 @@ declare type NavigationRules = {
7908
8173
 
7909
8174
  declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
7910
8175
 
8176
+ /**
8177
+ * @interface
8178
+ */
7911
8179
  declare type NonAppProcessDetails = ProcessDetails & {
7912
8180
  name: string;
7913
8181
  };
@@ -7934,6 +8202,7 @@ declare type NotRequested<EventType> = EventType extends `${infer U}-requested`
7934
8202
 
7935
8203
  /**
7936
8204
  * Generated when an application is not responding.
8205
+ * @interface
7937
8206
  */
7938
8207
  declare type NotRespondingEvent = IdentityEvent & {
7939
8208
  type: 'not-responding';
@@ -7941,6 +8210,9 @@ declare type NotRespondingEvent = IdentityEvent & {
7941
8210
 
7942
8211
  declare type OnlyIfCompatible<A, B, D = OverlapsOnlyIfMatching<A, B>> = D extends Record<any, never> ? keyof D extends never ? A | B : never : A | B;
7943
8212
 
8213
+ /**
8214
+ * @interface
8215
+ */
7944
8216
  declare type Opacity = TransitionBase & {
7945
8217
  /**
7946
8218
  * The opacity from 0.0 (transparent) to 1.0 (normal).
@@ -8175,7 +8447,7 @@ declare namespace OpenFin_2 {
8175
8447
  ContextForIntent,
8176
8448
  InfoForIntentOptions,
8177
8449
  FindIntentsByContextOptions,
8178
- ProviderIdentity_8 as ProviderIdentity,
8450
+ ProviderIdentity_7 as ProviderIdentity,
8179
8451
  RegisterUsageData,
8180
8452
  ViewsPreventingUnloadPayload,
8181
8453
  BeforeUnloadUserDecision,
@@ -8247,7 +8519,8 @@ declare namespace OpenFin_2 {
8247
8519
  InteropLoggingOptions,
8248
8520
  Me,
8249
8521
  CapturePageOptions,
8250
- ProcessLoggingOptions
8522
+ ProcessLoggingOptions,
8523
+ PositioningOptions
8251
8524
  }
8252
8525
  }
8253
8526
  export default OpenFin_2;
@@ -8263,6 +8536,7 @@ declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T>
8263
8536
  /**
8264
8537
  * Generated when page title is set during navigation.
8265
8538
  * @remarks explicitSet is false when title is synthesized from file url.
8539
+ * @interface
8266
8540
  */
8267
8541
  declare type PageTitleUpdatedEvent = NamedEvent & {
8268
8542
  type: 'page-title-updated';
@@ -8280,6 +8554,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
8280
8554
 
8281
8555
  /**
8282
8556
  * Generated when window finishes loading. Provides performance and navigation data.
8557
+ * @interface
8283
8558
  */
8284
8559
  declare type PerformanceReportEvent = Performance & NamedEvent & {
8285
8560
  type: 'performance-report';
@@ -8576,12 +8851,11 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
8576
8851
  */
8577
8852
  closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
8578
8853
  /**
8579
- * ***DEPRECATED - please use Platform.createView.***
8854
+ * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
8580
8855
  * Reparents a specified view in a new target window.
8581
8856
  * @param viewIdentity View identity
8582
8857
  * @param target new owner window identity
8583
8858
  *
8584
- * @tutorial Platform.createView
8585
8859
  */
8586
8860
  reparentView(viewIdentity: OpenFin_2.Identity, target: OpenFin_2.Identity): Promise<View>;
8587
8861
  /**
@@ -8948,6 +9222,7 @@ declare type Platform_2 = OpenFin_2.Platform;
8948
9222
 
8949
9223
  /**
8950
9224
  * Generated when a new Platform's API becomes responsive.
9225
+ * @interface
8951
9226
  */
8952
9227
  declare type PlatformApiReadyEvent = BaseEvent & {
8953
9228
  topic: 'application';
@@ -8955,7 +9230,9 @@ declare type PlatformApiReadyEvent = BaseEvent & {
8955
9230
  };
8956
9231
 
8957
9232
  /**
8958
- * A Platform event.
9233
+ * [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
9234
+ * discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
9235
+ * under the {@link OpenFin.PlatformEvents} namespace.
8959
9236
  */
8960
9237
  declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
8961
9238
 
@@ -8969,6 +9246,9 @@ declare namespace PlatformEvents {
8969
9246
  }
8970
9247
  }
8971
9248
 
9249
+ /**
9250
+ * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
9251
+ */
8972
9252
  declare class PlatformModule extends Base {
8973
9253
  private _channel;
8974
9254
  Layout: LayoutModule;
@@ -9128,6 +9408,7 @@ declare class PlatformModule extends Base {
9128
9408
  /**
9129
9409
  * The options object required by {@link Platform.PlatformModule#start Platform.start}
9130
9410
  * Any {@link ApplicationOptions Application option} is also a valid platform option
9411
+ * @interface
9131
9412
  */
9132
9413
  declare type PlatformOptions = ApplicationCreationOptions & {
9133
9414
  /**
@@ -9672,6 +9953,7 @@ declare interface PlatformProvider {
9672
9953
  * 3. If a window has a layout property, the 'layout-ready' event has fired
9673
9954
  *
9674
9955
  * _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.
9956
+ * @interface
9675
9957
  */
9676
9958
  declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9677
9959
  topic: 'application';
@@ -9680,6 +9962,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9680
9962
 
9681
9963
  declare type PlatformViewCreationOptions = Partial<ViewOptions>;
9682
9964
 
9965
+ /**
9966
+ * @interface
9967
+ */
9683
9968
  declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
9684
9969
  updateStateIfExists?: boolean;
9685
9970
  reason?: WindowCreationReason;
@@ -9690,6 +9975,7 @@ declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
9690
9975
  * Any {@link OpenFin.WindowCreationOptions Window option} is also a valid Default Window option
9691
9976
  * used by default in any window that is created in the current platform's scope.
9692
9977
  * Individual window options will override these defaults.
9978
+ * @interface
9693
9979
  */
9694
9980
  declare type PlatformWindowOptions = WindowCreationOptions & {
9695
9981
  /**
@@ -9728,35 +10014,117 @@ declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
9728
10014
 
9729
10015
  declare type PopupInteraction = 'clicked' | 'dismissed';
9730
10016
 
10017
+ /**
10018
+ * Popup window options.
10019
+ */
9731
10020
  declare interface PopupOptions {
10021
+ /**
10022
+ * Window creation options when using `showPopupWindow` to create a new window.
10023
+ */
9732
10024
  initialOptions?: Optional<WindowCreationOptions, 'name'>;
10025
+ /**
10026
+ * Updatable window options applied to new and existing windows when shown as popups.
10027
+ */
9733
10028
  additionalOptions?: UpdatableWindowOptions;
10029
+ /**
10030
+ * If a window with this `name` exists, it will be shown as a popup.
10031
+ * 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.
10032
+ */
9734
10033
  name?: string;
10034
+ /**
10035
+ * Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
10036
+ */
9735
10037
  url?: string;
10038
+ /**
10039
+ * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
10040
+ * @defaultValue 300
10041
+ */
9736
10042
  height?: number;
10043
+ /**
10044
+ * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
10045
+ * @defaultValue 300
10046
+ */
9737
10047
  width?: number;
10048
+ /**
10049
+ * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
10050
+ * @defaultValue 0
10051
+ */
9738
10052
  x?: number;
10053
+ /**
10054
+ * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
10055
+ * @defaultValue 0
10056
+ */
9739
10057
  y?: number;
10058
+ /**
10059
+ * Determines what happens if the popup window is blurred.
10060
+ * * 'modal' restricts resizing and positioning in the caller.
10061
+ * * 'hide' hides the popup window on blur.
10062
+ * * 'close' closes the popup window on blur.
10063
+ * @defaultValue 'close'
10064
+ */
9740
10065
  blurBehavior?: PopupBlurBehavior;
10066
+ /**
10067
+ * Determines what happens when the popup window calls `dispatchPopupResult`.
10068
+ * * 'none' will do nothing.
10069
+ * * 'hide' hides the popup window on `dispatchPopupResult`.
10070
+ * * 'close' closes the popup window on `dispatchPopupResult`.
10071
+ * @defaultValue 'close'
10072
+ */
9741
10073
  resultDispatchBehavior?: PopupResultBehavior;
10074
+ /**
10075
+ * Hide the popup window instead of closing when `close` is called on it.
10076
+ * <br>Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
10077
+ * @defaultValue false
10078
+ */
9742
10079
  hideOnClose?: boolean;
10080
+ /**
10081
+ * Determines if the popup window should or should not be focused when it is shown.
10082
+ * @defaultValue true
10083
+ */
9743
10084
  focus?: boolean;
10085
+ /**
10086
+ * 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.
10087
+ */
9744
10088
  onPopupReady?: (popupWindow: _Window) => any;
10089
+ /**
10090
+ * Executed when this window's popup calls `dispatchPopupResult`.
10091
+ * <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
10092
+ */
9745
10093
  onPopupResult?: (payload: PopupResult) => any;
9746
10094
  }
9747
10095
 
10096
+ /**
10097
+ * The Popup result.
10098
+ *
10099
+ * @typeParam T - Type of data the Popup result contains
10100
+ */
9748
10101
  declare interface PopupResult<T = any> {
10102
+ /**
10103
+ * `name` and `uuid` of the popup window that called dispatched this result.
10104
+ */
9749
10105
  identity: {
9750
10106
  name: string;
9751
10107
  uuid: string;
9752
10108
  };
10109
+ /**
10110
+ * Result of the user interaction with the popup window.
10111
+ */
9753
10112
  result: PopupInteraction;
10113
+ /**
10114
+ * Data passed to `dispatchPopupResult`.
10115
+ */
9754
10116
  data?: T;
10117
+ /**
10118
+ * The last dispatch result.
10119
+ */
9755
10120
  lastDispatchResult?: PopupResult;
9756
10121
  }
9757
10122
 
9758
10123
  declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
9759
10124
 
10125
+ /**
10126
+ * @interface
10127
+ */
9760
10128
  declare type Position = TransitionBase & {
9761
10129
  /**
9762
10130
  * Defaults to the window's current left position in virtual screen coordinates.
@@ -9768,6 +10136,26 @@ declare type Position = TransitionBase & {
9768
10136
  top: number;
9769
10137
  };
9770
10138
 
10139
+ /**
10140
+ * Leveraged by the following windowing apis to influence side effects of the positioning.
10141
+ * - {@link OpenFin.Window.moveBy}
10142
+ * - {@link OpenFin.Window.moveTo}
10143
+ * - {@link OpenFin.Window.setBounds}
10144
+ * - {@link OpenFin.Window.resizeBy}
10145
+ * - {@link OpenFin.Window.resizeTo}
10146
+ * @example ```js
10147
+ fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
10148
+ ```
10149
+ */
10150
+ declare interface PositioningOptions {
10151
+ /**
10152
+ * Windows Only.
10153
+ * If set to true, will not restore a maximized window before setting the bounds.
10154
+ * This will have the effect of the maximized window staying maximized and not immediately taking this new position.
10155
+ */
10156
+ skipRestore?: boolean;
10157
+ }
10158
+
9771
10159
  /**
9772
10160
  * Context menu item with an implementation provided by OpenFin.
9773
10161
  */
@@ -9810,6 +10198,7 @@ declare type PreloadScriptInfoRunning = {
9810
10198
  /**
9811
10199
  * Generated after the execution of all of a window's preload scripts.
9812
10200
  * @remarks Contains information about all window's preload scripts' final states.
10201
+ * @interface
9813
10202
  */
9814
10203
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
9815
10204
  type: 'preload-script-state-changed';
@@ -9817,6 +10206,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
9817
10206
 
9818
10207
  /**
9819
10208
  * A general preload scripts state change event without event type.
10209
+ * @interface
9820
10210
  */
9821
10211
  declare type PreloadScriptsStateChangeEvent = NamedEvent & {
9822
10212
  preloadScripts: (PreloadScriptInfoRunning & any)[];
@@ -9825,6 +10215,7 @@ declare type PreloadScriptsStateChangeEvent = NamedEvent & {
9825
10215
  /**
9826
10216
  * Generated during the execution of a window's preload script.
9827
10217
  * @remarks Contains information about a single window's preload script's state, for which the event has been raised.
10218
+ * @interface
9828
10219
  */
9829
10220
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
9830
10221
  type: 'preload-script-state-changing';
@@ -9961,10 +10352,25 @@ declare type ProcessDetails = {
9961
10352
  pid: number;
9962
10353
  };
9963
10354
 
10355
+ /**
10356
+ * Process logging options
10357
+ */
9964
10358
  declare interface ProcessLoggingOptions {
10359
+ /**
10360
+ * Periodic Logging Interval (in seconds)
10361
+ */
9965
10362
  interval?: number;
10363
+ /**
10364
+ * Outlier Detection options
10365
+ */
9966
10366
  outlierDetection?: {
10367
+ /**
10368
+ * Outlier Interval (in seconds)
10369
+ */
9967
10370
  interval?: number;
10371
+ /**
10372
+ * Number of Process Info entries to collect for outlier analysis
10373
+ */
9968
10374
  entries?: number;
9969
10375
  };
9970
10376
  }
@@ -10207,6 +10613,25 @@ declare interface ProtocolMap extends ProtocolMapBase {
10207
10613
  'set-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity & {
10208
10614
  domainSettings: OpenFin_2.DefaultDomainSettings;
10209
10615
  }, void>;
10616
+ 'move-window-by': IdentityCall<WithPositioningOptions<{
10617
+ deltaLeft: number;
10618
+ deltaTop: number;
10619
+ }>>;
10620
+ 'move-window': IdentityCall<WithPositioningOptions<{
10621
+ left: number;
10622
+ top: number;
10623
+ }>>;
10624
+ 'resize-window-by': IdentityCall<WithPositioningOptions<{
10625
+ deltaWidth: number;
10626
+ deltaHeight: number;
10627
+ anchor: OpenFin_2.AnchorType;
10628
+ }>>;
10629
+ 'resize-window': IdentityCall<WithPositioningOptions<{
10630
+ width: number;
10631
+ height: number;
10632
+ anchor: OpenFin_2.AnchorType;
10633
+ }>>;
10634
+ 'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
10210
10635
  }
10211
10636
 
10212
10637
  declare interface ProtocolMapBase {
@@ -10238,12 +10663,11 @@ declare type ProviderIdentity_5 = OpenFin_2.ProviderIdentity;
10238
10663
 
10239
10664
  declare type ProviderIdentity_6 = OpenFin_2.ProviderIdentity;
10240
10665
 
10241
- declare type ProviderIdentity_7 = OpenFin_2.ProviderIdentity;
10242
-
10243
10666
  /**
10244
10667
  * Identity of a channel provider.
10668
+ * @interface
10245
10669
  */
10246
- declare type ProviderIdentity_8 = Identity_5 & {
10670
+ declare type ProviderIdentity_7 = Identity_5 & {
10247
10671
  /**
10248
10672
  * Identifier of the channel.
10249
10673
  */
@@ -10310,6 +10734,9 @@ declare type QueryPermissionResult = {
10310
10734
  rawValue?: unknown;
10311
10735
  };
10312
10736
 
10737
+ /**
10738
+ * @interface
10739
+ */
10313
10740
  declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
10314
10741
 
10315
10742
  /**
@@ -10345,6 +10772,7 @@ declare type RectangleByEdgePositions = {
10345
10772
 
10346
10773
  /**
10347
10774
  * Generated when a hotkey has been registered with the operating system.
10775
+ * @interface
10348
10776
  */
10349
10777
  declare type RegisteredEvent = BaseEvent & {
10350
10778
  type: 'registered';
@@ -10367,6 +10795,7 @@ declare type RegistryInfo_2 = {
10367
10795
 
10368
10796
  /**
10369
10797
  * Generated when a window has been reloaded.
10798
+ * @interface
10370
10799
  */
10371
10800
  declare type ReloadedEvent = NamedEvent & {
10372
10801
  type: 'reloaded';
@@ -10452,6 +10881,7 @@ declare type ResizeRegion = {
10452
10881
 
10453
10882
  /**
10454
10883
  * Generated when an HTTP load was cancelled or failed.
10884
+ * @interface
10455
10885
  */
10456
10886
  declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
10457
10887
  type: 'resource-load-failed';
@@ -10459,6 +10889,7 @@ declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
10459
10889
 
10460
10890
  /**
10461
10891
  * Generated when an HTTP resource request has received response details.
10892
+ * @interface
10462
10893
  */
10463
10894
  declare type ResourceResponseReceivedEvent = NamedEvent & {
10464
10895
  type: 'resource-response-received';
@@ -10474,6 +10905,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
10474
10905
 
10475
10906
  /**
10476
10907
  * Generated when an application is responding.
10908
+ * @interface
10477
10909
  */
10478
10910
  declare type RespondingEvent = IdentityEvent & {
10479
10911
  type: 'responding';
@@ -10487,7 +10919,10 @@ declare type RGB = {
10487
10919
  green: number;
10488
10920
  };
10489
10921
 
10490
- declare type RoutingInfo = ProviderIdentity_3 & {
10922
+ /**
10923
+ * @interface
10924
+ */
10925
+ declare type RoutingInfo = OpenFin_2.ProviderIdentity & {
10491
10926
  endpointId: string;
10492
10927
  };
10493
10928
 
@@ -10513,7 +10948,7 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
10513
10948
  declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload> {
10514
10949
  #private;
10515
10950
  onEndpointDisconnect(endpointId: string, listener: () => void): void;
10516
- receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_6) => Promise<any>): void;
10951
+ receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
10517
10952
  send: (endpointId: string, action: string, payload: any) => Promise<any>;
10518
10953
  close: () => Promise<void>;
10519
10954
  private getEndpointById;
@@ -10525,7 +10960,7 @@ declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload>
10525
10960
  }
10526
10961
 
10527
10962
  declare interface RTCStrategyEndpointPayload {
10528
- endpointIdentity: OpenFin_2.ClientIdentity | ProviderIdentity_6;
10963
+ endpointIdentity: OpenFin_2.ClientIdentity | ProviderIdentity_5;
10529
10964
  rtc: RTCPacket;
10530
10965
  }
10531
10966
 
@@ -10533,6 +10968,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
10533
10968
 
10534
10969
  /**
10535
10970
  * Generated when Application.run() is called for an already running application.
10971
+ * @interface
10536
10972
  */
10537
10973
  declare type RunRequestedEvent_2 = IdentityEvent & {
10538
10974
  type: 'run-requested';
@@ -10684,6 +11120,7 @@ declare type ServiceIdentifier = {
10684
11120
 
10685
11121
  /**
10686
11122
  * Generated on changes to a user’s local computer session.
11123
+ * @interface
10687
11124
  */
10688
11125
  declare type SessionChangedEvent = {
10689
11126
  type: 'session-changed';
@@ -10734,12 +11171,16 @@ declare type ShortCutConfig = {
10734
11171
  systemStartup?: boolean;
10735
11172
  };
10736
11173
 
11174
+ /**
11175
+ * @interface
11176
+ */
10737
11177
  declare type ShortcutOverride = Hotkey & {
10738
11178
  command: string;
10739
11179
  };
10740
11180
 
10741
11181
  /**
10742
11182
  * Generated when a View is shown. This event will fire during creation of a View.
11183
+ * @interface
10743
11184
  */
10744
11185
  declare type ShownEvent = BaseViewEvent & {
10745
11186
  type: 'shown';
@@ -10753,6 +11194,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
10753
11194
 
10754
11195
  /**
10755
11196
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
11197
+ * @interface
10756
11198
  */
10757
11199
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
10758
11200
  /**
@@ -10769,6 +11211,9 @@ declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
10769
11211
  paintIntervalMs?: number;
10770
11212
  };
10771
11213
 
11214
+ /**
11215
+ * @interface
11216
+ */
10772
11217
  declare type Size = TransitionBase & {
10773
11218
  /**
10774
11219
  * Optional if height is present. Defaults to the window's current width.
@@ -10848,6 +11293,9 @@ declare class SnapshotSource<T = any> extends Base {
10848
11293
  applySnapshot(snapshot: T): Promise<void>;
10849
11294
  }
10850
11295
 
11296
+ /**
11297
+ * Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
11298
+ */
10851
11299
  declare class SnapshotSourceModule extends Base {
10852
11300
  /**
10853
11301
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
@@ -10926,6 +11374,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
10926
11374
 
10927
11375
  /**
10928
11376
  * Generated when an application has started.
11377
+ * @interface
10929
11378
  */
10930
11379
  declare type StartedEvent = IdentityEvent & {
10931
11380
  type: 'started';
@@ -12387,7 +12836,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
12387
12836
  }
12388
12837
 
12389
12838
  /**
12390
- * A system event.
12839
+ * [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
12840
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
12841
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
12842
+ * from which they propagate).
12391
12843
  */
12392
12844
  declare type SystemEvent = {
12393
12845
  topic: 'system';
@@ -12714,12 +13166,16 @@ declare type TargetApp = string | AppMetadata;
12714
13166
  * Generated when a View changes its window target.
12715
13167
  * @remarks This event will fire during creation of a View.
12716
13168
  * In that case, previousTarget identity will be the same as target identity.
13169
+ * @interface
12717
13170
  */
12718
13171
  declare type TargetChangedEvent = BaseViewEvent & {
12719
13172
  type: 'target-changed';
12720
13173
  previousTarget: OpenFin_2.Identity;
12721
13174
  };
12722
13175
 
13176
+ /**
13177
+ * @interface
13178
+ */
12723
13179
  declare type TaskBar = DipScaleRects & {
12724
13180
  /**
12725
13181
  * Which edge of a monitor the taskbar is on
@@ -12842,6 +13298,7 @@ declare class Transport<MeType extends EntityType_3 = EntityType_3> extends Even
12842
13298
 
12843
13299
  /**
12844
13300
  * Generated when the tray icon is clicked.
13301
+ * @interface
12845
13302
  */
12846
13303
  declare type TrayIconClickedEvent = IdentityEvent & {
12847
13304
  type: 'tray-icon-clicked';
@@ -12893,6 +13350,7 @@ declare interface TypedEventEmitter<Event extends {
12893
13350
 
12894
13351
  /**
12895
13352
  * Generated when a hotkey has been unregistered with the operating system.
13353
+ * @interface
12896
13354
  */
12897
13355
  declare type UnregisteredEvent = BaseEvent & {
12898
13356
  type: 'unregistered';
@@ -12909,6 +13367,7 @@ declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
12909
13367
  * Generated when navigation or redirect is completed.
12910
13368
  * @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.
12911
13369
  * 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).
13370
+ * @interface
12912
13371
  */
12913
13372
  declare type UrlChangedEvent = BaseUrlEvent & ({
12914
13373
  isInPage: true;
@@ -12920,6 +13379,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
12920
13379
 
12921
13380
  /**
12922
13381
  * A general user bounds change event without event type.
13382
+ * @interface
12923
13383
  */
12924
13384
  declare type UserBoundsChangeEvent = NamedEvent & {
12925
13385
  height: number;
@@ -12931,6 +13391,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
12931
13391
 
12932
13392
  /**
12933
13393
  * Generated when a window's user movement becomes disabled.
13394
+ * @interface
12934
13395
  */
12935
13396
  declare type UserMovementDisabledEvent = NamedEvent & {
12936
13397
  type: 'user-movement-disabled';
@@ -12938,6 +13399,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
12938
13399
 
12939
13400
  /**
12940
13401
  * Generated when a window's user movement becomes enabled.
13402
+ * @interface
12941
13403
  */
12942
13404
  declare type UserMovementEnabledEvent = NamedEvent & {
12943
13405
  type: 'user-movement-enabled';
@@ -13547,6 +14009,7 @@ declare interface ViewComponent extends GoldenLayout.ContentItem {
13547
14009
  *
13548
14010
  * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
13549
14011
  * (defaults to `"about:blank"` when omitted).
14012
+ * @interface
13550
14013
  */
13551
14014
  declare type ViewCreationOptions = Partial<ViewOptions> & {
13552
14015
  name: string;
@@ -13559,6 +14022,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
13559
14022
  /**
13560
14023
  * Generated when a window has a view detached from it.
13561
14024
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
14025
+ * @interface
13562
14026
  */
13563
14027
  declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
13564
14028
  type: 'view-detached';
@@ -13566,7 +14030,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
13566
14030
  };
13567
14031
 
13568
14032
  /**
13569
- * A View event.
14033
+ * [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
14034
+ * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
14035
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
13570
14036
  */
13571
14037
  declare type ViewEvent = {
13572
14038
  topic: 'view';
@@ -13582,7 +14048,7 @@ declare namespace ViewEvents {
13582
14048
  AttachedEvent,
13583
14049
  CreatedEvent,
13584
14050
  DestroyedEvent,
13585
- HiddenEvent_2 as HiddenEvent,
14051
+ HiddenEvent,
13586
14052
  HotkeyEvent,
13587
14053
  ShownEvent,
13588
14054
  WillPropagateViewEvent,
@@ -13607,6 +14073,9 @@ declare type ViewInfo = {
13607
14073
  favicons: string[];
13608
14074
  };
13609
14075
 
14076
+ /**
14077
+ * Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
14078
+ */
13610
14079
  declare class ViewModule extends Base {
13611
14080
  /**
13612
14081
  * Creates a new View.
@@ -13689,6 +14158,7 @@ declare class ViewModule extends Base {
13689
14158
 
13690
14159
  /**
13691
14160
  * User-facing options for a view.
14161
+ * @interface
13692
14162
  */
13693
14163
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
13694
14164
 
@@ -13726,6 +14196,9 @@ declare class ViewOverlay {
13726
14196
  setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
13727
14197
  }
13728
14198
 
14199
+ /**
14200
+ * Represents the payload shape for Views that are trying to prevent an unload.
14201
+ */
13729
14202
  declare interface ViewsPreventingUnloadPayload {
13730
14203
  /**
13731
14204
  * Specifies if the Window should close.
@@ -13749,6 +14222,9 @@ declare interface ViewsPreventingUnloadPayload {
13749
14222
  closeType: 'view' | 'window';
13750
14223
  }
13751
14224
 
14225
+ /**
14226
+ * @interface
14227
+ */
13752
14228
  declare type ViewState = ViewCreationOptions & {
13753
14229
  backgroundThrottling: boolean;
13754
14230
  componentName: 'view';
@@ -13756,6 +14232,9 @@ declare type ViewState = ViewCreationOptions & {
13756
14232
  minWidth?: number;
13757
14233
  };
13758
14234
 
14235
+ /**
14236
+ * The statuses of views specifying which of them are trying to prevent an unload and which are not.
14237
+ */
13759
14238
  declare interface ViewStatuses {
13760
14239
  /**
13761
14240
  * Identities of the Views that are preventing an unload.
@@ -14718,6 +15197,7 @@ declare type WebRequestHeader = {
14718
15197
  /**
14719
15198
  * Generated when a window is being moved by the user.
14720
15199
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
15200
+ * @interface
14721
15201
  */
14722
15202
  declare type WillMoveEvent = WillMoveOrResizeEvent & {
14723
15203
  type: 'will-move';
@@ -14725,6 +15205,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
14725
15205
 
14726
15206
  /**
14727
15207
  * A general will-move or will-resize event without event type.
15208
+ * @interface
14728
15209
  */
14729
15210
  declare type WillMoveOrResizeEvent = NamedEvent & {
14730
15211
  height: number;
@@ -14742,7 +15223,7 @@ declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedE
14742
15223
  /**
14743
15224
  * A View event that does propagate to (republish on) parent topics.
14744
15225
  */
14745
- declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent_2 | HotkeyEvent | ShownEvent | TargetChangedEvent;
15226
+ declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
14746
15227
 
14747
15228
  /**
14748
15229
  * A WebContents event that does propagate to (republish on) parent topics.
@@ -14752,10 +15233,11 @@ declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelection
14752
15233
  /**
14753
15234
  * A Window event that does propagate to (republish on) parent topics.
14754
15235
  */
14755
- 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;
15236
+ 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;
14756
15237
 
14757
15238
  /**
14758
15239
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
15240
+ * @interface
14759
15241
  */
14760
15242
  declare type WillRedirectEvent = NamedEvent & {
14761
15243
  type: 'will-redirect';
@@ -14768,6 +15250,7 @@ declare type WillRedirectEvent = NamedEvent & {
14768
15250
  * Generated when a window is being resized by the user.
14769
15251
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
14770
15252
  * 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.
15253
+ * @interface
14771
15254
  */
14772
15255
  declare type WillResizeEvent = WillMoveOrResizeEvent & {
14773
15256
  type: 'will-resize';
@@ -15923,7 +16406,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15923
16406
  * moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
15924
16407
  * ```
15925
16408
  */
15926
- moveBy(deltaLeft: number, deltaTop: number): Promise<void>;
16409
+ moveBy(deltaLeft: number, deltaTop: number, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15927
16410
  /**
15928
16411
  * Moves the window to a specified location.
15929
16412
  * @param left The left position of the window
@@ -15949,7 +16432,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15949
16432
  * moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
15950
16433
  * ```
15951
16434
  */
15952
- moveTo(left: number, top: number): Promise<void>;
16435
+ moveTo(left: number, top: number, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15953
16436
  /**
15954
16437
  * Resizes the window by a specified amount.
15955
16438
  * @param deltaWidth The change in the width of the window
@@ -15978,7 +16461,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15978
16461
  * resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
15979
16462
  * ```
15980
16463
  */
15981
- resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin_2.AnchorType): Promise<void>;
16464
+ resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin_2.AnchorType, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15982
16465
  /**
15983
16466
  * Resizes the window to the specified dimensions.
15984
16467
  * @param width The change in the width of the window
@@ -16007,7 +16490,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16007
16490
  * resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
16008
16491
  * ```
16009
16492
  */
16010
- resizeTo(width: number, height: number, anchor: OpenFin_2.AnchorType): Promise<void>;
16493
+ resizeTo(width: number, height: number, anchor: OpenFin_2.AnchorType, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
16011
16494
  /**
16012
16495
  * Restores the window to its normal state (i.e., unminimized, unmaximized).
16013
16496
  *
@@ -16058,7 +16541,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16058
16541
  setAsForeground(): Promise<void>;
16059
16542
  /**
16060
16543
  * Sets the window's size and position.
16061
- * @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
16062
16544
  *
16063
16545
  * @example
16064
16546
  * ```js
@@ -16085,7 +16567,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16085
16567
  * }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
16086
16568
  * ```
16087
16569
  */
16088
- setBounds(bounds: Partial<OpenFin_2.Bounds>): Promise<void>;
16570
+ setBounds(bounds: Partial<OpenFin_2.Bounds>, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
16089
16571
  /**
16090
16572
  * Shows the window if it is hidden.
16091
16573
  * @param force Show will be prevented from showing when force is false and
@@ -16294,6 +16776,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16294
16776
  */
16295
16777
  closePopupMenu(): Promise<void>;
16296
16778
  /**
16779
+ * @PORTED
16297
16780
  * @typedef {object} PopupOptions@typedef {object} PopupOptions
16298
16781
  * @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.
16299
16782
  * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -16311,6 +16794,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16311
16794
  * @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.
16312
16795
  */
16313
16796
  /**
16797
+ * @PORTED
16314
16798
  * @typedef {object} PopupResult@typedef {object} PopupResult
16315
16799
  * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
16316
16800
  * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -16376,6 +16860,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16376
16860
 
16377
16861
  /**
16378
16862
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
16863
+ * @interface
16379
16864
  */
16380
16865
  declare type WindowAlertRequestedEvent = NamedEvent & {
16381
16866
  type: 'window-alert-requested';
@@ -16383,6 +16868,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16383
16868
 
16384
16869
  /**
16385
16870
  * Returned from getBounds call. bottom and right are never used for setting.
16871
+ * @interface
16386
16872
  */
16387
16873
  declare type WindowBounds = Bounds & {
16388
16874
  bottom: number;
@@ -16391,6 +16877,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16391
16877
 
16392
16878
  /**
16393
16879
  * Generated when a window has closed.
16880
+ * @interface
16394
16881
  */
16395
16882
  declare type WindowClosedEvent = NamedEvent & {
16396
16883
  type: 'closed';
@@ -16399,6 +16886,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16399
16886
  /**
16400
16887
  * Generated when a window has been prevented from closing.
16401
16888
  * @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.
16889
+ * @interface
16402
16890
  */
16403
16891
  declare type WindowCloseRequestedEvent = NamedEvent & {
16404
16892
  type: 'close-requested';
@@ -16406,6 +16894,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16406
16894
 
16407
16895
  /**
16408
16896
  * Generated when a window has initiated the closing routine.
16897
+ * @interface
16409
16898
  */
16410
16899
  declare type WindowClosingEvent = NamedEvent & {
16411
16900
  type: 'closing';
@@ -16413,6 +16902,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16413
16902
 
16414
16903
  /**
16415
16904
  * Generated when a child window is created.
16905
+ * @interface
16416
16906
  */
16417
16907
  declare type WindowCreatedEvent = NamedEvent & {
16418
16908
  type: 'window-created';
@@ -16423,6 +16913,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16423
16913
  *
16424
16914
  * Note that `name` is the only required property — albeit the `url` property is usually provided as well
16425
16915
  * (defaults to `"about:blank"` when omitted).
16916
+ * @interface
16426
16917
  */
16427
16918
  declare type WindowCreationOptions = Partial<WindowOptions> & {
16428
16919
  name: string;
@@ -16449,7 +16940,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16449
16940
  */
16450
16941
  name: string;
16451
16942
  /**
16452
- * The right-most coordinate of the window
16943
+ * The right-most coordinate of the window.
16453
16944
  */
16454
16945
  right: number;
16455
16946
  state: string;
@@ -16465,13 +16956,16 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16465
16956
 
16466
16957
  /**
16467
16958
  * Generated when a child window ends loading.
16959
+ * @interface
16468
16960
  */
16469
16961
  declare type WindowEndLoadEvent = NamedEvent & {
16470
16962
  type: 'window-end-load';
16471
16963
  };
16472
16964
 
16473
16965
  /**
16474
- * A Window event.
16966
+ * [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
16967
+ * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
16968
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
16475
16969
  */
16476
16970
  declare type WindowEvent = {
16477
16971
  topic: 'window';
@@ -16489,7 +16983,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16489
16983
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
16490
16984
  ExternalProcessExitedEvent,
16491
16985
  ExternalProcessStartedEvent,
16492
- HiddenEvent,
16986
+ WindowHiddenEvent,
16493
16987
  PreloadScriptInfoRunning,
16494
16988
  PreloadScriptInfo,
16495
16989
  PreloadScriptsStateChangeEvent,
@@ -16539,9 +17033,19 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16539
17033
  */
16540
17034
  declare type WindowEventType = WindowEvent['type'];
16541
17035
 
17036
+ /**
17037
+ * Generated when a window has been hidden.
17038
+ * @interface
17039
+ */
17040
+ declare type WindowHiddenEvent = NamedEvent & {
17041
+ type: 'hidden';
17042
+ reason: 'closing' | 'hide' | 'hide-on-close';
17043
+ };
17044
+
16542
17045
  /**
16543
17046
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
16544
17047
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
17048
+ * @interface
16545
17049
  */
16546
17050
  declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
16547
17051
  type: 'hotkey';
@@ -16557,11 +17061,15 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16557
17061
 
16558
17062
  /**
16559
17063
  * Generated when a window is initialized.
17064
+ * @interface
16560
17065
  */
16561
17066
  declare type WindowInitializedEvent = NamedEvent & {
16562
17067
  type: 'initialized';
16563
17068
  };
16564
17069
 
17070
+ /**
17071
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
17072
+ */
16565
17073
  declare class _WindowModule extends Base {
16566
17074
  /**
16567
17075
  * Asynchronously returns a Window object that represents an existing window.
@@ -16652,6 +17160,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16652
17160
 
16653
17161
  /**
16654
17162
  * Generated when a child window is not responding.
17163
+ * @interface
16655
17164
  */
16656
17165
  declare type WindowNotRespondingEvent = NamedEvent & {
16657
17166
  type: 'window-not-responding';
@@ -16664,6 +17173,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16664
17173
  };
16665
17174
  };
16666
17175
 
17176
+ /**
17177
+ * @interface
17178
+ */
16667
17179
  declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
16668
17180
 
16669
17181
  declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
@@ -16671,6 +17183,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16671
17183
  /**
16672
17184
  * Generated after window options are changed using the window.updateOptions method.
16673
17185
  * @remarks Will not fire if the diff object is empty.
17186
+ * @interface
16674
17187
  */
16675
17188
  declare type WindowOptionsChangedEvent_2 = NamedEvent & {
16676
17189
  type: 'options-changed';
@@ -16682,6 +17195,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16682
17195
 
16683
17196
  /**
16684
17197
  * Generated when a child window is responding.
17198
+ * @interface
16685
17199
  */
16686
17200
  declare type WindowRespondingEvent = NamedEvent & {
16687
17201
  type: 'window-responding';
@@ -16689,6 +17203,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16689
17203
 
16690
17204
  /**
16691
17205
  * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
17206
+ * @interface
16692
17207
  */
16693
17208
  declare type WindowRestoredEvent = NamedEvent & {
16694
17209
  type: 'restored';
@@ -16696,6 +17211,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16696
17211
 
16697
17212
  /**
16698
17213
  * Generated when a hidden window has been shown.
17214
+ * @interface
16699
17215
  */
16700
17216
  declare type WindowShownEvent = NamedEvent & {
16701
17217
  type: 'shown';
@@ -16704,6 +17220,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16704
17220
  /**
16705
17221
  * Generated when a window has been prevented from showing.
16706
17222
  * @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.
17223
+ * @interface
16707
17224
  */
16708
17225
  declare type WindowShowRequestedEvent = NamedEvent & {
16709
17226
  type: 'show-requested';
@@ -16711,6 +17228,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16711
17228
 
16712
17229
  /**
16713
17230
  * Generated when a child window starts loading.
17231
+ * @interface
16714
17232
  */
16715
17233
  declare type WindowStartLoadEvent = NamedEvent & {
16716
17234
  type: 'window-start-load';
@@ -16752,6 +17270,10 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16752
17270
  */
16753
17271
  declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
16754
17272
 
17273
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
17274
+ positioningOptions?: OpenFin_2.PositioningOptions;
17275
+ };
17276
+
16755
17277
  declare type WorkspacePlatformOptions = {
16756
17278
  /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
16757
17279
  [key: string]: any;
@@ -16759,6 +17281,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16759
17281
 
16760
17282
  /**
16761
17283
  * A generic request to write any supported data to the clipboard.
17284
+ * @interface
16762
17285
  */
16763
17286
  declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
16764
17287
  data: {
@@ -16777,6 +17300,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16777
17300
 
16778
17301
  /**
16779
17302
  * A request to write data to the clipboard.
17303
+ * @interface
16780
17304
  */
16781
17305
  declare type WriteClipboardRequest = BaseClipboardRequest & {
16782
17306
  /**
@@ -16785,6 +17309,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16785
17309
  data: string;
16786
17310
  };
16787
17311
 
17312
+ /**
17313
+ * @interface
17314
+ */
16788
17315
  declare type WriteImageClipboardRequest = BaseClipboardRequest & {
16789
17316
  /**
16790
17317
  * Can be either a base64 string, or a DataURL string. If using DataURL, the