@openfin/node-adapter 34.78.7 → 34.78.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -52,6 +52,7 @@ declare type AddViewToStackOptions = {
52
52
 
53
53
  /**
54
54
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
55
+ * @interface
55
56
  */
56
57
  declare type AlertRequestedEvent = NamedEvent & {
57
58
  type: 'alert-requested';
@@ -810,6 +811,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
810
811
 
811
812
  /**
812
813
  * Generated when an application has authenticated and is connected.
814
+ * @interface
813
815
  */
814
816
  declare type ApplicationConnectedEvent = IdentityEvent & {
815
817
  type: 'connected';
@@ -817,6 +819,7 @@ declare type ApplicationConnectedEvent = IdentityEvent & {
817
819
 
818
820
  /**
819
821
  * Generated when an application is created.
822
+ * @interface
820
823
  */
821
824
  declare type ApplicationCreatedEvent = IdentityEvent & {
822
825
  type: 'application-created';
@@ -831,11 +834,10 @@ declare type ApplicationCreatedEvent = IdentityEvent & {
831
834
  * * `url` is optional in both the app manifest {@link Application.ApplicationModule.start Application.start} and but is usually given
832
835
  * (defaults to `"about:blank"` when omitted).
833
836
  *
834
- * _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
835
- *
836
837
  * **IMPORTANT NOTE:**
837
838
  * This object inherits all the properties of the window creation {@link OpenFin.WindowCreationOptions options} object,
838
839
  * which will take priority over those of the same name that may be provided in `mainWindowOptions`.
840
+ * @interface
839
841
  */
840
842
  declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
841
843
  name: string;
@@ -903,6 +905,9 @@ declare type ApplicationInfo = {
903
905
  };
904
906
  };
905
907
 
908
+ /**
909
+ * Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
910
+ */
906
911
  declare class ApplicationModule extends Base {
907
912
  /**
908
913
  * Asynchronously returns an Application object that represents an existing application.
@@ -1083,6 +1088,7 @@ declare class ApplicationModule extends Base {
1083
1088
 
1084
1089
  /**
1085
1090
  * The complete set of options for an application.
1091
+ * @interface
1086
1092
  */
1087
1093
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1088
1094
  /**
@@ -1276,6 +1282,10 @@ declare type AppProcessInfo = {
1276
1282
  entities: EntityProcessDetails[];
1277
1283
  };
1278
1284
 
1285
+ /**
1286
+ * Generated when system app versioning is successfully completed.
1287
+ * @interface
1288
+ */
1279
1289
  declare type AppVersionCompleteEvent = {
1280
1290
  type: 'app-version-complete';
1281
1291
  } & AppVersionProgress;
@@ -1285,6 +1295,10 @@ declare type AppVersionError = {
1285
1295
  srcManifest: string;
1286
1296
  };
1287
1297
 
1298
+ /**
1299
+ * Generated when none of fallback manifests is compatible to the system.
1300
+ * @interface
1301
+ */
1288
1302
  declare type AppVersionErrorEvent = {
1289
1303
  type: 'app-version-error';
1290
1304
  } & AppVersionError;
@@ -1306,6 +1320,10 @@ declare type AppVersionProgress = {
1306
1320
  srcManifest: string;
1307
1321
  };
1308
1322
 
1323
+ /**
1324
+ * Generated during the progress of system app versioning.
1325
+ * @interface
1326
+ */
1309
1327
  declare type AppVersionProgressEvent = {
1310
1328
  type: 'app-version-progress';
1311
1329
  } & AppVersionProgress;
@@ -1319,6 +1337,10 @@ declare type AppVersionRuntimeInfo = {
1319
1337
  error: string | null;
1320
1338
  };
1321
1339
 
1340
+ /**
1341
+ * Generated when checking a runtime availability.
1342
+ * @interface
1343
+ */
1322
1344
  declare type AppVersionRuntimeStatusEvent = {
1323
1345
  type: 'runtime-status';
1324
1346
  } & AppVersionRuntimeInfo;
@@ -1327,6 +1349,7 @@ declare type AppVersionRuntimeStatusEvent = {
1327
1349
 
1328
1350
  /**
1329
1351
  * Generated when a View is attached to a window.
1352
+ * @interface
1330
1353
  */
1331
1354
  declare type AttachedEvent = BaseViewEvent & {
1332
1355
  type: 'attached';
@@ -1399,6 +1422,7 @@ declare interface AuthorizationPayload {
1399
1422
  * }
1400
1423
  * });
1401
1424
  * ```
1425
+ * @interface
1402
1426
  */
1403
1427
  declare type AuthRequestedEvent = NamedEvent & {
1404
1428
  type: 'auth-requested';
@@ -1453,6 +1477,7 @@ declare class Base {
1453
1477
 
1454
1478
  /**
1455
1479
  * A base Channel event.
1480
+ * @interface
1456
1481
  */
1457
1482
  declare type BaseChannelEvent = NamedEvent & {
1458
1483
  channelName: string;
@@ -1519,6 +1544,7 @@ declare namespace BaseEvents {
1519
1544
 
1520
1545
  /**
1521
1546
  * The base frame event.
1547
+ * @interface
1522
1548
  */
1523
1549
  declare type BaseFrameEvent = NamedEvent & {
1524
1550
  entityType: 'iframe';
@@ -1539,6 +1565,7 @@ declare type BaseUrlEvent = NamedEvent & {
1539
1565
 
1540
1566
  /**
1541
1567
  * A base View event.
1568
+ * @interface
1542
1569
  */
1543
1570
  declare type BaseViewEvent = NamedEvent & {
1544
1571
  target: OpenFin.Identity;
@@ -1558,6 +1585,7 @@ declare interface BeforeUnloadUserDecision {
1558
1585
 
1559
1586
  /**
1560
1587
  * Generated at the beginning of a user-driven change to a window's size or position.
1588
+ * @interface
1561
1589
  */
1562
1590
  declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1563
1591
  type: 'begin-user-bounds-changing';
@@ -1565,6 +1593,7 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1565
1593
 
1566
1594
  /**
1567
1595
  * Generated when a WebContents loses focus.
1596
+ * @interface
1568
1597
  */
1569
1598
  declare type BlurredEvent = NamedEvent & {
1570
1599
  type: 'blurred';
@@ -1579,6 +1608,7 @@ declare type Bounds = {
1579
1608
 
1580
1609
  /**
1581
1610
  * Generated after changes in a window's size and/or position.
1611
+ * @interface
1582
1612
  */
1583
1613
  declare type BoundsChangedEvent = BoundsChangeEvent & {
1584
1614
  type: 'bounds-changed';
@@ -1586,6 +1616,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1586
1616
 
1587
1617
  /**
1588
1618
  * A general bounds change event without event type.
1619
+ * @interface
1589
1620
  */
1590
1621
  declare type BoundsChangeEvent = NamedEvent & {
1591
1622
  changeType: 0 | 1 | 2;
@@ -1598,6 +1629,7 @@ declare type BoundsChangeEvent = NamedEvent & {
1598
1629
 
1599
1630
  /**
1600
1631
  * Generated during changes to a window's size and/or position.
1632
+ * @interface
1601
1633
  */
1602
1634
  declare type BoundsChangingEvent = BoundsChangeEvent & {
1603
1635
  type: 'bounds-changing';
@@ -1640,6 +1672,7 @@ declare type Certificate = {
1640
1672
 
1641
1673
  /**
1642
1674
  * Generated when navigating to a URL that fails certificate validation.
1675
+ * @interface
1643
1676
  */
1644
1677
  declare type CertificateErrorEvent = NamedEvent & {
1645
1678
  type: 'certificate-error';
@@ -1659,6 +1692,7 @@ declare type CertificatePrincipal = {
1659
1692
 
1660
1693
  /**
1661
1694
  * Generated when the certificate selection dialog is shown.
1695
+ * @interface
1662
1696
  */
1663
1697
  declare type CertificateSelectionShownEvent = NamedEvent & {
1664
1698
  type: 'certificate-selection-shown';
@@ -1856,7 +1890,7 @@ declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
1856
1890
 
1857
1891
  declare type ChannelAction = OpenFin.ChannelAction;
1858
1892
 
1859
- declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_8 | ClientIdentity_2) => unknown;
1893
+ declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
1860
1894
 
1861
1895
  declare class ChannelBase {
1862
1896
  protected subscriptions: Map<string, ChannelAction>;
@@ -2135,17 +2169,17 @@ declare class ChannelBase {
2135
2169
  * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
2136
2170
  * from the provider by registering an action via {@link ChannelClient#register register}.
2137
2171
  *
2138
- * Synchronous Methods:
2172
+ * ### Synchronous Methods:
2139
2173
  * * {@link ChannelClient#onDisconnection onDisconnection(listener)}
2140
2174
  * * {@link ChannelClient#register register(action, listener)}
2141
2175
  * * {@link ChannelClient#remove remove(action)}
2142
2176
  *
2143
- * Asynchronous Methods:
2177
+ * ### Asynchronous Methods:
2144
2178
  * * {@link ChannelClient#disconnect disconnect()}
2145
2179
  * * {@link ChannelClient#dispatch dispatch(action, payload)}
2146
2180
  *
2147
- * Middleware:
2148
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
2181
+ * ### Middleware:
2182
+ * Middleware functions receive the following arguments: (action, payload, senderId).
2149
2183
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
2150
2184
  * unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
2151
2185
  * * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
@@ -2160,11 +2194,11 @@ declare class ChannelClient extends ChannelBase {
2160
2194
  /* Excluded from this release type: closeChannelByEndpointId */
2161
2195
  /* Excluded from this release type: handleProviderDisconnect */
2162
2196
  /* Excluded from this release type: __constructor */
2163
- protected processAction: (action: string, payload: any, senderIdentity: ProviderIdentity_3 | OpenFin.ClientIdentity) => Promise<any>;
2197
+ protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
2164
2198
  /**
2165
2199
  * a read-only provider identity
2166
2200
  */
2167
- get providerIdentity(): ProviderIdentity_3;
2201
+ get providerIdentity(): OpenFin.ProviderIdentity;
2168
2202
  /**
2169
2203
  * Dispatch the given action to the channel provider. Returns a promise that resolves with the response from
2170
2204
  * the provider for that action.
@@ -2231,6 +2265,7 @@ declare type ChannelClient_2 = OpenFin.ChannelClient;
2231
2265
 
2232
2266
  /**
2233
2267
  * Generated when a Channel client is connected.
2268
+ * @interface
2234
2269
  */
2235
2270
  declare type ChannelConnectedEvent = BaseChannelEvent & {
2236
2271
  type: 'connected';
@@ -2239,6 +2274,7 @@ declare type ChannelConnectedEvent = BaseChannelEvent & {
2239
2274
  /**
2240
2275
  * Options provided on a client connection to a channel.
2241
2276
  *
2277
+ * @interface
2242
2278
  */
2243
2279
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2244
2280
  /**
@@ -2265,6 +2301,7 @@ declare type ChannelCreateOptions = {
2265
2301
 
2266
2302
  /**
2267
2303
  * Generated when a Channel client has disconnected.
2304
+ * @interface
2268
2305
  */
2269
2306
  declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2270
2307
  type: 'disconnected';
@@ -2296,27 +2333,27 @@ declare type ChannelEventType = ChannelEvent['type'];
2296
2333
 
2297
2334
  declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
2298
2335
 
2299
- declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_8 | ClientIdentity_2) => Promise<unknown> | unknown;
2336
+ declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity_2) => Promise<unknown> | unknown;
2300
2337
 
2301
2338
  /**
2302
2339
  * Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
2303
2340
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
2304
2341
  * and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
2305
2342
  *
2306
- * Synchronous Methods:
2343
+ * ### Synchronous Methods:
2307
2344
  * * {@link ChannelProvider#onConnection onConnection(listener)}
2308
2345
  * * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
2309
2346
  * * {@link ChannelProvider#publish publish(action, payload)}
2310
2347
  * * {@link ChannelProvider#register register(action, listener)}
2311
2348
  * * {@link ChannelProvider#remove remove(action)}
2312
2349
  *
2313
- * Asynchronous Methods:
2350
+ * ### Asynchronous Methods:
2314
2351
  * * {@link ChannelProvider#destroy destroy()}
2315
2352
  * * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
2316
2353
  * * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
2317
2354
  *
2318
- * Middleware:
2319
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
2355
+ * ### Middleware:
2356
+ * Middleware functions receive the following arguments: (action, payload, senderId).
2320
2357
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
2321
2358
  * unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
2322
2359
  * * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
@@ -2506,6 +2543,7 @@ declare interface ChannelStrategy<T extends unknown> {
2506
2543
 
2507
2544
  /**
2508
2545
  * Generated when a child content is blocked to load.
2546
+ * @interface
2509
2547
  */
2510
2548
  declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
2511
2549
  type: 'child-content-blocked';
@@ -2513,6 +2551,7 @@ declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
2513
2551
 
2514
2552
  /**
2515
2553
  * Generated when a child content is loaded into a browser.
2554
+ * @interface
2516
2555
  */
2517
2556
  declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
2518
2557
  type: 'child-content-opened-in-browser';
@@ -2525,6 +2564,7 @@ declare interface ChildContentOptions {
2525
2564
 
2526
2565
  /**
2527
2566
  * Generated when a child View is created.
2567
+ * @interface
2528
2568
  */
2529
2569
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
2530
2570
  type: 'child-view-created';
@@ -2536,6 +2576,7 @@ declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
2536
2576
 
2537
2577
  /**
2538
2578
  * Generated when a child Window is created.
2579
+ * @interface
2539
2580
  */
2540
2581
  declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
2541
2582
  type: 'child-window-created';
@@ -2560,9 +2601,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
2560
2601
  private endpointId;
2561
2602
  private providerIdentity;
2562
2603
  constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
2563
- providerIdentity: ProviderIdentity_5);
2604
+ providerIdentity: ProviderIdentity_4);
2564
2605
  onEndpointDisconnect(endpointId: string, listener: () => void): void;
2565
- receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
2606
+ receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
2566
2607
  send: (endpointId: string, action: string, payload: any) => Promise<any>;
2567
2608
  close: () => Promise<void>;
2568
2609
  closeEndpoint(endpointId: string): Promise<void>;
@@ -2595,12 +2636,16 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
2595
2636
  data: T;
2596
2637
  };
2597
2638
 
2639
+ /**
2640
+ * @interface
2641
+ */
2598
2642
  declare type ClientConnectionPayload = ClientIdentity_2 & ClientInfo;
2599
2643
 
2600
2644
  declare type ClientIdentity = OpenFin.ClientIdentity;
2601
2645
 
2602
2646
  /**
2603
2647
  * Identity of a channel client
2648
+ * @interface
2604
2649
  */
2605
2650
  declare type ClientIdentity_2 = Identity_5 & {
2606
2651
  /**
@@ -2610,12 +2655,16 @@ declare type ClientIdentity_2 = Identity_5 & {
2610
2655
  isLocalEndpointId: boolean;
2611
2656
  };
2612
2657
 
2658
+ /**
2659
+ * @interface
2660
+ */
2613
2661
  declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
2614
2662
  runtimeUuid: string;
2615
2663
  };
2616
2664
 
2617
2665
  /**
2618
2666
  * Extended channel client information
2667
+ * @interface
2619
2668
  */
2620
2669
  declare type ClientInfo = Omit<ClientIdentity_2, 'isLocalEndpointId'> & {
2621
2670
  /**
@@ -2807,6 +2856,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
2807
2856
 
2808
2857
  /**
2809
2858
  * Generated when an application is closed.
2859
+ * @interface
2810
2860
  */
2811
2861
  declare type ClosedEvent = IdentityEvent & {
2812
2862
  type: 'closed';
@@ -3209,6 +3259,9 @@ declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
3209
3259
  data?: unknown;
3210
3260
  };
3211
3261
 
3262
+ /**
3263
+ * @interface
3264
+ */
3212
3265
  declare type ContentCreationRulesEvent = NamedEvent & {
3213
3266
  /**
3214
3267
  * The absolute url which triggered this event.
@@ -3267,6 +3320,9 @@ declare type Context = {
3267
3320
  type: string;
3268
3321
  };
3269
3322
 
3323
+ /**
3324
+ * @interface
3325
+ */
3270
3326
  declare type ContextForIntent<MetadataType = any> = Context & {
3271
3327
  metadata?: MetadataType;
3272
3328
  };
@@ -3369,6 +3425,7 @@ declare type CpuInfo = {
3369
3425
 
3370
3426
  /**
3371
3427
  * Generated when an application has crashed.
3428
+ * @interface
3372
3429
  */
3373
3430
  declare type CrashedEvent = NamedEvent & {
3374
3431
  type: 'crashed';
@@ -3388,6 +3445,9 @@ declare type CrashReporterOptions = {
3388
3445
  diagnosticsMode: boolean;
3389
3446
  };
3390
3447
 
3448
+ /**
3449
+ * @interface
3450
+ */
3391
3451
  declare type CrashReporterState = CrashReporterOptions & {
3392
3452
  /**
3393
3453
  * Whether the crash reporter is running
@@ -3398,6 +3458,7 @@ declare type CrashReporterState = CrashReporterOptions & {
3398
3458
 
3399
3459
  /**
3400
3460
  * Generated when a View is created.
3461
+ * @interface
3401
3462
  */
3402
3463
  declare type CreatedEvent = BaseViewEvent & {
3403
3464
  type: 'created';
@@ -3415,6 +3476,9 @@ declare type CreateViewPayload = {
3415
3476
  targetView?: Identity_5;
3416
3477
  };
3417
3478
 
3479
+ /**
3480
+ * @interface
3481
+ */
3418
3482
  declare type CreateViewTarget = Identity_5 & {
3419
3483
  /**
3420
3484
  * If specified, view creation will not attach to a window and caller must
@@ -3454,6 +3518,7 @@ declare type DefaultDomainSettingsRule = {
3454
3518
 
3455
3519
  /**
3456
3520
  * Generated when the desktop icon is clicked while it's already running.
3521
+ * @interface
3457
3522
  */
3458
3523
  declare type DesktopIconClickedEvent = BaseEvent & {
3459
3524
  type: 'desktop-icon-clicked';
@@ -3461,6 +3526,7 @@ declare type DesktopIconClickedEvent = BaseEvent & {
3461
3526
 
3462
3527
  /**
3463
3528
  * Generated when a View is destroyed.
3529
+ * @interface
3464
3530
  */
3465
3531
  declare type DestroyedEvent = BaseViewEvent & {
3466
3532
  type: 'destroyed';
@@ -3468,6 +3534,7 @@ declare type DestroyedEvent = BaseViewEvent & {
3468
3534
 
3469
3535
  /**
3470
3536
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
3537
+ * @interface
3471
3538
  */
3472
3539
  declare type DidChangeThemeColorEvent = NamedEvent & {
3473
3540
  type: 'did-change-theme-color';
@@ -3475,6 +3542,7 @@ declare type DidChangeThemeColorEvent = NamedEvent & {
3475
3542
 
3476
3543
  /**
3477
3544
  * Generated when load failed.
3545
+ * @interface
3478
3546
  */
3479
3547
  declare type DidFailLoadEvent = BaseLoadFailedEvent & {
3480
3548
  type: 'did-fail-load';
@@ -3482,11 +3550,15 @@ declare type DidFailLoadEvent = BaseLoadFailedEvent & {
3482
3550
 
3483
3551
  /**
3484
3552
  * Generated when the navigation is done, i.e. the spinner of the tab will stop spinning, and the onload event is dispatched.
3553
+ * @interface
3485
3554
  */
3486
3555
  declare type DidFinishLoadEvent = NamedEvent & {
3487
3556
  type: 'did-finish-load';
3488
3557
  };
3489
3558
 
3559
+ /**
3560
+ * @interface
3561
+ */
3490
3562
  declare type DipRect = RectangleByEdgePositions & {
3491
3563
  dipRect: RectangleByEdgePositions;
3492
3564
  scaledRect: RectangleByEdgePositions;
@@ -3499,6 +3571,7 @@ declare type DipScaleRects = {
3499
3571
 
3500
3572
  /**
3501
3573
  * Generated after a change to a window's size and/or position is attempted while window movement is disabled.
3574
+ * @interface
3502
3575
  */
3503
3576
  declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
3504
3577
  type: 'disabled-movement-bounds-changed';
@@ -3506,12 +3579,13 @@ declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
3506
3579
 
3507
3580
  /**
3508
3581
  * Generated while a change to a window's size and/or position is attempted while window movement is disabled.
3582
+ * @interface
3509
3583
  */
3510
3584
  declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
3511
3585
  type: 'disabled-movement-bounds-changing';
3512
3586
  };
3513
3587
 
3514
- declare type DisconnectionListener = (providerIdentity: ProviderIdentity_3) => any;
3588
+ declare type DisconnectionListener = (providerIdentity: OpenFin.ProviderIdentity) => any;
3515
3589
 
3516
3590
  declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
3517
3591
 
@@ -3582,6 +3656,7 @@ declare type Dpi = {
3582
3656
 
3583
3657
  /**
3584
3658
  * Generated when a window has been embedded.
3659
+ * @interface
3585
3660
  */
3586
3661
  declare type EmbeddedEvent = NamedEvent & {
3587
3662
  type: 'embedded';
@@ -3692,6 +3767,7 @@ declare class EmitterMap {
3692
3767
 
3693
3768
  /**
3694
3769
  * Generated when a window ends loading.
3770
+ * @interface
3695
3771
  */
3696
3772
  declare type EndLoadEvent = NamedEvent & {
3697
3773
  type: 'end-load';
@@ -3699,7 +3775,7 @@ declare type EndLoadEvent = NamedEvent & {
3699
3775
  isMain: boolean;
3700
3776
  };
3701
3777
 
3702
- declare type EndpointIdentity = OpenFin.ClientIdentity | ProviderIdentity_4;
3778
+ declare type EndpointIdentity = OpenFin.ClientIdentity | ProviderIdentity_3;
3703
3779
 
3704
3780
  declare type EndpointPayload = {
3705
3781
  endpointIdentity: EndpointIdentity;
@@ -3707,6 +3783,7 @@ declare type EndpointPayload = {
3707
3783
 
3708
3784
  /**
3709
3785
  * Generated at the end of a user-driven change to a window's size or position.
3786
+ * @interface
3710
3787
  */
3711
3788
  declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
3712
3789
  type: 'end-user-bounds-changing';
@@ -3722,6 +3799,9 @@ declare type EntityInfo_2 = {
3722
3799
  entityType: EntityType_2;
3723
3800
  };
3724
3801
 
3802
+ /**
3803
+ * @interface
3804
+ */
3725
3805
  declare type EntityProcessDetails = FrameProcessDetails & {
3726
3806
  name: string;
3727
3807
  uuid: string;
@@ -3791,7 +3871,7 @@ declare interface Environment {
3791
3871
 
3792
3872
  declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
3793
3873
 
3794
- declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_8 | ClientIdentity_2) => unknown;
3874
+ declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
3795
3875
 
3796
3876
  /**
3797
3877
  * This function converts JS errors into plain objects
@@ -3833,7 +3913,7 @@ declare type ExitCode = {
3833
3913
  /**
3834
3914
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
3835
3915
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
3836
- * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
3916
+ * Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
3837
3917
  *
3838
3918
  * Processes that can be wrapped as `ExternalApplication`s include the following:
3839
3919
  * - Processes which have connected to an OpenFin runtime via an adapter
@@ -3937,6 +4017,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
3937
4017
 
3938
4018
  /**
3939
4019
  * Generated when an external application has authenticated and is connected.
4020
+ * @interface
3940
4021
  */
3941
4022
  declare type ExternalApplicationConnectedEvent = BaseEvent & {
3942
4023
  type: 'connected';
@@ -3944,6 +4025,7 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
3944
4025
 
3945
4026
  /**
3946
4027
  * Generated when an external application has disconnected.
4028
+ * @interface
3947
4029
  */
3948
4030
  declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
3949
4031
  type: 'disconnected';
@@ -3970,6 +4052,9 @@ declare type ExternalApplicationInfo = {
3970
4052
  parent: Identity_5;
3971
4053
  };
3972
4054
 
4055
+ /**
4056
+ * Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
4057
+ */
3973
4058
  declare class ExternalApplicationModule extends Base {
3974
4059
  /**
3975
4060
  * Asynchronously returns an External Application object that represents an external application.
@@ -4018,6 +4103,7 @@ declare type ExternalConnection = {
4018
4103
 
4019
4104
  /**
4020
4105
  * Generated when an external process has exited.
4106
+ * @interface
4021
4107
  */
4022
4108
  declare type ExternalProcessExitedEvent = NamedEvent & {
4023
4109
  type: 'external-process-exited';
@@ -4056,6 +4142,7 @@ declare type ExternalProcessRequestType = {
4056
4142
 
4057
4143
  /**
4058
4144
  * Generated when an external process has started.
4145
+ * @interface
4059
4146
  */
4060
4147
  declare type ExternalProcessStartedEvent = NamedEvent & {
4061
4148
  type: 'external-process-started';
@@ -4064,6 +4151,7 @@ declare type ExternalProcessStartedEvent = NamedEvent & {
4064
4151
 
4065
4152
  /**
4066
4153
  * Generated when page receives favicon urls.
4154
+ * @interface
4067
4155
  */
4068
4156
  declare type FaviconUpdatedEvent = NamedEvent & {
4069
4157
  type: 'page-favicon-updated';
@@ -4081,6 +4169,7 @@ declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
4081
4169
 
4082
4170
  /**
4083
4171
  * Generated when a file download has completed.
4172
+ * @interface
4084
4173
  */
4085
4174
  declare type FileDownloadCompletedEvent = FileDownloadEvent & {
4086
4175
  type: 'file-download-completed';
@@ -4089,6 +4178,7 @@ declare type FileDownloadCompletedEvent = FileDownloadEvent & {
4089
4178
 
4090
4179
  /**
4091
4180
  * A general file download event without event type.
4181
+ * @interface
4092
4182
  */
4093
4183
  declare type FileDownloadEvent = {
4094
4184
  /**
@@ -4140,6 +4230,8 @@ declare type FileDownloadEvent = {
4140
4230
  /**
4141
4231
  * Generated when setFileDownloadLocation api is called.
4142
4232
  * @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'.
4233
+ *
4234
+ * @interface
4143
4235
  */
4144
4236
  declare type FileDownloadLocationChangedEvent = NamedEvent & {
4145
4237
  type: 'file-download-location-changed';
@@ -4147,6 +4239,7 @@ declare type FileDownloadLocationChangedEvent = NamedEvent & {
4147
4239
 
4148
4240
  /**
4149
4241
  * Generated during file download progress.
4242
+ * @interface
4150
4243
  */
4151
4244
  declare type FileDownloadProgressEvent = FileDownloadEvent & {
4152
4245
  type: 'file-download-progress';
@@ -4159,6 +4252,7 @@ declare type FileDownloadSettings = {
4159
4252
 
4160
4253
  /**
4161
4254
  * Generated when a file download has started.
4255
+ * @interface
4162
4256
  */
4163
4257
  declare type FileDownloadStartedEvent = FileDownloadEvent & {
4164
4258
  type: 'file-download-started';
@@ -4262,6 +4356,7 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
4262
4356
 
4263
4357
  /**
4264
4358
  * Generated when a WebContents gains focus.
4359
+ * @interface
4265
4360
  */
4266
4361
  declare type FocusedEvent = NamedEvent & {
4267
4362
  type: 'focused';
@@ -4269,6 +4364,7 @@ declare type FocusedEvent = NamedEvent & {
4269
4364
 
4270
4365
  /**
4271
4366
  * Generated when a result is available when calling findInPage.
4367
+ * @interface
4272
4368
  */
4273
4369
  declare type FoundInPageEvent = NamedEvent & {
4274
4370
  type: 'found-in-page';
@@ -4407,6 +4503,7 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
4407
4503
 
4408
4504
  /**
4409
4505
  * Generated when a frame is connected.
4506
+ * @interface
4410
4507
  */
4411
4508
  declare type FrameConnectedEvent = BaseFrameEvent & {
4412
4509
  type: 'connected';
@@ -4414,6 +4511,7 @@ declare type FrameConnectedEvent = BaseFrameEvent & {
4414
4511
 
4415
4512
  /**
4416
4513
  * Generated when a frame has disconnected.
4514
+ * @interface
4417
4515
  */
4418
4516
  declare type FrameDisconnectedEvent = BaseFrameEvent & {
4419
4517
  type: 'disconnected';
@@ -4451,6 +4549,9 @@ declare type FrameInfo = {
4451
4549
  parent: Identity_5;
4452
4550
  };
4453
4551
 
4552
+ /**
4553
+ * Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
4554
+ */
4454
4555
  declare class _FrameModule extends Base {
4455
4556
  /**
4456
4557
  * Asynchronously returns a reference to the specified frame. The frame does not have to exist
@@ -4500,6 +4601,9 @@ declare class _FrameModule extends Base {
4500
4601
  getCurrentSync(): OpenFin.Frame;
4501
4602
  }
4502
4603
 
4604
+ /**
4605
+ * @interface
4606
+ */
4503
4607
  declare type FrameProcessDetails = ProcessDetails & {
4504
4608
  /**
4505
4609
  * Current URL associated with the process.
@@ -4664,18 +4768,11 @@ declare type GpuInfo = {
4664
4768
  name: string;
4665
4769
  };
4666
4770
 
4667
- /**
4668
- * Generated when a window has been hidden.
4669
- */
4670
- declare type HiddenEvent = NamedEvent & {
4671
- type: 'hidden';
4672
- reason: 'closing' | 'hide' | 'hide-on-close';
4673
- };
4674
-
4675
4771
  /**
4676
4772
  * Generated when a View is hidden.
4773
+ * @interface
4677
4774
  */
4678
- declare type HiddenEvent_2 = BaseViewEvent & {
4775
+ declare type HiddenEvent = BaseViewEvent & {
4679
4776
  type: 'hidden';
4680
4777
  };
4681
4778
 
@@ -4742,6 +4839,7 @@ declare type Hotkey = {
4742
4839
  /**
4743
4840
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [View options](OpenFin.ViewOptions.html) is pressed inside the view.
4744
4841
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
4842
+ * @interface
4745
4843
  */
4746
4844
  declare type HotkeyEvent = BaseViewEvent & {
4747
4845
  type: 'hotkey';
@@ -4776,6 +4874,7 @@ declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<Add
4776
4874
 
4777
4875
  /**
4778
4876
  * An Identity event.
4877
+ * @interface
4779
4878
  */
4780
4879
  declare type IdentityEvent = BaseEvent & {
4781
4880
  uuid: string;
@@ -4788,6 +4887,7 @@ declare type IdentityEvent = BaseEvent & {
4788
4887
  * @remarks This method is continuously generated every minute while the user is in idle.
4789
4888
  * A user enters idle state when the computer is locked or when there has been no keyboard/mouse activity for 1 minute.
4790
4889
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
4890
+ * @interface
4791
4891
  */
4792
4892
  declare type IdleEvent = {
4793
4893
  type: 'idle-state-changed';
@@ -4816,6 +4916,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
4816
4916
 
4817
4917
  /**
4818
4918
  * Generated when an application has initialized.
4919
+ * @interface
4819
4920
  */
4820
4921
  declare type InitializedEvent = IdentityEvent & {
4821
4922
  type: 'initialized';
@@ -4846,6 +4947,7 @@ declare type InitPlatformOptions = {
4846
4947
 
4847
4948
  /**
4848
4949
  * Generated when the value of the element changes.
4950
+ * @interface
4849
4951
  */
4850
4952
  declare type InputEvent_2 = {
4851
4953
  inputType: 'keyUp' | 'keyDown';
@@ -6370,6 +6472,138 @@ declare type LaunchIntoPlatformPayload = {
6370
6472
  manifest: any;
6371
6473
  };
6372
6474
 
6475
+ /**
6476
+ *
6477
+ * Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
6478
+ * enables the initialization and manipulation of a window's Layout. A Layout will
6479
+ * emit events locally on the DOM element representing the layout-container.
6480
+ *
6481
+ *
6482
+ * ### Layout.DOMEvents
6483
+ *
6484
+ * When a Layout is created, it emits events onto the DOM element representing the Layout container.
6485
+ * This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
6486
+ * 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).
6487
+ * The events are emitted synchronously and only in the process where the Layout exists.
6488
+ * Any values returned by the called listeners are ignored and will be discarded.
6489
+ * If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
6490
+ *
6491
+ * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
6492
+ *
6493
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
6494
+ * Adds a listener to the end of the listeners array for the specified event.
6495
+ * @example
6496
+ * ```js
6497
+ * const myLayoutContainer = document.getElementById('layout-container');
6498
+ *
6499
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
6500
+ * const { tabSelector } = event.detail;
6501
+ * const tabElement = document.getElementById(tabSelector);
6502
+ * const existingColor = tabElement.style.backgroundColor;
6503
+ * tabElement.style.backgroundColor = "red";
6504
+ * setTimeout(() => {
6505
+ * tabElement.style.backgroundColor = existingColor;
6506
+ * }, 2000);
6507
+ * });
6508
+ * ```
6509
+ *
6510
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
6511
+ * Adds a listener to the end of the listeners array for the specified event.
6512
+ * @example
6513
+ * ```js
6514
+ * const myLayoutContainer = document.getElementById('layout-container');
6515
+ *
6516
+ * const listener = function(event) {
6517
+ * console.log(event.detail);
6518
+ * console.log('container-created event fired once, removing listener');
6519
+ * myLayoutContainer.removeEventListener('container-created', listener);
6520
+ * };
6521
+ *
6522
+ * myLayoutContainer.addEventListener('container-created', listener);
6523
+ * ```
6524
+ *
6525
+ * ### Supported event types are:
6526
+ *
6527
+ * * tab-created
6528
+ * * container-created
6529
+ * * layout-state-changed
6530
+ * * tab-closed
6531
+ * * tab-dropped
6532
+ *
6533
+ * ### Layout DOM Node Events
6534
+ *
6535
+ * #### tab-created
6536
+ * 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.
6537
+ * ```js
6538
+ * // The response has the following shape in event.detail:
6539
+ * {
6540
+ * containerSelector: "container-component_A",
6541
+ * name: "component_A",
6542
+ * tabSelector: "tab-component_A",
6543
+ * topic: "openfin-DOM-event",
6544
+ * type: "tab-created",
6545
+ * uuid: "OpenFin POC"
6546
+ * }
6547
+ * ```
6548
+ *
6549
+ * #### container-created
6550
+ * 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.
6551
+ * ```js
6552
+ * // The response has the following shape in event.detail:
6553
+ * {
6554
+ * containerSelector: "container-component_A",
6555
+ * name: "component_A",
6556
+ * tabSelector: "tab-component_A",
6557
+ * topic: "openfin-DOM-event",
6558
+ * type: "container-created",
6559
+ * uuid: "OpenFin POC"
6560
+ * }
6561
+ * ```
6562
+ *
6563
+ * ### layout-state-changed
6564
+ * 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.
6565
+ * ```js
6566
+ * // The response has the following shape in event.detail
6567
+ * {
6568
+ * containerSelector: "container-component_A",
6569
+ * name: "component_A",
6570
+ * tabSelector: "tab-component_A",
6571
+ * topic: "openfin-DOM-event",
6572
+ * type: "layout-state-changed",
6573
+ * uuid: "OpenFin POC"
6574
+ * }
6575
+ * ```
6576
+ *
6577
+ * #### tab-closed
6578
+ * Generated when a tab is closed.
6579
+ * ```js
6580
+ * // The response has the following shape in event.detail:
6581
+ * {
6582
+ * containerSelector: "container-component_A",
6583
+ * name: "component_A",
6584
+ * tabSelector: "tab-component_A",
6585
+ * topic: "openfin-DOM-event",
6586
+ * type: "tab-closed",
6587
+ * uuid: "OpenFin POC",
6588
+ * url: "http://openfin.co" // The url of the view that was closed.
6589
+ * }
6590
+ * ```
6591
+ *
6592
+ * #### tab-dropped
6593
+ * Generated when a tab is dropped.
6594
+ * ```js
6595
+ * // The response has the following shape in event.detail:
6596
+ * {
6597
+ * containerSelector: "container-component_A",
6598
+ * name: "component_A",
6599
+ * tabSelector: "tab-component_A",
6600
+ * topic: "openfin-DOM-event",
6601
+ * type: "tab-dropped",
6602
+ * uuid: "OpenFin POC",
6603
+ * url: "http://openfin.co" // The url of the view linked to the dropped tab.
6604
+ * }
6605
+ * ```
6606
+ */
6373
6607
  declare class Layout extends Base {
6374
6608
  #private;
6375
6609
  /* Excluded from this release type: init */
@@ -6550,6 +6784,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
6550
6784
 
6551
6785
  /**
6552
6786
  * Generated when a window and all of its layout's views have either finished or failed navigation.
6787
+ * @interface
6553
6788
  */
6554
6789
  declare type LayoutInitializedEvent = NamedEvent & {
6555
6790
  type: 'layout-initialized';
@@ -6667,6 +6902,9 @@ declare class LayoutManager {
6667
6902
  private setComponentState;
6668
6903
  }
6669
6904
 
6905
+ /**
6906
+ * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
6907
+ */
6670
6908
  declare class LayoutModule extends Base {
6671
6909
  #private;
6672
6910
  /**
@@ -6863,6 +7101,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
6863
7101
 
6864
7102
  /**
6865
7103
  * Generated when a window and all of its layout's views have been created and can receive API calls.
7104
+ * @interface
6866
7105
  */
6867
7106
  declare type LayoutReadyEvent = NamedEvent & {
6868
7107
  type: 'layout-ready';
@@ -6970,6 +7209,7 @@ declare type Manifest = {
6970
7209
 
6971
7210
  /**
6972
7211
  * Generated when the RVM notifies an application that the manifest has changed.
7212
+ * @interface
6973
7213
  */
6974
7214
  declare type ManifestChangedEvent = IdentityEvent & {
6975
7215
  type: 'manifest-changed';
@@ -7013,6 +7253,7 @@ declare type MatchPattern = string;
7013
7253
 
7014
7254
  /**
7015
7255
  * Generated when a window is maximized.
7256
+ * @interface
7016
7257
  */
7017
7258
  declare type MaximizedEvent = NamedEvent & {
7018
7259
  type: 'maximized';
@@ -7085,6 +7326,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
7085
7326
 
7086
7327
  /**
7087
7328
  * Generated when a window is minimized.
7329
+ * @interface
7088
7330
  */
7089
7331
  declare type MinimizedEvent = NamedEvent & {
7090
7332
  type: 'minimized';
@@ -7130,6 +7372,7 @@ declare type MonitorDetails = {
7130
7372
  * Generated on changes of a monitor's size/location.
7131
7373
  * @remarks A monitor's size changes when the taskbar is resized or relocated.
7132
7374
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
7375
+ * @interface
7133
7376
  */
7134
7377
  declare type MonitorEvent = OpenFin.MonitorInfo & {
7135
7378
  type: 'monitor-info-changed';
@@ -7477,6 +7720,7 @@ declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => v
7477
7720
 
7478
7721
  /**
7479
7722
  * A Name event.
7723
+ * @interface
7480
7724
  */
7481
7725
  declare type NamedEvent = IdentityEvent & {
7482
7726
  name: string;
@@ -7488,6 +7732,7 @@ declare type NativeWindowIntegrationProviderAuthorization = {
7488
7732
 
7489
7733
  /**
7490
7734
  * Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
7735
+ * @interface
7491
7736
  */
7492
7737
  declare type NavigationRejectedEvent = NamedEvent & {
7493
7738
  type: 'navigation-rejected';
@@ -7508,6 +7753,9 @@ declare type NavigationRules = {
7508
7753
 
7509
7754
  declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
7510
7755
 
7756
+ /**
7757
+ * @interface
7758
+ */
7511
7759
  declare type NonAppProcessDetails = ProcessDetails & {
7512
7760
  name: string;
7513
7761
  };
@@ -7531,6 +7779,7 @@ declare type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
7531
7779
 
7532
7780
  /**
7533
7781
  * Generated when an application is not responding.
7782
+ * @interface
7534
7783
  */
7535
7784
  declare type NotRespondingEvent = IdentityEvent & {
7536
7785
  type: 'not-responding';
@@ -7538,6 +7787,9 @@ declare type NotRespondingEvent = IdentityEvent & {
7538
7787
 
7539
7788
  declare type OnlyIfCompatible<A, B, D = OverlapsOnlyIfMatching<A, B>> = D extends Record<any, never> ? keyof D extends never ? A | B : never : A | B;
7540
7789
 
7790
+ /**
7791
+ * @interface
7792
+ */
7541
7793
  declare type Opacity = TransitionBase & {
7542
7794
  /**
7543
7795
  * The opacity from 0.0 (transparent) to 1.0 (normal).
@@ -7772,7 +8024,7 @@ declare namespace OpenFin {
7772
8024
  ContextForIntent,
7773
8025
  InfoForIntentOptions,
7774
8026
  FindIntentsByContextOptions,
7775
- ProviderIdentity_8 as ProviderIdentity,
8027
+ ProviderIdentity_7 as ProviderIdentity,
7776
8028
  RegisterUsageData,
7777
8029
  ViewsPreventingUnloadPayload,
7778
8030
  BeforeUnloadUserDecision,
@@ -7844,7 +8096,8 @@ declare namespace OpenFin {
7844
8096
  InteropLoggingOptions,
7845
8097
  Me,
7846
8098
  CapturePageOptions,
7847
- ProcessLoggingOptions
8099
+ ProcessLoggingOptions,
8100
+ PositioningOptions
7848
8101
  }
7849
8102
  }
7850
8103
  export default OpenFin;
@@ -7860,6 +8113,7 @@ declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T>
7860
8113
  /**
7861
8114
  * Generated when page title is set during navigation.
7862
8115
  * @remarks explicitSet is false when title is synthesized from file url.
8116
+ * @interface
7863
8117
  */
7864
8118
  declare type PageTitleUpdatedEvent = NamedEvent & {
7865
8119
  type: 'page-title-updated';
@@ -7877,6 +8131,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
7877
8131
 
7878
8132
  /**
7879
8133
  * Generated when window finishes loading. Provides performance and navigation data.
8134
+ * @interface
7880
8135
  */
7881
8136
  declare type PerformanceReportEvent = Performance & NamedEvent & {
7882
8137
  type: 'performance-report';
@@ -8515,6 +8770,7 @@ declare type Platform_2 = OpenFin.Platform;
8515
8770
 
8516
8771
  /**
8517
8772
  * Generated when a new Platform's API becomes responsive.
8773
+ * @interface
8518
8774
  */
8519
8775
  declare type PlatformApiReadyEvent = BaseEvent & {
8520
8776
  topic: 'application';
@@ -8536,6 +8792,9 @@ declare namespace PlatformEvents {
8536
8792
  }
8537
8793
  }
8538
8794
 
8795
+ /**
8796
+ * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
8797
+ */
8539
8798
  declare class PlatformModule extends Base {
8540
8799
  private _channel;
8541
8800
  Layout: LayoutModule;
@@ -8692,6 +8951,7 @@ declare class PlatformModule extends Base {
8692
8951
  /**
8693
8952
  * The options object required by {@link Platform.PlatformModule#start Platform.start}
8694
8953
  * Any {@link ApplicationOptions Application option} is also a valid platform option
8954
+ * @interface
8695
8955
  */
8696
8956
  declare type PlatformOptions = ApplicationCreationOptions & {
8697
8957
  /**
@@ -9200,6 +9460,7 @@ declare interface PlatformProvider {
9200
9460
  * 3. If a window has a layout property, the 'layout-ready' event has fired
9201
9461
  *
9202
9462
  * _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.
9463
+ * @interface
9203
9464
  */
9204
9465
  declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9205
9466
  topic: 'application';
@@ -9208,6 +9469,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9208
9469
 
9209
9470
  declare type PlatformViewCreationOptions = Partial<ViewOptions>;
9210
9471
 
9472
+ /**
9473
+ * @interface
9474
+ */
9211
9475
  declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
9212
9476
  updateStateIfExists?: boolean;
9213
9477
  reason?: WindowCreationReason;
@@ -9218,6 +9482,7 @@ declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
9218
9482
  * Any {@link OpenFin.WindowCreationOptions Window option} is also a valid Default Window option
9219
9483
  * used by default in any window that is created in the current platform's scope.
9220
9484
  * Individual window options will override these defaults.
9485
+ * @interface
9221
9486
  */
9222
9487
  declare type PlatformWindowOptions = WindowCreationOptions & {
9223
9488
  /**
@@ -9285,6 +9550,9 @@ declare interface PopupResult<T = any> {
9285
9550
 
9286
9551
  declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
9287
9552
 
9553
+ /**
9554
+ * @interface
9555
+ */
9288
9556
  declare type Position = TransitionBase & {
9289
9557
  /**
9290
9558
  * Defaults to the window's current left position in virtual screen coordinates.
@@ -9296,6 +9564,26 @@ declare type Position = TransitionBase & {
9296
9564
  top: number;
9297
9565
  };
9298
9566
 
9567
+ /**
9568
+ * Leveraged by the following windowing apis to influence side effects of the positioning.
9569
+ * - {@link OpenFin.Window.moveBy}
9570
+ * - {@link OpenFin.Window.moveTo}
9571
+ * - {@link OpenFin.Window.setBounds}
9572
+ * - {@link OpenFin.Window.resizeBy}
9573
+ * - {@link OpenFin.Window.resizeTo}
9574
+ * @example ```js
9575
+ fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
9576
+ ```
9577
+ */
9578
+ declare interface PositioningOptions {
9579
+ /**
9580
+ * Windows Only.
9581
+ * If set to true, will not restore a maximized window before setting the bounds.
9582
+ * This will have the effect of the maximized window staying maximized and not immediately taking this new position.
9583
+ */
9584
+ skipRestore?: boolean;
9585
+ }
9586
+
9299
9587
  /**
9300
9588
  * Context menu item with an implementation provided by OpenFin.
9301
9589
  */
@@ -9338,6 +9626,7 @@ declare type PreloadScriptInfoRunning = {
9338
9626
  /**
9339
9627
  * Generated after the execution of all of a window's preload scripts.
9340
9628
  * @remarks Contains information about all window's preload scripts' final states.
9629
+ * @interface
9341
9630
  */
9342
9631
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
9343
9632
  type: 'preload-script-state-changed';
@@ -9345,6 +9634,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
9345
9634
 
9346
9635
  /**
9347
9636
  * A general preload scripts state change event without event type.
9637
+ * @interface
9348
9638
  */
9349
9639
  declare type PreloadScriptsStateChangeEvent = NamedEvent & {
9350
9640
  preloadScripts: (PreloadScriptInfoRunning & any)[];
@@ -9353,6 +9643,7 @@ declare type PreloadScriptsStateChangeEvent = NamedEvent & {
9353
9643
  /**
9354
9644
  * Generated during the execution of a window's preload script.
9355
9645
  * @remarks Contains information about a single window's preload script's state, for which the event has been raised.
9646
+ * @interface
9356
9647
  */
9357
9648
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
9358
9649
  type: 'preload-script-state-changing';
@@ -9735,6 +10026,25 @@ declare interface ProtocolMap extends ProtocolMapBase {
9735
10026
  'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
9736
10027
  domainSettings: OpenFin.DefaultDomainSettings;
9737
10028
  }, void>;
10029
+ 'move-window-by': IdentityCall<WithPositioningOptions<{
10030
+ deltaLeft: number;
10031
+ deltaTop: number;
10032
+ }>>;
10033
+ 'move-window': IdentityCall<WithPositioningOptions<{
10034
+ left: number;
10035
+ top: number;
10036
+ }>>;
10037
+ 'resize-window-by': IdentityCall<WithPositioningOptions<{
10038
+ deltaWidth: number;
10039
+ deltaHeight: number;
10040
+ anchor: OpenFin.AnchorType;
10041
+ }>>;
10042
+ 'resize-window': IdentityCall<WithPositioningOptions<{
10043
+ width: number;
10044
+ height: number;
10045
+ anchor: OpenFin.AnchorType;
10046
+ }>>;
10047
+ 'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
9738
10048
  }
9739
10049
 
9740
10050
  declare interface ProtocolMapBase {
@@ -9766,12 +10076,11 @@ declare type ProviderIdentity_5 = OpenFin.ProviderIdentity;
9766
10076
 
9767
10077
  declare type ProviderIdentity_6 = OpenFin.ProviderIdentity;
9768
10078
 
9769
- declare type ProviderIdentity_7 = OpenFin.ProviderIdentity;
9770
-
9771
10079
  /**
9772
10080
  * Identity of a channel provider.
10081
+ * @interface
9773
10082
  */
9774
- declare type ProviderIdentity_8 = Identity_5 & {
10083
+ declare type ProviderIdentity_7 = Identity_5 & {
9775
10084
  /**
9776
10085
  * Identifier of the channel.
9777
10086
  */
@@ -9838,6 +10147,9 @@ declare type QueryPermissionResult = {
9838
10147
  rawValue?: unknown;
9839
10148
  };
9840
10149
 
10150
+ /**
10151
+ * @interface
10152
+ */
9841
10153
  declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
9842
10154
 
9843
10155
  /**
@@ -9873,6 +10185,7 @@ declare type RectangleByEdgePositions = {
9873
10185
 
9874
10186
  /**
9875
10187
  * Generated when a hotkey has been registered with the operating system.
10188
+ * @interface
9876
10189
  */
9877
10190
  declare type RegisteredEvent = BaseEvent & {
9878
10191
  type: 'registered';
@@ -9895,6 +10208,7 @@ declare type RegistryInfo_2 = {
9895
10208
 
9896
10209
  /**
9897
10210
  * Generated when a window has been reloaded.
10211
+ * @interface
9898
10212
  */
9899
10213
  declare type ReloadedEvent = NamedEvent & {
9900
10214
  type: 'reloaded';
@@ -9980,6 +10294,7 @@ declare type ResizeRegion = {
9980
10294
 
9981
10295
  /**
9982
10296
  * Generated when an HTTP load was cancelled or failed.
10297
+ * @interface
9983
10298
  */
9984
10299
  declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
9985
10300
  type: 'resource-load-failed';
@@ -9987,6 +10302,7 @@ declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
9987
10302
 
9988
10303
  /**
9989
10304
  * Generated when an HTTP resource request has received response details.
10305
+ * @interface
9990
10306
  */
9991
10307
  declare type ResourceResponseReceivedEvent = NamedEvent & {
9992
10308
  type: 'resource-response-received';
@@ -10002,6 +10318,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
10002
10318
 
10003
10319
  /**
10004
10320
  * Generated when an application is responding.
10321
+ * @interface
10005
10322
  */
10006
10323
  declare type RespondingEvent = IdentityEvent & {
10007
10324
  type: 'responding';
@@ -10015,7 +10332,10 @@ declare type RGB = {
10015
10332
  green: number;
10016
10333
  };
10017
10334
 
10018
- declare type RoutingInfo = ProviderIdentity_3 & {
10335
+ /**
10336
+ * @interface
10337
+ */
10338
+ declare type RoutingInfo = OpenFin.ProviderIdentity & {
10019
10339
  endpointId: string;
10020
10340
  };
10021
10341
 
@@ -10041,7 +10361,7 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
10041
10361
  declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload> {
10042
10362
  #private;
10043
10363
  onEndpointDisconnect(endpointId: string, listener: () => void): void;
10044
- receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_6) => Promise<any>): void;
10364
+ receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
10045
10365
  send: (endpointId: string, action: string, payload: any) => Promise<any>;
10046
10366
  close: () => Promise<void>;
10047
10367
  private getEndpointById;
@@ -10053,7 +10373,7 @@ declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload>
10053
10373
  }
10054
10374
 
10055
10375
  declare interface RTCStrategyEndpointPayload {
10056
- endpointIdentity: OpenFin.ClientIdentity | ProviderIdentity_6;
10376
+ endpointIdentity: OpenFin.ClientIdentity | ProviderIdentity_5;
10057
10377
  rtc: RTCPacket;
10058
10378
  }
10059
10379
 
@@ -10061,6 +10381,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
10061
10381
 
10062
10382
  /**
10063
10383
  * Generated when Application.run() is called for an already running application.
10384
+ * @interface
10064
10385
  */
10065
10386
  declare type RunRequestedEvent_2 = IdentityEvent & {
10066
10387
  type: 'run-requested';
@@ -10212,6 +10533,7 @@ declare type ServiceIdentifier = {
10212
10533
 
10213
10534
  /**
10214
10535
  * Generated on changes to a user’s local computer session.
10536
+ * @interface
10215
10537
  */
10216
10538
  declare type SessionChangedEvent = {
10217
10539
  type: 'session-changed';
@@ -10262,12 +10584,16 @@ declare type ShortCutConfig = {
10262
10584
  systemStartup?: boolean;
10263
10585
  };
10264
10586
 
10587
+ /**
10588
+ * @interface
10589
+ */
10265
10590
  declare type ShortcutOverride = Hotkey & {
10266
10591
  command: string;
10267
10592
  };
10268
10593
 
10269
10594
  /**
10270
10595
  * Generated when a View is shown. This event will fire during creation of a View.
10596
+ * @interface
10271
10597
  */
10272
10598
  declare type ShownEvent = BaseViewEvent & {
10273
10599
  type: 'shown';
@@ -10281,6 +10607,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
10281
10607
 
10282
10608
  /**
10283
10609
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
10610
+ * @interface
10284
10611
  */
10285
10612
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
10286
10613
  /**
@@ -10297,6 +10624,9 @@ declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
10297
10624
  paintIntervalMs?: number;
10298
10625
  };
10299
10626
 
10627
+ /**
10628
+ * @interface
10629
+ */
10300
10630
  declare type Size = TransitionBase & {
10301
10631
  /**
10302
10632
  * Optional if height is present. Defaults to the window's current width.
@@ -10373,6 +10703,9 @@ declare class SnapshotSource<T = any> extends Base {
10373
10703
  applySnapshot(snapshot: T): Promise<void>;
10374
10704
  }
10375
10705
 
10706
+ /**
10707
+ * Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
10708
+ */
10376
10709
  declare class SnapshotSourceModule extends Base {
10377
10710
  /**
10378
10711
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
@@ -10451,6 +10784,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
10451
10784
 
10452
10785
  /**
10453
10786
  * Generated when an application has started.
10787
+ * @interface
10454
10788
  */
10455
10789
  declare type StartedEvent = IdentityEvent & {
10456
10790
  type: 'started';
@@ -12179,12 +12513,16 @@ declare type TargetApp = string | AppMetadata;
12179
12513
  * Generated when a View changes its window target.
12180
12514
  * @remarks This event will fire during creation of a View.
12181
12515
  * In that case, previousTarget identity will be the same as target identity.
12516
+ * @interface
12182
12517
  */
12183
12518
  declare type TargetChangedEvent = BaseViewEvent & {
12184
12519
  type: 'target-changed';
12185
12520
  previousTarget: OpenFin.Identity;
12186
12521
  };
12187
12522
 
12523
+ /**
12524
+ * @interface
12525
+ */
12188
12526
  declare type TaskBar = DipScaleRects & {
12189
12527
  /**
12190
12528
  * Which edge of a monitor the taskbar is on
@@ -12307,6 +12645,7 @@ declare class Transport<MeType extends EntityType_3 = EntityType_3> extends Even
12307
12645
 
12308
12646
  /**
12309
12647
  * Generated when the tray icon is clicked.
12648
+ * @interface
12310
12649
  */
12311
12650
  declare type TrayIconClickedEvent = IdentityEvent & {
12312
12651
  type: 'tray-icon-clicked';
@@ -12358,6 +12697,7 @@ declare interface TypedEventEmitter<Event extends {
12358
12697
 
12359
12698
  /**
12360
12699
  * Generated when a hotkey has been unregistered with the operating system.
12700
+ * @interface
12361
12701
  */
12362
12702
  declare type UnregisteredEvent = BaseEvent & {
12363
12703
  type: 'unregistered';
@@ -12374,6 +12714,7 @@ declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
12374
12714
  * Generated when navigation or redirect is completed.
12375
12715
  * @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.
12376
12716
  * 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).
12717
+ * @interface
12377
12718
  */
12378
12719
  declare type UrlChangedEvent = BaseUrlEvent & ({
12379
12720
  isInPage: true;
@@ -12385,6 +12726,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
12385
12726
 
12386
12727
  /**
12387
12728
  * A general user bounds change event without event type.
12729
+ * @interface
12388
12730
  */
12389
12731
  declare type UserBoundsChangeEvent = NamedEvent & {
12390
12732
  height: number;
@@ -12396,6 +12738,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
12396
12738
 
12397
12739
  /**
12398
12740
  * Generated when a window's user movement becomes disabled.
12741
+ * @interface
12399
12742
  */
12400
12743
  declare type UserMovementDisabledEvent = NamedEvent & {
12401
12744
  type: 'user-movement-disabled';
@@ -12403,6 +12746,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
12403
12746
 
12404
12747
  /**
12405
12748
  * Generated when a window's user movement becomes enabled.
12749
+ * @interface
12406
12750
  */
12407
12751
  declare type UserMovementEnabledEvent = NamedEvent & {
12408
12752
  type: 'user-movement-enabled';
@@ -12975,6 +13319,7 @@ declare interface ViewComponent extends GoldenLayout.ContentItem {
12975
13319
  *
12976
13320
  * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
12977
13321
  * (defaults to `"about:blank"` when omitted).
13322
+ * @interface
12978
13323
  */
12979
13324
  declare type ViewCreationOptions = Partial<ViewOptions> & {
12980
13325
  name: string;
@@ -12987,6 +13332,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
12987
13332
  /**
12988
13333
  * Generated when a window has a view detached from it.
12989
13334
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
13335
+ * @interface
12990
13336
  */
12991
13337
  declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
12992
13338
  type: 'view-detached';
@@ -13010,7 +13356,7 @@ declare namespace ViewEvents {
13010
13356
  AttachedEvent,
13011
13357
  CreatedEvent,
13012
13358
  DestroyedEvent,
13013
- HiddenEvent_2 as HiddenEvent,
13359
+ HiddenEvent,
13014
13360
  HotkeyEvent,
13015
13361
  ShownEvent,
13016
13362
  WillPropagateViewEvent,
@@ -13035,6 +13381,9 @@ declare type ViewInfo = {
13035
13381
  favicons: string[];
13036
13382
  };
13037
13383
 
13384
+ /**
13385
+ * Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
13386
+ */
13038
13387
  declare class ViewModule extends Base {
13039
13388
  /**
13040
13389
  * Creates a new View.
@@ -13117,6 +13466,7 @@ declare class ViewModule extends Base {
13117
13466
 
13118
13467
  /**
13119
13468
  * User-facing options for a view.
13469
+ * @interface
13120
13470
  */
13121
13471
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
13122
13472
 
@@ -13177,6 +13527,9 @@ declare interface ViewsPreventingUnloadPayload {
13177
13527
  closeType: 'view' | 'window';
13178
13528
  }
13179
13529
 
13530
+ /**
13531
+ * @interface
13532
+ */
13180
13533
  declare type ViewState = ViewCreationOptions & {
13181
13534
  backgroundThrottling: boolean;
13182
13535
  componentName: 'view';
@@ -14146,6 +14499,7 @@ declare type WebRequestHeader = {
14146
14499
  /**
14147
14500
  * Generated when a window is being moved by the user.
14148
14501
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
14502
+ * @interface
14149
14503
  */
14150
14504
  declare type WillMoveEvent = WillMoveOrResizeEvent & {
14151
14505
  type: 'will-move';
@@ -14153,6 +14507,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
14153
14507
 
14154
14508
  /**
14155
14509
  * A general will-move or will-resize event without event type.
14510
+ * @interface
14156
14511
  */
14157
14512
  declare type WillMoveOrResizeEvent = NamedEvent & {
14158
14513
  height: number;
@@ -14170,7 +14525,7 @@ declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedE
14170
14525
  /**
14171
14526
  * A View event that does propagate to (republish on) parent topics.
14172
14527
  */
14173
- declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent_2 | HotkeyEvent | ShownEvent | TargetChangedEvent;
14528
+ declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
14174
14529
 
14175
14530
  /**
14176
14531
  * A WebContents event that does propagate to (republish on) parent topics.
@@ -14180,10 +14535,11 @@ declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelection
14180
14535
  /**
14181
14536
  * A Window event that does propagate to (republish on) parent topics.
14182
14537
  */
14183
- 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;
14538
+ 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;
14184
14539
 
14185
14540
  /**
14186
14541
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
14542
+ * @interface
14187
14543
  */
14188
14544
  declare type WillRedirectEvent = NamedEvent & {
14189
14545
  type: 'will-redirect';
@@ -14196,6 +14552,7 @@ declare type WillRedirectEvent = NamedEvent & {
14196
14552
  * Generated when a window is being resized by the user.
14197
14553
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
14198
14554
  * 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.
14555
+ * @interface
14199
14556
  */
14200
14557
  declare type WillResizeEvent = WillMoveOrResizeEvent & {
14201
14558
  type: 'will-resize';
@@ -15267,7 +15624,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15267
15624
  * moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
15268
15625
  * ```
15269
15626
  */
15270
- moveBy(deltaLeft: number, deltaTop: number): Promise<void>;
15627
+ moveBy(deltaLeft: number, deltaTop: number, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
15271
15628
  /**
15272
15629
  * Moves the window to a specified location.
15273
15630
  * @param left The left position of the window
@@ -15293,7 +15650,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15293
15650
  * moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
15294
15651
  * ```
15295
15652
  */
15296
- moveTo(left: number, top: number): Promise<void>;
15653
+ moveTo(left: number, top: number, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
15297
15654
  /**
15298
15655
  * Resizes the window by a specified amount.
15299
15656
  * @param deltaWidth The change in the width of the window
@@ -15322,7 +15679,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15322
15679
  * resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
15323
15680
  * ```
15324
15681
  */
15325
- resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin.AnchorType): Promise<void>;
15682
+ resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin.AnchorType, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
15326
15683
  /**
15327
15684
  * Resizes the window to the specified dimensions.
15328
15685
  * @param width The change in the width of the window
@@ -15351,7 +15708,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15351
15708
  * resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
15352
15709
  * ```
15353
15710
  */
15354
- resizeTo(width: number, height: number, anchor: OpenFin.AnchorType): Promise<void>;
15711
+ resizeTo(width: number, height: number, anchor: OpenFin.AnchorType, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
15355
15712
  /**
15356
15713
  * Restores the window to its normal state (i.e., unminimized, unmaximized).
15357
15714
  *
@@ -15402,7 +15759,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15402
15759
  setAsForeground(): Promise<void>;
15403
15760
  /**
15404
15761
  * Sets the window's size and position.
15405
- * @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
15406
15762
  *
15407
15763
  * @example
15408
15764
  * ```js
@@ -15429,7 +15785,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15429
15785
  * }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
15430
15786
  * ```
15431
15787
  */
15432
- setBounds(bounds: Partial<OpenFin.Bounds>): Promise<void>;
15788
+ setBounds(bounds: Partial<OpenFin.Bounds>, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
15433
15789
  /**
15434
15790
  * Shows the window if it is hidden.
15435
15791
  * @param force Show will be prevented from showing when force is false and
@@ -15720,6 +16076,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15720
16076
 
15721
16077
  /**
15722
16078
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
16079
+ * @interface
15723
16080
  */
15724
16081
  declare type WindowAlertRequestedEvent = NamedEvent & {
15725
16082
  type: 'window-alert-requested';
@@ -15727,6 +16084,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15727
16084
 
15728
16085
  /**
15729
16086
  * Returned from getBounds call. bottom and right are never used for setting.
16087
+ * @interface
15730
16088
  */
15731
16089
  declare type WindowBounds = Bounds & {
15732
16090
  bottom: number;
@@ -15735,6 +16093,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15735
16093
 
15736
16094
  /**
15737
16095
  * Generated when a window has closed.
16096
+ * @interface
15738
16097
  */
15739
16098
  declare type WindowClosedEvent = NamedEvent & {
15740
16099
  type: 'closed';
@@ -15743,6 +16102,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15743
16102
  /**
15744
16103
  * Generated when a window has been prevented from closing.
15745
16104
  * @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.
16105
+ * @interface
15746
16106
  */
15747
16107
  declare type WindowCloseRequestedEvent = NamedEvent & {
15748
16108
  type: 'close-requested';
@@ -15750,6 +16110,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15750
16110
 
15751
16111
  /**
15752
16112
  * Generated when a window has initiated the closing routine.
16113
+ * @interface
15753
16114
  */
15754
16115
  declare type WindowClosingEvent = NamedEvent & {
15755
16116
  type: 'closing';
@@ -15757,6 +16118,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15757
16118
 
15758
16119
  /**
15759
16120
  * Generated when a child window is created.
16121
+ * @interface
15760
16122
  */
15761
16123
  declare type WindowCreatedEvent = NamedEvent & {
15762
16124
  type: 'window-created';
@@ -15767,6 +16129,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15767
16129
  *
15768
16130
  * Note that `name` is the only required property — albeit the `url` property is usually provided as well
15769
16131
  * (defaults to `"about:blank"` when omitted).
16132
+ * @interface
15770
16133
  */
15771
16134
  declare type WindowCreationOptions = Partial<WindowOptions> & {
15772
16135
  name: string;
@@ -15809,6 +16172,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15809
16172
 
15810
16173
  /**
15811
16174
  * Generated when a child window ends loading.
16175
+ * @interface
15812
16176
  */
15813
16177
  declare type WindowEndLoadEvent = NamedEvent & {
15814
16178
  type: 'window-end-load';
@@ -15833,7 +16197,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15833
16197
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
15834
16198
  ExternalProcessExitedEvent,
15835
16199
  ExternalProcessStartedEvent,
15836
- HiddenEvent,
16200
+ WindowHiddenEvent,
15837
16201
  PreloadScriptInfoRunning,
15838
16202
  PreloadScriptInfo,
15839
16203
  PreloadScriptsStateChangeEvent,
@@ -15883,9 +16247,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15883
16247
  */
15884
16248
  declare type WindowEventType = WindowEvent['type'];
15885
16249
 
16250
+ /**
16251
+ * Generated when a window has been hidden.
16252
+ * @interface
16253
+ */
16254
+ declare type WindowHiddenEvent = NamedEvent & {
16255
+ type: 'hidden';
16256
+ reason: 'closing' | 'hide' | 'hide-on-close';
16257
+ };
16258
+
15886
16259
  /**
15887
16260
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
15888
16261
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
16262
+ * @interface
15889
16263
  */
15890
16264
  declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
15891
16265
  type: 'hotkey';
@@ -15901,11 +16275,15 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15901
16275
 
15902
16276
  /**
15903
16277
  * Generated when a window is initialized.
16278
+ * @interface
15904
16279
  */
15905
16280
  declare type WindowInitializedEvent = NamedEvent & {
15906
16281
  type: 'initialized';
15907
16282
  };
15908
16283
 
16284
+ /**
16285
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
16286
+ */
15909
16287
  declare class _WindowModule extends Base {
15910
16288
  /**
15911
16289
  * Asynchronously returns a Window object that represents an existing window.
@@ -15996,6 +16374,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
15996
16374
 
15997
16375
  /**
15998
16376
  * Generated when a child window is not responding.
16377
+ * @interface
15999
16378
  */
16000
16379
  declare type WindowNotRespondingEvent = NamedEvent & {
16001
16380
  type: 'window-not-responding';
@@ -16008,6 +16387,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16008
16387
  };
16009
16388
  };
16010
16389
 
16390
+ /**
16391
+ * @interface
16392
+ */
16011
16393
  declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
16012
16394
 
16013
16395
  declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
@@ -16015,6 +16397,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16015
16397
  /**
16016
16398
  * Generated after window options are changed using the window.updateOptions method.
16017
16399
  * @remarks Will not fire if the diff object is empty.
16400
+ * @interface
16018
16401
  */
16019
16402
  declare type WindowOptionsChangedEvent_2 = NamedEvent & {
16020
16403
  type: 'options-changed';
@@ -16026,6 +16409,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16026
16409
 
16027
16410
  /**
16028
16411
  * Generated when a child window is responding.
16412
+ * @interface
16029
16413
  */
16030
16414
  declare type WindowRespondingEvent = NamedEvent & {
16031
16415
  type: 'window-responding';
@@ -16033,6 +16417,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16033
16417
 
16034
16418
  /**
16035
16419
  * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
16420
+ * @interface
16036
16421
  */
16037
16422
  declare type WindowRestoredEvent = NamedEvent & {
16038
16423
  type: 'restored';
@@ -16040,6 +16425,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16040
16425
 
16041
16426
  /**
16042
16427
  * Generated when a hidden window has been shown.
16428
+ * @interface
16043
16429
  */
16044
16430
  declare type WindowShownEvent = NamedEvent & {
16045
16431
  type: 'shown';
@@ -16048,6 +16434,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16048
16434
  /**
16049
16435
  * Generated when a window has been prevented from showing.
16050
16436
  * @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.
16437
+ * @interface
16051
16438
  */
16052
16439
  declare type WindowShowRequestedEvent = NamedEvent & {
16053
16440
  type: 'show-requested';
@@ -16055,6 +16442,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16055
16442
 
16056
16443
  /**
16057
16444
  * Generated when a child window starts loading.
16445
+ * @interface
16058
16446
  */
16059
16447
  declare type WindowStartLoadEvent = NamedEvent & {
16060
16448
  type: 'window-start-load';
@@ -16090,6 +16478,10 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16090
16478
 
16091
16479
  /* Excluded from this release type: WithoutId */
16092
16480
 
16481
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
16482
+ positioningOptions?: OpenFin.PositioningOptions;
16483
+ };
16484
+
16093
16485
  declare type WorkspacePlatformOptions = {
16094
16486
  /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
16095
16487
  [key: string]: any;
@@ -16097,6 +16489,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16097
16489
 
16098
16490
  /**
16099
16491
  * A generic request to write any supported data to the clipboard.
16492
+ * @interface
16100
16493
  */
16101
16494
  declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
16102
16495
  data: {
@@ -16115,6 +16508,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16115
16508
 
16116
16509
  /**
16117
16510
  * A request to write data to the clipboard.
16511
+ * @interface
16118
16512
  */
16119
16513
  declare type WriteClipboardRequest = BaseClipboardRequest & {
16120
16514
  /**
@@ -16123,6 +16517,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
16123
16517
  data: string;
16124
16518
  };
16125
16519
 
16520
+ /**
16521
+ * @interface
16522
+ */
16126
16523
  declare type WriteImageClipboardRequest = BaseClipboardRequest & {
16127
16524
  /**
16128
16525
  * Can be either a base64 string, or a DataURL string. If using DataURL, the