@openfin/core 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.
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;
@@ -909,6 +911,9 @@ declare type ApplicationInfo = {
909
911
  };
910
912
  };
911
913
 
914
+ /**
915
+ * Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
916
+ */
912
917
  declare class ApplicationModule extends Base {
913
918
  /**
914
919
  * Asynchronously returns an Application object that represents an existing application.
@@ -1089,6 +1094,7 @@ declare class ApplicationModule extends Base {
1089
1094
 
1090
1095
  /**
1091
1096
  * The complete set of options for an application.
1097
+ * @interface
1092
1098
  */
1093
1099
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1094
1100
  /**
@@ -1282,6 +1288,10 @@ declare type AppProcessInfo = {
1282
1288
  entities: EntityProcessDetails[];
1283
1289
  };
1284
1290
 
1291
+ /**
1292
+ * Generated when system app versioning is successfully completed.
1293
+ * @interface
1294
+ */
1285
1295
  declare type AppVersionCompleteEvent = {
1286
1296
  type: 'app-version-complete';
1287
1297
  } & AppVersionProgress;
@@ -1291,6 +1301,10 @@ declare type AppVersionError = {
1291
1301
  srcManifest: string;
1292
1302
  };
1293
1303
 
1304
+ /**
1305
+ * Generated when none of fallback manifests is compatible to the system.
1306
+ * @interface
1307
+ */
1294
1308
  declare type AppVersionErrorEvent = {
1295
1309
  type: 'app-version-error';
1296
1310
  } & AppVersionError;
@@ -1315,6 +1329,10 @@ declare type AppVersionProgress = {
1315
1329
  srcManifest: string;
1316
1330
  };
1317
1331
 
1332
+ /**
1333
+ * Generated during the progress of system app versioning.
1334
+ * @interface
1335
+ */
1318
1336
  declare type AppVersionProgressEvent = {
1319
1337
  type: 'app-version-progress';
1320
1338
  } & AppVersionProgress;
@@ -1328,6 +1346,10 @@ declare type AppVersionRuntimeInfo = {
1328
1346
  error: string | null;
1329
1347
  };
1330
1348
 
1349
+ /**
1350
+ * Generated when checking a runtime availability.
1351
+ * @interface
1352
+ */
1331
1353
  declare type AppVersionRuntimeStatusEvent = {
1332
1354
  type: 'runtime-status';
1333
1355
  } & AppVersionRuntimeInfo;
@@ -1341,6 +1363,7 @@ declare type AppVersionTypeFromIdEvent<T extends IdEventType> = Extract<AppVersi
1341
1363
 
1342
1364
  /**
1343
1365
  * Generated when a View is attached to a window.
1366
+ * @interface
1344
1367
  */
1345
1368
  declare type AttachedEvent = BaseViewEvent & {
1346
1369
  type: 'attached';
@@ -1413,6 +1436,7 @@ declare interface AuthorizationPayload {
1413
1436
  * }
1414
1437
  * });
1415
1438
  * ```
1439
+ * @interface
1416
1440
  */
1417
1441
  declare type AuthRequestedEvent = NamedEvent & {
1418
1442
  type: 'auth-requested';
@@ -1470,6 +1494,7 @@ declare class Base {
1470
1494
 
1471
1495
  /**
1472
1496
  * A base Channel event.
1497
+ * @interface
1473
1498
  */
1474
1499
  declare type BaseChannelEvent = NamedEvent & {
1475
1500
  channelName: string;
@@ -1536,6 +1561,7 @@ declare namespace BaseEvents {
1536
1561
 
1537
1562
  /**
1538
1563
  * The base frame event.
1564
+ * @interface
1539
1565
  */
1540
1566
  declare type BaseFrameEvent = NamedEvent & {
1541
1567
  entityType: 'iframe';
@@ -1556,6 +1582,7 @@ declare type BaseUrlEvent = NamedEvent & {
1556
1582
 
1557
1583
  /**
1558
1584
  * A base View event.
1585
+ * @interface
1559
1586
  */
1560
1587
  declare type BaseViewEvent = NamedEvent & {
1561
1588
  target: OpenFin_2.Identity;
@@ -1575,6 +1602,7 @@ declare interface BeforeUnloadUserDecision {
1575
1602
 
1576
1603
  /**
1577
1604
  * Generated at the beginning of a user-driven change to a window's size or position.
1605
+ * @interface
1578
1606
  */
1579
1607
  declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1580
1608
  type: 'begin-user-bounds-changing';
@@ -1582,6 +1610,7 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1582
1610
 
1583
1611
  /**
1584
1612
  * Generated when a WebContents loses focus.
1613
+ * @interface
1585
1614
  */
1586
1615
  declare type BlurredEvent = NamedEvent & {
1587
1616
  type: 'blurred';
@@ -1596,6 +1625,7 @@ declare type Bounds = {
1596
1625
 
1597
1626
  /**
1598
1627
  * Generated after changes in a window's size and/or position.
1628
+ * @interface
1599
1629
  */
1600
1630
  declare type BoundsChangedEvent = BoundsChangeEvent & {
1601
1631
  type: 'bounds-changed';
@@ -1603,6 +1633,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1603
1633
 
1604
1634
  /**
1605
1635
  * A general bounds change event without event type.
1636
+ * @interface
1606
1637
  */
1607
1638
  declare type BoundsChangeEvent = NamedEvent & {
1608
1639
  changeType: 0 | 1 | 2;
@@ -1615,6 +1646,7 @@ declare type BoundsChangeEvent = NamedEvent & {
1615
1646
 
1616
1647
  /**
1617
1648
  * Generated during changes to a window's size and/or position.
1649
+ * @interface
1618
1650
  */
1619
1651
  declare type BoundsChangingEvent = BoundsChangeEvent & {
1620
1652
  type: 'bounds-changing';
@@ -1657,6 +1689,7 @@ declare type Certificate = {
1657
1689
 
1658
1690
  /**
1659
1691
  * Generated when navigating to a URL that fails certificate validation.
1692
+ * @interface
1660
1693
  */
1661
1694
  declare type CertificateErrorEvent = NamedEvent & {
1662
1695
  type: 'certificate-error';
@@ -1676,6 +1709,7 @@ declare type CertificatePrincipal = {
1676
1709
 
1677
1710
  /**
1678
1711
  * Generated when the certificate selection dialog is shown.
1712
+ * @interface
1679
1713
  */
1680
1714
  declare type CertificateSelectionShownEvent = NamedEvent & {
1681
1715
  type: 'certificate-selection-shown';
@@ -1880,7 +1914,7 @@ declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
1880
1914
 
1881
1915
  declare type ChannelAction = OpenFin_2.ChannelAction;
1882
1916
 
1883
- declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_8 | ClientIdentity_2) => unknown;
1917
+ declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
1884
1918
 
1885
1919
  declare class ChannelBase {
1886
1920
  protected subscriptions: Map<string, ChannelAction>;
@@ -2159,17 +2193,17 @@ declare class ChannelBase {
2159
2193
  * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
2160
2194
  * from the provider by registering an action via {@link ChannelClient#register register}.
2161
2195
  *
2162
- * Synchronous Methods:
2196
+ * ### Synchronous Methods:
2163
2197
  * * {@link ChannelClient#onDisconnection onDisconnection(listener)}
2164
2198
  * * {@link ChannelClient#register register(action, listener)}
2165
2199
  * * {@link ChannelClient#remove remove(action)}
2166
2200
  *
2167
- * Asynchronous Methods:
2201
+ * ### Asynchronous Methods:
2168
2202
  * * {@link ChannelClient#disconnect disconnect()}
2169
2203
  * * {@link ChannelClient#dispatch dispatch(action, payload)}
2170
2204
  *
2171
- * Middleware:
2172
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
2205
+ * ### Middleware:
2206
+ * Middleware functions receive the following arguments: (action, payload, senderId).
2173
2207
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
2174
2208
  * unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
2175
2209
  * * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
@@ -2189,16 +2223,16 @@ declare class ChannelClient extends ChannelBase {
2189
2223
  * @internal
2190
2224
  * closes the corresponding channel and invokes the disconnect listener if an event payload is passed.
2191
2225
  */
2192
- static handleProviderDisconnect(eventPayload: ProviderIdentity_3): void;
2226
+ static handleProviderDisconnect(eventPayload: OpenFin_2.ProviderIdentity): void;
2193
2227
  /**
2194
2228
  * @internal
2195
2229
  */
2196
2230
  constructor(routingInfo: RoutingInfo, wire: Transport, strategy: AnyStrategy);
2197
- protected processAction: (action: string, payload: any, senderIdentity: ProviderIdentity_3 | OpenFin_2.ClientIdentity) => Promise<any>;
2231
+ protected processAction: (action: string, payload: any, senderIdentity: OpenFin_2.ProviderIdentity | OpenFin_2.ClientIdentity) => Promise<any>;
2198
2232
  /**
2199
2233
  * a read-only provider identity
2200
2234
  */
2201
- get providerIdentity(): ProviderIdentity_3;
2235
+ get providerIdentity(): OpenFin_2.ProviderIdentity;
2202
2236
  /**
2203
2237
  * Dispatch the given action to the channel provider. Returns a promise that resolves with the response from
2204
2238
  * the provider for that action.
@@ -2265,6 +2299,7 @@ declare type ChannelClient_2 = OpenFin_2.ChannelClient;
2265
2299
 
2266
2300
  /**
2267
2301
  * Generated when a Channel client is connected.
2302
+ * @interface
2268
2303
  */
2269
2304
  declare type ChannelConnectedEvent = BaseChannelEvent & {
2270
2305
  type: 'connected';
@@ -2273,6 +2308,7 @@ declare type ChannelConnectedEvent = BaseChannelEvent & {
2273
2308
  /**
2274
2309
  * Options provided on a client connection to a channel.
2275
2310
  *
2311
+ * @interface
2276
2312
  */
2277
2313
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2278
2314
  /**
@@ -2299,6 +2335,7 @@ declare type ChannelCreateOptions = {
2299
2335
 
2300
2336
  /**
2301
2337
  * Generated when a Channel client has disconnected.
2338
+ * @interface
2302
2339
  */
2303
2340
  declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2304
2341
  type: 'disconnected';
@@ -2330,27 +2367,27 @@ declare type ChannelEventType = ChannelEvent['type'];
2330
2367
 
2331
2368
  declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
2332
2369
 
2333
- declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_8 | ClientIdentity_2) => Promise<unknown> | unknown;
2370
+ declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity_2) => Promise<unknown> | unknown;
2334
2371
 
2335
2372
  /**
2336
2373
  * 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
2374
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
2338
2375
  * and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
2339
2376
  *
2340
- * Synchronous Methods:
2377
+ * ### Synchronous Methods:
2341
2378
  * * {@link ChannelProvider#onConnection onConnection(listener)}
2342
2379
  * * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
2343
2380
  * * {@link ChannelProvider#publish publish(action, payload)}
2344
2381
  * * {@link ChannelProvider#register register(action, listener)}
2345
2382
  * * {@link ChannelProvider#remove remove(action)}
2346
2383
  *
2347
- * Asynchronous Methods:
2384
+ * ### Asynchronous Methods:
2348
2385
  * * {@link ChannelProvider#destroy destroy()}
2349
2386
  * * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
2350
2387
  * * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
2351
2388
  *
2352
- * Middleware:
2353
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
2389
+ * ### Middleware:
2390
+ * Middleware functions receive the following arguments: (action, payload, senderId).
2354
2391
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
2355
2392
  * unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
2356
2393
  * * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
@@ -2372,7 +2409,7 @@ declare class ChannelProvider extends ChannelBase {
2372
2409
  /**
2373
2410
  * @internal
2374
2411
  */
2375
- constructor(providerIdentity: ProviderIdentity_7, wire: Transport, strategy: AnyStrategy);
2412
+ constructor(providerIdentity: ProviderIdentity_6, wire: Transport, strategy: AnyStrategy);
2376
2413
  /**
2377
2414
  * Dispatch an action to a specified client. Returns a promise for the result of executing that action on the client side.
2378
2415
  *
@@ -2543,6 +2580,7 @@ declare interface ChannelStrategy<T extends unknown> {
2543
2580
 
2544
2581
  /**
2545
2582
  * Generated when a child content is blocked to load.
2583
+ * @interface
2546
2584
  */
2547
2585
  declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
2548
2586
  type: 'child-content-blocked';
@@ -2550,6 +2588,7 @@ declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
2550
2588
 
2551
2589
  /**
2552
2590
  * Generated when a child content is loaded into a browser.
2591
+ * @interface
2553
2592
  */
2554
2593
  declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
2555
2594
  type: 'child-content-opened-in-browser';
@@ -2562,6 +2601,7 @@ declare interface ChildContentOptions {
2562
2601
 
2563
2602
  /**
2564
2603
  * Generated when a child View is created.
2604
+ * @interface
2565
2605
  */
2566
2606
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
2567
2607
  type: 'child-view-created';
@@ -2573,6 +2613,7 @@ declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
2573
2613
 
2574
2614
  /**
2575
2615
  * Generated when a child Window is created.
2616
+ * @interface
2576
2617
  */
2577
2618
  declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
2578
2619
  type: 'child-window-created';
@@ -2597,9 +2638,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
2597
2638
  private endpointId;
2598
2639
  private providerIdentity;
2599
2640
  constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
2600
- providerIdentity: ProviderIdentity_5);
2641
+ providerIdentity: ProviderIdentity_4);
2601
2642
  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;
2643
+ receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
2603
2644
  send: (endpointId: string, action: string, payload: any) => Promise<any>;
2604
2645
  close: () => Promise<void>;
2605
2646
  closeEndpoint(endpointId: string): Promise<void>;
@@ -2632,12 +2673,16 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
2632
2673
  data: T;
2633
2674
  };
2634
2675
 
2676
+ /**
2677
+ * @interface
2678
+ */
2635
2679
  declare type ClientConnectionPayload = ClientIdentity_2 & ClientInfo;
2636
2680
 
2637
2681
  declare type ClientIdentity = OpenFin_2.ClientIdentity;
2638
2682
 
2639
2683
  /**
2640
2684
  * Identity of a channel client
2685
+ * @interface
2641
2686
  */
2642
2687
  declare type ClientIdentity_2 = Identity_5 & {
2643
2688
  /**
@@ -2647,12 +2692,16 @@ declare type ClientIdentity_2 = Identity_5 & {
2647
2692
  isLocalEndpointId: boolean;
2648
2693
  };
2649
2694
 
2695
+ /**
2696
+ * @interface
2697
+ */
2650
2698
  declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
2651
2699
  runtimeUuid: string;
2652
2700
  };
2653
2701
 
2654
2702
  /**
2655
2703
  * Extended channel client information
2704
+ * @interface
2656
2705
  */
2657
2706
  declare type ClientInfo = Omit<ClientIdentity_2, 'isLocalEndpointId'> & {
2658
2707
  /**
@@ -2844,6 +2893,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
2844
2893
 
2845
2894
  /**
2846
2895
  * Generated when an application is closed.
2896
+ * @interface
2847
2897
  */
2848
2898
  declare type ClosedEvent = IdentityEvent & {
2849
2899
  type: 'closed';
@@ -3296,6 +3346,9 @@ declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
3296
3346
  data?: unknown;
3297
3347
  };
3298
3348
 
3349
+ /**
3350
+ * @interface
3351
+ */
3299
3352
  declare type ContentCreationRulesEvent = NamedEvent & {
3300
3353
  /**
3301
3354
  * The absolute url which triggered this event.
@@ -3354,6 +3407,9 @@ declare type Context = {
3354
3407
  type: string;
3355
3408
  };
3356
3409
 
3410
+ /**
3411
+ * @interface
3412
+ */
3357
3413
  declare type ContextForIntent<MetadataType = any> = Context & {
3358
3414
  metadata?: MetadataType;
3359
3415
  };
@@ -3456,6 +3512,7 @@ declare type CpuInfo = {
3456
3512
 
3457
3513
  /**
3458
3514
  * Generated when an application has crashed.
3515
+ * @interface
3459
3516
  */
3460
3517
  declare type CrashedEvent = NamedEvent & {
3461
3518
  type: 'crashed';
@@ -3475,6 +3532,9 @@ declare type CrashReporterOptions = {
3475
3532
  diagnosticsMode: boolean;
3476
3533
  };
3477
3534
 
3535
+ /**
3536
+ * @interface
3537
+ */
3478
3538
  declare type CrashReporterState = CrashReporterOptions & {
3479
3539
  /**
3480
3540
  * Whether the crash reporter is running
@@ -3485,6 +3545,7 @@ declare type CrashReporterState = CrashReporterOptions & {
3485
3545
 
3486
3546
  /**
3487
3547
  * Generated when a View is created.
3548
+ * @interface
3488
3549
  */
3489
3550
  declare type CreatedEvent = BaseViewEvent & {
3490
3551
  type: 'created';
@@ -3502,6 +3563,9 @@ declare type CreateViewPayload = {
3502
3563
  targetView?: Identity_5;
3503
3564
  };
3504
3565
 
3566
+ /**
3567
+ * @interface
3568
+ */
3505
3569
  declare type CreateViewTarget = Identity_5 & {
3506
3570
  /**
3507
3571
  * If specified, view creation will not attach to a window and caller must
@@ -3541,6 +3605,7 @@ declare type DefaultDomainSettingsRule = {
3541
3605
 
3542
3606
  /**
3543
3607
  * Generated when the desktop icon is clicked while it's already running.
3608
+ * @interface
3544
3609
  */
3545
3610
  declare type DesktopIconClickedEvent = BaseEvent & {
3546
3611
  type: 'desktop-icon-clicked';
@@ -3548,6 +3613,7 @@ declare type DesktopIconClickedEvent = BaseEvent & {
3548
3613
 
3549
3614
  /**
3550
3615
  * Generated when a View is destroyed.
3616
+ * @interface
3551
3617
  */
3552
3618
  declare type DestroyedEvent = BaseViewEvent & {
3553
3619
  type: 'destroyed';
@@ -3555,6 +3621,7 @@ declare type DestroyedEvent = BaseViewEvent & {
3555
3621
 
3556
3622
  /**
3557
3623
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
3624
+ * @interface
3558
3625
  */
3559
3626
  declare type DidChangeThemeColorEvent = NamedEvent & {
3560
3627
  type: 'did-change-theme-color';
@@ -3562,6 +3629,7 @@ declare type DidChangeThemeColorEvent = NamedEvent & {
3562
3629
 
3563
3630
  /**
3564
3631
  * Generated when load failed.
3632
+ * @interface
3565
3633
  */
3566
3634
  declare type DidFailLoadEvent = BaseLoadFailedEvent & {
3567
3635
  type: 'did-fail-load';
@@ -3569,11 +3637,15 @@ declare type DidFailLoadEvent = BaseLoadFailedEvent & {
3569
3637
 
3570
3638
  /**
3571
3639
  * Generated when the navigation is done, i.e. the spinner of the tab will stop spinning, and the onload event is dispatched.
3640
+ * @interface
3572
3641
  */
3573
3642
  declare type DidFinishLoadEvent = NamedEvent & {
3574
3643
  type: 'did-finish-load';
3575
3644
  };
3576
3645
 
3646
+ /**
3647
+ * @interface
3648
+ */
3577
3649
  declare type DipRect = RectangleByEdgePositions & {
3578
3650
  dipRect: RectangleByEdgePositions;
3579
3651
  scaledRect: RectangleByEdgePositions;
@@ -3586,6 +3658,7 @@ declare type DipScaleRects = {
3586
3658
 
3587
3659
  /**
3588
3660
  * Generated after a change to a window's size and/or position is attempted while window movement is disabled.
3661
+ * @interface
3589
3662
  */
3590
3663
  declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
3591
3664
  type: 'disabled-movement-bounds-changed';
@@ -3593,12 +3666,13 @@ declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
3593
3666
 
3594
3667
  /**
3595
3668
  * Generated while a change to a window's size and/or position is attempted while window movement is disabled.
3669
+ * @interface
3596
3670
  */
3597
3671
  declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
3598
3672
  type: 'disabled-movement-bounds-changing';
3599
3673
  };
3600
3674
 
3601
- declare type DisconnectionListener = (providerIdentity: ProviderIdentity_3) => any;
3675
+ declare type DisconnectionListener = (providerIdentity: OpenFin_2.ProviderIdentity) => any;
3602
3676
 
3603
3677
  declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
3604
3678
 
@@ -3669,6 +3743,7 @@ declare type Dpi = {
3669
3743
 
3670
3744
  /**
3671
3745
  * Generated when a window has been embedded.
3746
+ * @interface
3672
3747
  */
3673
3748
  declare type EmbeddedEvent = NamedEvent & {
3674
3749
  type: 'embedded';
@@ -3779,6 +3854,7 @@ declare class EmitterMap {
3779
3854
 
3780
3855
  /**
3781
3856
  * Generated when a window ends loading.
3857
+ * @interface
3782
3858
  */
3783
3859
  declare type EndLoadEvent = NamedEvent & {
3784
3860
  type: 'end-load';
@@ -3786,7 +3862,7 @@ declare type EndLoadEvent = NamedEvent & {
3786
3862
  isMain: boolean;
3787
3863
  };
3788
3864
 
3789
- declare type EndpointIdentity = OpenFin_2.ClientIdentity | ProviderIdentity_4;
3865
+ declare type EndpointIdentity = OpenFin_2.ClientIdentity | ProviderIdentity_3;
3790
3866
 
3791
3867
  declare type EndpointPayload = {
3792
3868
  endpointIdentity: EndpointIdentity;
@@ -3794,6 +3870,7 @@ declare type EndpointPayload = {
3794
3870
 
3795
3871
  /**
3796
3872
  * Generated at the end of a user-driven change to a window's size or position.
3873
+ * @interface
3797
3874
  */
3798
3875
  declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
3799
3876
  type: 'end-user-bounds-changing';
@@ -3809,6 +3886,9 @@ declare type EntityInfo_2 = {
3809
3886
  entityType: EntityType;
3810
3887
  };
3811
3888
 
3889
+ /**
3890
+ * @interface
3891
+ */
3812
3892
  declare type EntityProcessDetails = FrameProcessDetails & {
3813
3893
  name: string;
3814
3894
  uuid: string;
@@ -3878,7 +3958,7 @@ declare interface Environment {
3878
3958
 
3879
3959
  declare type ErrorMiddleware = OpenFin_2.ErrorMiddleware;
3880
3960
 
3881
- declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_8 | ClientIdentity_2) => unknown;
3961
+ declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
3882
3962
 
3883
3963
  /**
3884
3964
  * This function converts JS errors into plain objects
@@ -3936,7 +4016,7 @@ declare type ExitCode = {
3936
4016
  /**
3937
4017
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
3938
4018
  * 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>
4019
+ * Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
3940
4020
  *
3941
4021
  * Processes that can be wrapped as `ExternalApplication`s include the following:
3942
4022
  * - Processes which have connected to an OpenFin runtime via an adapter
@@ -4043,6 +4123,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
4043
4123
 
4044
4124
  /**
4045
4125
  * Generated when an external application has authenticated and is connected.
4126
+ * @interface
4046
4127
  */
4047
4128
  declare type ExternalApplicationConnectedEvent = BaseEvent & {
4048
4129
  type: 'connected';
@@ -4050,6 +4131,7 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
4050
4131
 
4051
4132
  /**
4052
4133
  * Generated when an external application has disconnected.
4134
+ * @interface
4053
4135
  */
4054
4136
  declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
4055
4137
  type: 'disconnected';
@@ -4076,6 +4158,9 @@ declare type ExternalApplicationInfo = {
4076
4158
  parent: Identity_5;
4077
4159
  };
4078
4160
 
4161
+ /**
4162
+ * Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
4163
+ */
4079
4164
  declare class ExternalApplicationModule extends Base {
4080
4165
  /**
4081
4166
  * Asynchronously returns an External Application object that represents an external application.
@@ -4120,6 +4205,7 @@ declare type ExternalConnection = {
4120
4205
 
4121
4206
  /**
4122
4207
  * Generated when an external process has exited.
4208
+ * @interface
4123
4209
  */
4124
4210
  declare type ExternalProcessExitedEvent = NamedEvent & {
4125
4211
  type: 'external-process-exited';
@@ -4158,6 +4244,7 @@ declare type ExternalProcessRequestType = {
4158
4244
 
4159
4245
  /**
4160
4246
  * Generated when an external process has started.
4247
+ * @interface
4161
4248
  */
4162
4249
  declare type ExternalProcessStartedEvent = NamedEvent & {
4163
4250
  type: 'external-process-started';
@@ -4166,6 +4253,7 @@ declare type ExternalProcessStartedEvent = NamedEvent & {
4166
4253
 
4167
4254
  /**
4168
4255
  * Generated when page receives favicon urls.
4256
+ * @interface
4169
4257
  */
4170
4258
  declare type FaviconUpdatedEvent = NamedEvent & {
4171
4259
  type: 'page-favicon-updated';
@@ -4183,6 +4271,7 @@ declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
4183
4271
 
4184
4272
  /**
4185
4273
  * Generated when a file download has completed.
4274
+ * @interface
4186
4275
  */
4187
4276
  declare type FileDownloadCompletedEvent = FileDownloadEvent & {
4188
4277
  type: 'file-download-completed';
@@ -4191,6 +4280,7 @@ declare type FileDownloadCompletedEvent = FileDownloadEvent & {
4191
4280
 
4192
4281
  /**
4193
4282
  * A general file download event without event type.
4283
+ * @interface
4194
4284
  */
4195
4285
  declare type FileDownloadEvent = {
4196
4286
  /**
@@ -4242,6 +4332,8 @@ declare type FileDownloadEvent = {
4242
4332
  /**
4243
4333
  * Generated when setFileDownloadLocation api is called.
4244
4334
  * @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'.
4335
+ *
4336
+ * @interface
4245
4337
  */
4246
4338
  declare type FileDownloadLocationChangedEvent = NamedEvent & {
4247
4339
  type: 'file-download-location-changed';
@@ -4249,6 +4341,7 @@ declare type FileDownloadLocationChangedEvent = NamedEvent & {
4249
4341
 
4250
4342
  /**
4251
4343
  * Generated during file download progress.
4344
+ * @interface
4252
4345
  */
4253
4346
  declare type FileDownloadProgressEvent = FileDownloadEvent & {
4254
4347
  type: 'file-download-progress';
@@ -4261,6 +4354,7 @@ declare type FileDownloadSettings = {
4261
4354
 
4262
4355
  /**
4263
4356
  * Generated when a file download has started.
4357
+ * @interface
4264
4358
  */
4265
4359
  declare type FileDownloadStartedEvent = FileDownloadEvent & {
4266
4360
  type: 'file-download-started';
@@ -4348,6 +4442,7 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
4348
4442
 
4349
4443
  /**
4350
4444
  * Generated when a WebContents gains focus.
4445
+ * @interface
4351
4446
  */
4352
4447
  declare type FocusedEvent = NamedEvent & {
4353
4448
  type: 'focused';
@@ -4355,6 +4450,7 @@ declare type FocusedEvent = NamedEvent & {
4355
4450
 
4356
4451
  /**
4357
4452
  * Generated when a result is available when calling findInPage.
4453
+ * @interface
4358
4454
  */
4359
4455
  declare type FoundInPageEvent = NamedEvent & {
4360
4456
  type: 'found-in-page';
@@ -4496,6 +4592,7 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
4496
4592
 
4497
4593
  /**
4498
4594
  * Generated when a frame is connected.
4595
+ * @interface
4499
4596
  */
4500
4597
  declare type FrameConnectedEvent = BaseFrameEvent & {
4501
4598
  type: 'connected';
@@ -4503,6 +4600,7 @@ declare type FrameConnectedEvent = BaseFrameEvent & {
4503
4600
 
4504
4601
  /**
4505
4602
  * Generated when a frame has disconnected.
4603
+ * @interface
4506
4604
  */
4507
4605
  declare type FrameDisconnectedEvent = BaseFrameEvent & {
4508
4606
  type: 'disconnected';
@@ -4540,6 +4638,9 @@ declare type FrameInfo = {
4540
4638
  parent: Identity_5;
4541
4639
  };
4542
4640
 
4641
+ /**
4642
+ * Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
4643
+ */
4543
4644
  declare class _FrameModule extends Base {
4544
4645
  /**
4545
4646
  * Asynchronously returns a reference to the specified frame. The frame does not have to exist
@@ -4589,6 +4690,9 @@ declare class _FrameModule extends Base {
4589
4690
  getCurrentSync(): OpenFin_2.Frame;
4590
4691
  }
4591
4692
 
4693
+ /**
4694
+ * @interface
4695
+ */
4592
4696
  declare type FrameProcessDetails = ProcessDetails & {
4593
4697
  /**
4594
4698
  * Current URL associated with the process.
@@ -4756,18 +4860,11 @@ declare type GpuInfo = {
4756
4860
  name: string;
4757
4861
  };
4758
4862
 
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
4863
  /**
4768
4864
  * Generated when a View is hidden.
4865
+ * @interface
4769
4866
  */
4770
- declare type HiddenEvent_2 = BaseViewEvent & {
4867
+ declare type HiddenEvent = BaseViewEvent & {
4771
4868
  type: 'hidden';
4772
4869
  };
4773
4870
 
@@ -4834,6 +4931,7 @@ declare type Hotkey = {
4834
4931
  /**
4835
4932
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [View options](OpenFin.ViewOptions.html) is pressed inside the view.
4836
4933
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
4934
+ * @interface
4837
4935
  */
4838
4936
  declare type HotkeyEvent = BaseViewEvent & {
4839
4937
  type: 'hotkey';
@@ -4868,6 +4966,7 @@ declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<Add
4868
4966
 
4869
4967
  /**
4870
4968
  * An Identity event.
4969
+ * @interface
4871
4970
  */
4872
4971
  declare type IdentityEvent = BaseEvent & {
4873
4972
  uuid: string;
@@ -4883,6 +4982,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
4883
4982
  * @remarks This method is continuously generated every minute while the user is in idle.
4884
4983
  * A user enters idle state when the computer is locked or when there has been no keyboard/mouse activity for 1 minute.
4885
4984
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
4985
+ * @interface
4886
4986
  */
4887
4987
  declare type IdleEvent = {
4888
4988
  type: 'idle-state-changed';
@@ -4911,6 +5011,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
4911
5011
 
4912
5012
  /**
4913
5013
  * Generated when an application has initialized.
5014
+ * @interface
4914
5015
  */
4915
5016
  declare type InitializedEvent = IdentityEvent & {
4916
5017
  type: 'initialized';
@@ -4941,6 +5042,7 @@ declare type InitPlatformOptions = {
4941
5042
 
4942
5043
  /**
4943
5044
  * Generated when the value of the element changes.
5045
+ * @interface
4944
5046
  */
4945
5047
  declare type InputEvent_2 = {
4946
5048
  inputType: 'keyUp' | 'keyDown';
@@ -6481,6 +6583,138 @@ declare type LaunchIntoPlatformPayload = {
6481
6583
  manifest: any;
6482
6584
  };
6483
6585
 
6586
+ /**
6587
+ *
6588
+ * Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
6589
+ * enables the initialization and manipulation of a window's Layout. A Layout will
6590
+ * emit events locally on the DOM element representing the layout-container.
6591
+ *
6592
+ *
6593
+ * ### Layout.DOMEvents
6594
+ *
6595
+ * When a Layout is created, it emits events onto the DOM element representing the Layout container.
6596
+ * This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
6597
+ * 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).
6598
+ * The events are emitted synchronously and only in the process where the Layout exists.
6599
+ * Any values returned by the called listeners are ignored and will be discarded.
6600
+ * If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
6601
+ *
6602
+ * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
6603
+ *
6604
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
6605
+ * Adds a listener to the end of the listeners array for the specified event.
6606
+ * @example
6607
+ * ```js
6608
+ * const myLayoutContainer = document.getElementById('layout-container');
6609
+ *
6610
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
6611
+ * const { tabSelector } = event.detail;
6612
+ * const tabElement = document.getElementById(tabSelector);
6613
+ * const existingColor = tabElement.style.backgroundColor;
6614
+ * tabElement.style.backgroundColor = "red";
6615
+ * setTimeout(() => {
6616
+ * tabElement.style.backgroundColor = existingColor;
6617
+ * }, 2000);
6618
+ * });
6619
+ * ```
6620
+ *
6621
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
6622
+ * Adds a listener to the end of the listeners array for the specified event.
6623
+ * @example
6624
+ * ```js
6625
+ * const myLayoutContainer = document.getElementById('layout-container');
6626
+ *
6627
+ * const listener = function(event) {
6628
+ * console.log(event.detail);
6629
+ * console.log('container-created event fired once, removing listener');
6630
+ * myLayoutContainer.removeEventListener('container-created', listener);
6631
+ * };
6632
+ *
6633
+ * myLayoutContainer.addEventListener('container-created', listener);
6634
+ * ```
6635
+ *
6636
+ * ### Supported event types are:
6637
+ *
6638
+ * * tab-created
6639
+ * * container-created
6640
+ * * layout-state-changed
6641
+ * * tab-closed
6642
+ * * tab-dropped
6643
+ *
6644
+ * ### Layout DOM Node Events
6645
+ *
6646
+ * #### tab-created
6647
+ * 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.
6648
+ * ```js
6649
+ * // The response has the following shape in event.detail:
6650
+ * {
6651
+ * containerSelector: "container-component_A",
6652
+ * name: "component_A",
6653
+ * tabSelector: "tab-component_A",
6654
+ * topic: "openfin-DOM-event",
6655
+ * type: "tab-created",
6656
+ * uuid: "OpenFin POC"
6657
+ * }
6658
+ * ```
6659
+ *
6660
+ * #### container-created
6661
+ * 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.
6662
+ * ```js
6663
+ * // The response has the following shape in event.detail:
6664
+ * {
6665
+ * containerSelector: "container-component_A",
6666
+ * name: "component_A",
6667
+ * tabSelector: "tab-component_A",
6668
+ * topic: "openfin-DOM-event",
6669
+ * type: "container-created",
6670
+ * uuid: "OpenFin POC"
6671
+ * }
6672
+ * ```
6673
+ *
6674
+ * ### layout-state-changed
6675
+ * 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.
6676
+ * ```js
6677
+ * // The response has the following shape in event.detail
6678
+ * {
6679
+ * containerSelector: "container-component_A",
6680
+ * name: "component_A",
6681
+ * tabSelector: "tab-component_A",
6682
+ * topic: "openfin-DOM-event",
6683
+ * type: "layout-state-changed",
6684
+ * uuid: "OpenFin POC"
6685
+ * }
6686
+ * ```
6687
+ *
6688
+ * #### tab-closed
6689
+ * Generated when a tab is closed.
6690
+ * ```js
6691
+ * // The response has the following shape in event.detail:
6692
+ * {
6693
+ * containerSelector: "container-component_A",
6694
+ * name: "component_A",
6695
+ * tabSelector: "tab-component_A",
6696
+ * topic: "openfin-DOM-event",
6697
+ * type: "tab-closed",
6698
+ * uuid: "OpenFin POC",
6699
+ * url: "http://openfin.co" // The url of the view that was closed.
6700
+ * }
6701
+ * ```
6702
+ *
6703
+ * #### tab-dropped
6704
+ * Generated when a tab is dropped.
6705
+ * ```js
6706
+ * // The response has the following shape in event.detail:
6707
+ * {
6708
+ * containerSelector: "container-component_A",
6709
+ * name: "component_A",
6710
+ * tabSelector: "tab-component_A",
6711
+ * topic: "openfin-DOM-event",
6712
+ * type: "tab-dropped",
6713
+ * uuid: "OpenFin POC",
6714
+ * url: "http://openfin.co" // The url of the view linked to the dropped tab.
6715
+ * }
6716
+ * ```
6717
+ */
6484
6718
  declare class Layout extends Base {
6485
6719
  #private;
6486
6720
  /**
@@ -6781,6 +7015,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
6781
7015
 
6782
7016
  /**
6783
7017
  * Generated when a window and all of its layout's views have either finished or failed navigation.
7018
+ * @interface
6784
7019
  */
6785
7020
  declare type LayoutInitializedEvent = NamedEvent & {
6786
7021
  type: 'layout-initialized';
@@ -6902,6 +7137,9 @@ declare class LayoutManager {
6902
7137
  private setComponentState;
6903
7138
  }
6904
7139
 
7140
+ /**
7141
+ * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
7142
+ */
6905
7143
  declare class LayoutModule extends Base {
6906
7144
  #private;
6907
7145
  /**
@@ -7255,6 +7493,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
7255
7493
 
7256
7494
  /**
7257
7495
  * Generated when a window and all of its layout's views have been created and can receive API calls.
7496
+ * @interface
7258
7497
  */
7259
7498
  declare type LayoutReadyEvent = NamedEvent & {
7260
7499
  type: 'layout-ready';
@@ -7362,6 +7601,7 @@ declare type Manifest = {
7362
7601
 
7363
7602
  /**
7364
7603
  * Generated when the RVM notifies an application that the manifest has changed.
7604
+ * @interface
7365
7605
  */
7366
7606
  declare type ManifestChangedEvent = IdentityEvent & {
7367
7607
  type: 'manifest-changed';
@@ -7405,6 +7645,7 @@ declare type MatchPattern = string;
7405
7645
 
7406
7646
  /**
7407
7647
  * Generated when a window is maximized.
7648
+ * @interface
7408
7649
  */
7409
7650
  declare type MaximizedEvent = NamedEvent & {
7410
7651
  type: 'maximized';
@@ -7477,6 +7718,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
7477
7718
 
7478
7719
  /**
7479
7720
  * Generated when a window is minimized.
7721
+ * @interface
7480
7722
  */
7481
7723
  declare type MinimizedEvent = NamedEvent & {
7482
7724
  type: 'minimized';
@@ -7522,6 +7764,7 @@ declare type MonitorDetails = {
7522
7764
  * Generated on changes of a monitor's size/location.
7523
7765
  * @remarks A monitor's size changes when the taskbar is resized or relocated.
7524
7766
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
7767
+ * @interface
7525
7768
  */
7526
7769
  declare type MonitorEvent = OpenFin_2.MonitorInfo & {
7527
7770
  type: 'monitor-info-changed';
@@ -7877,6 +8120,7 @@ declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => v
7877
8120
 
7878
8121
  /**
7879
8122
  * A Name event.
8123
+ * @interface
7880
8124
  */
7881
8125
  declare type NamedEvent = IdentityEvent & {
7882
8126
  name: string;
@@ -7888,6 +8132,7 @@ declare type NativeWindowIntegrationProviderAuthorization = {
7888
8132
 
7889
8133
  /**
7890
8134
  * Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
8135
+ * @interface
7891
8136
  */
7892
8137
  declare type NavigationRejectedEvent = NamedEvent & {
7893
8138
  type: 'navigation-rejected';
@@ -7908,6 +8153,9 @@ declare type NavigationRules = {
7908
8153
 
7909
8154
  declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
7910
8155
 
8156
+ /**
8157
+ * @interface
8158
+ */
7911
8159
  declare type NonAppProcessDetails = ProcessDetails & {
7912
8160
  name: string;
7913
8161
  };
@@ -7934,6 +8182,7 @@ declare type NotRequested<EventType> = EventType extends `${infer U}-requested`
7934
8182
 
7935
8183
  /**
7936
8184
  * Generated when an application is not responding.
8185
+ * @interface
7937
8186
  */
7938
8187
  declare type NotRespondingEvent = IdentityEvent & {
7939
8188
  type: 'not-responding';
@@ -7941,6 +8190,9 @@ declare type NotRespondingEvent = IdentityEvent & {
7941
8190
 
7942
8191
  declare type OnlyIfCompatible<A, B, D = OverlapsOnlyIfMatching<A, B>> = D extends Record<any, never> ? keyof D extends never ? A | B : never : A | B;
7943
8192
 
8193
+ /**
8194
+ * @interface
8195
+ */
7944
8196
  declare type Opacity = TransitionBase & {
7945
8197
  /**
7946
8198
  * The opacity from 0.0 (transparent) to 1.0 (normal).
@@ -8175,7 +8427,7 @@ declare namespace OpenFin_2 {
8175
8427
  ContextForIntent,
8176
8428
  InfoForIntentOptions,
8177
8429
  FindIntentsByContextOptions,
8178
- ProviderIdentity_8 as ProviderIdentity,
8430
+ ProviderIdentity_7 as ProviderIdentity,
8179
8431
  RegisterUsageData,
8180
8432
  ViewsPreventingUnloadPayload,
8181
8433
  BeforeUnloadUserDecision,
@@ -8247,7 +8499,8 @@ declare namespace OpenFin_2 {
8247
8499
  InteropLoggingOptions,
8248
8500
  Me,
8249
8501
  CapturePageOptions,
8250
- ProcessLoggingOptions
8502
+ ProcessLoggingOptions,
8503
+ PositioningOptions
8251
8504
  }
8252
8505
  }
8253
8506
  export default OpenFin_2;
@@ -8263,6 +8516,7 @@ declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T>
8263
8516
  /**
8264
8517
  * Generated when page title is set during navigation.
8265
8518
  * @remarks explicitSet is false when title is synthesized from file url.
8519
+ * @interface
8266
8520
  */
8267
8521
  declare type PageTitleUpdatedEvent = NamedEvent & {
8268
8522
  type: 'page-title-updated';
@@ -8280,6 +8534,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
8280
8534
 
8281
8535
  /**
8282
8536
  * Generated when window finishes loading. Provides performance and navigation data.
8537
+ * @interface
8283
8538
  */
8284
8539
  declare type PerformanceReportEvent = Performance & NamedEvent & {
8285
8540
  type: 'performance-report';
@@ -8948,6 +9203,7 @@ declare type Platform_2 = OpenFin_2.Platform;
8948
9203
 
8949
9204
  /**
8950
9205
  * Generated when a new Platform's API becomes responsive.
9206
+ * @interface
8951
9207
  */
8952
9208
  declare type PlatformApiReadyEvent = BaseEvent & {
8953
9209
  topic: 'application';
@@ -8969,6 +9225,9 @@ declare namespace PlatformEvents {
8969
9225
  }
8970
9226
  }
8971
9227
 
9228
+ /**
9229
+ * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
9230
+ */
8972
9231
  declare class PlatformModule extends Base {
8973
9232
  private _channel;
8974
9233
  Layout: LayoutModule;
@@ -9128,6 +9387,7 @@ declare class PlatformModule extends Base {
9128
9387
  /**
9129
9388
  * The options object required by {@link Platform.PlatformModule#start Platform.start}
9130
9389
  * Any {@link ApplicationOptions Application option} is also a valid platform option
9390
+ * @interface
9131
9391
  */
9132
9392
  declare type PlatformOptions = ApplicationCreationOptions & {
9133
9393
  /**
@@ -9672,6 +9932,7 @@ declare interface PlatformProvider {
9672
9932
  * 3. If a window has a layout property, the 'layout-ready' event has fired
9673
9933
  *
9674
9934
  * _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.
9935
+ * @interface
9675
9936
  */
9676
9937
  declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9677
9938
  topic: 'application';
@@ -9680,6 +9941,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
9680
9941
 
9681
9942
  declare type PlatformViewCreationOptions = Partial<ViewOptions>;
9682
9943
 
9944
+ /**
9945
+ * @interface
9946
+ */
9683
9947
  declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
9684
9948
  updateStateIfExists?: boolean;
9685
9949
  reason?: WindowCreationReason;
@@ -9690,6 +9954,7 @@ declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
9690
9954
  * Any {@link OpenFin.WindowCreationOptions Window option} is also a valid Default Window option
9691
9955
  * used by default in any window that is created in the current platform's scope.
9692
9956
  * Individual window options will override these defaults.
9957
+ * @interface
9693
9958
  */
9694
9959
  declare type PlatformWindowOptions = WindowCreationOptions & {
9695
9960
  /**
@@ -9757,6 +10022,9 @@ declare interface PopupResult<T = any> {
9757
10022
 
9758
10023
  declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
9759
10024
 
10025
+ /**
10026
+ * @interface
10027
+ */
9760
10028
  declare type Position = TransitionBase & {
9761
10029
  /**
9762
10030
  * Defaults to the window's current left position in virtual screen coordinates.
@@ -9768,6 +10036,26 @@ declare type Position = TransitionBase & {
9768
10036
  top: number;
9769
10037
  };
9770
10038
 
10039
+ /**
10040
+ * Leveraged by the following windowing apis to influence side effects of the positioning.
10041
+ * - {@link OpenFin.Window.moveBy}
10042
+ * - {@link OpenFin.Window.moveTo}
10043
+ * - {@link OpenFin.Window.setBounds}
10044
+ * - {@link OpenFin.Window.resizeBy}
10045
+ * - {@link OpenFin.Window.resizeTo}
10046
+ * @example ```js
10047
+ fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
10048
+ ```
10049
+ */
10050
+ declare interface PositioningOptions {
10051
+ /**
10052
+ * Windows Only.
10053
+ * If set to true, will not restore a maximized window before setting the bounds.
10054
+ * This will have the effect of the maximized window staying maximized and not immediately taking this new position.
10055
+ */
10056
+ skipRestore?: boolean;
10057
+ }
10058
+
9771
10059
  /**
9772
10060
  * Context menu item with an implementation provided by OpenFin.
9773
10061
  */
@@ -9810,6 +10098,7 @@ declare type PreloadScriptInfoRunning = {
9810
10098
  /**
9811
10099
  * Generated after the execution of all of a window's preload scripts.
9812
10100
  * @remarks Contains information about all window's preload scripts' final states.
10101
+ * @interface
9813
10102
  */
9814
10103
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
9815
10104
  type: 'preload-script-state-changed';
@@ -9817,6 +10106,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
9817
10106
 
9818
10107
  /**
9819
10108
  * A general preload scripts state change event without event type.
10109
+ * @interface
9820
10110
  */
9821
10111
  declare type PreloadScriptsStateChangeEvent = NamedEvent & {
9822
10112
  preloadScripts: (PreloadScriptInfoRunning & any)[];
@@ -9825,6 +10115,7 @@ declare type PreloadScriptsStateChangeEvent = NamedEvent & {
9825
10115
  /**
9826
10116
  * Generated during the execution of a window's preload script.
9827
10117
  * @remarks Contains information about a single window's preload script's state, for which the event has been raised.
10118
+ * @interface
9828
10119
  */
9829
10120
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
9830
10121
  type: 'preload-script-state-changing';
@@ -10207,6 +10498,25 @@ declare interface ProtocolMap extends ProtocolMapBase {
10207
10498
  'set-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity & {
10208
10499
  domainSettings: OpenFin_2.DefaultDomainSettings;
10209
10500
  }, void>;
10501
+ 'move-window-by': IdentityCall<WithPositioningOptions<{
10502
+ deltaLeft: number;
10503
+ deltaTop: number;
10504
+ }>>;
10505
+ 'move-window': IdentityCall<WithPositioningOptions<{
10506
+ left: number;
10507
+ top: number;
10508
+ }>>;
10509
+ 'resize-window-by': IdentityCall<WithPositioningOptions<{
10510
+ deltaWidth: number;
10511
+ deltaHeight: number;
10512
+ anchor: OpenFin_2.AnchorType;
10513
+ }>>;
10514
+ 'resize-window': IdentityCall<WithPositioningOptions<{
10515
+ width: number;
10516
+ height: number;
10517
+ anchor: OpenFin_2.AnchorType;
10518
+ }>>;
10519
+ 'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
10210
10520
  }
10211
10521
 
10212
10522
  declare interface ProtocolMapBase {
@@ -10238,12 +10548,11 @@ declare type ProviderIdentity_5 = OpenFin_2.ProviderIdentity;
10238
10548
 
10239
10549
  declare type ProviderIdentity_6 = OpenFin_2.ProviderIdentity;
10240
10550
 
10241
- declare type ProviderIdentity_7 = OpenFin_2.ProviderIdentity;
10242
-
10243
10551
  /**
10244
10552
  * Identity of a channel provider.
10553
+ * @interface
10245
10554
  */
10246
- declare type ProviderIdentity_8 = Identity_5 & {
10555
+ declare type ProviderIdentity_7 = Identity_5 & {
10247
10556
  /**
10248
10557
  * Identifier of the channel.
10249
10558
  */
@@ -10310,6 +10619,9 @@ declare type QueryPermissionResult = {
10310
10619
  rawValue?: unknown;
10311
10620
  };
10312
10621
 
10622
+ /**
10623
+ * @interface
10624
+ */
10313
10625
  declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
10314
10626
 
10315
10627
  /**
@@ -10345,6 +10657,7 @@ declare type RectangleByEdgePositions = {
10345
10657
 
10346
10658
  /**
10347
10659
  * Generated when a hotkey has been registered with the operating system.
10660
+ * @interface
10348
10661
  */
10349
10662
  declare type RegisteredEvent = BaseEvent & {
10350
10663
  type: 'registered';
@@ -10367,6 +10680,7 @@ declare type RegistryInfo_2 = {
10367
10680
 
10368
10681
  /**
10369
10682
  * Generated when a window has been reloaded.
10683
+ * @interface
10370
10684
  */
10371
10685
  declare type ReloadedEvent = NamedEvent & {
10372
10686
  type: 'reloaded';
@@ -10452,6 +10766,7 @@ declare type ResizeRegion = {
10452
10766
 
10453
10767
  /**
10454
10768
  * Generated when an HTTP load was cancelled or failed.
10769
+ * @interface
10455
10770
  */
10456
10771
  declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
10457
10772
  type: 'resource-load-failed';
@@ -10459,6 +10774,7 @@ declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
10459
10774
 
10460
10775
  /**
10461
10776
  * Generated when an HTTP resource request has received response details.
10777
+ * @interface
10462
10778
  */
10463
10779
  declare type ResourceResponseReceivedEvent = NamedEvent & {
10464
10780
  type: 'resource-response-received';
@@ -10474,6 +10790,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
10474
10790
 
10475
10791
  /**
10476
10792
  * Generated when an application is responding.
10793
+ * @interface
10477
10794
  */
10478
10795
  declare type RespondingEvent = IdentityEvent & {
10479
10796
  type: 'responding';
@@ -10487,7 +10804,10 @@ declare type RGB = {
10487
10804
  green: number;
10488
10805
  };
10489
10806
 
10490
- declare type RoutingInfo = ProviderIdentity_3 & {
10807
+ /**
10808
+ * @interface
10809
+ */
10810
+ declare type RoutingInfo = OpenFin_2.ProviderIdentity & {
10491
10811
  endpointId: string;
10492
10812
  };
10493
10813
 
@@ -10513,7 +10833,7 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
10513
10833
  declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload> {
10514
10834
  #private;
10515
10835
  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;
10836
+ receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
10517
10837
  send: (endpointId: string, action: string, payload: any) => Promise<any>;
10518
10838
  close: () => Promise<void>;
10519
10839
  private getEndpointById;
@@ -10525,7 +10845,7 @@ declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload>
10525
10845
  }
10526
10846
 
10527
10847
  declare interface RTCStrategyEndpointPayload {
10528
- endpointIdentity: OpenFin_2.ClientIdentity | ProviderIdentity_6;
10848
+ endpointIdentity: OpenFin_2.ClientIdentity | ProviderIdentity_5;
10529
10849
  rtc: RTCPacket;
10530
10850
  }
10531
10851
 
@@ -10533,6 +10853,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
10533
10853
 
10534
10854
  /**
10535
10855
  * Generated when Application.run() is called for an already running application.
10856
+ * @interface
10536
10857
  */
10537
10858
  declare type RunRequestedEvent_2 = IdentityEvent & {
10538
10859
  type: 'run-requested';
@@ -10684,6 +11005,7 @@ declare type ServiceIdentifier = {
10684
11005
 
10685
11006
  /**
10686
11007
  * Generated on changes to a user’s local computer session.
11008
+ * @interface
10687
11009
  */
10688
11010
  declare type SessionChangedEvent = {
10689
11011
  type: 'session-changed';
@@ -10734,12 +11056,16 @@ declare type ShortCutConfig = {
10734
11056
  systemStartup?: boolean;
10735
11057
  };
10736
11058
 
11059
+ /**
11060
+ * @interface
11061
+ */
10737
11062
  declare type ShortcutOverride = Hotkey & {
10738
11063
  command: string;
10739
11064
  };
10740
11065
 
10741
11066
  /**
10742
11067
  * Generated when a View is shown. This event will fire during creation of a View.
11068
+ * @interface
10743
11069
  */
10744
11070
  declare type ShownEvent = BaseViewEvent & {
10745
11071
  type: 'shown';
@@ -10753,6 +11079,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
10753
11079
 
10754
11080
  /**
10755
11081
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
11082
+ * @interface
10756
11083
  */
10757
11084
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
10758
11085
  /**
@@ -10769,6 +11096,9 @@ declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
10769
11096
  paintIntervalMs?: number;
10770
11097
  };
10771
11098
 
11099
+ /**
11100
+ * @interface
11101
+ */
10772
11102
  declare type Size = TransitionBase & {
10773
11103
  /**
10774
11104
  * Optional if height is present. Defaults to the window's current width.
@@ -10848,6 +11178,9 @@ declare class SnapshotSource<T = any> extends Base {
10848
11178
  applySnapshot(snapshot: T): Promise<void>;
10849
11179
  }
10850
11180
 
11181
+ /**
11182
+ * Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
11183
+ */
10851
11184
  declare class SnapshotSourceModule extends Base {
10852
11185
  /**
10853
11186
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
@@ -10926,6 +11259,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
10926
11259
 
10927
11260
  /**
10928
11261
  * Generated when an application has started.
11262
+ * @interface
10929
11263
  */
10930
11264
  declare type StartedEvent = IdentityEvent & {
10931
11265
  type: 'started';
@@ -12714,12 +13048,16 @@ declare type TargetApp = string | AppMetadata;
12714
13048
  * Generated when a View changes its window target.
12715
13049
  * @remarks This event will fire during creation of a View.
12716
13050
  * In that case, previousTarget identity will be the same as target identity.
13051
+ * @interface
12717
13052
  */
12718
13053
  declare type TargetChangedEvent = BaseViewEvent & {
12719
13054
  type: 'target-changed';
12720
13055
  previousTarget: OpenFin_2.Identity;
12721
13056
  };
12722
13057
 
13058
+ /**
13059
+ * @interface
13060
+ */
12723
13061
  declare type TaskBar = DipScaleRects & {
12724
13062
  /**
12725
13063
  * Which edge of a monitor the taskbar is on
@@ -12842,6 +13180,7 @@ declare class Transport<MeType extends EntityType_3 = EntityType_3> extends Even
12842
13180
 
12843
13181
  /**
12844
13182
  * Generated when the tray icon is clicked.
13183
+ * @interface
12845
13184
  */
12846
13185
  declare type TrayIconClickedEvent = IdentityEvent & {
12847
13186
  type: 'tray-icon-clicked';
@@ -12893,6 +13232,7 @@ declare interface TypedEventEmitter<Event extends {
12893
13232
 
12894
13233
  /**
12895
13234
  * Generated when a hotkey has been unregistered with the operating system.
13235
+ * @interface
12896
13236
  */
12897
13237
  declare type UnregisteredEvent = BaseEvent & {
12898
13238
  type: 'unregistered';
@@ -12909,6 +13249,7 @@ declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
12909
13249
  * Generated when navigation or redirect is completed.
12910
13250
  * @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
13251
  * 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).
13252
+ * @interface
12912
13253
  */
12913
13254
  declare type UrlChangedEvent = BaseUrlEvent & ({
12914
13255
  isInPage: true;
@@ -12920,6 +13261,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
12920
13261
 
12921
13262
  /**
12922
13263
  * A general user bounds change event without event type.
13264
+ * @interface
12923
13265
  */
12924
13266
  declare type UserBoundsChangeEvent = NamedEvent & {
12925
13267
  height: number;
@@ -12931,6 +13273,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
12931
13273
 
12932
13274
  /**
12933
13275
  * Generated when a window's user movement becomes disabled.
13276
+ * @interface
12934
13277
  */
12935
13278
  declare type UserMovementDisabledEvent = NamedEvent & {
12936
13279
  type: 'user-movement-disabled';
@@ -12938,6 +13281,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
12938
13281
 
12939
13282
  /**
12940
13283
  * Generated when a window's user movement becomes enabled.
13284
+ * @interface
12941
13285
  */
12942
13286
  declare type UserMovementEnabledEvent = NamedEvent & {
12943
13287
  type: 'user-movement-enabled';
@@ -13547,6 +13891,7 @@ declare interface ViewComponent extends GoldenLayout.ContentItem {
13547
13891
  *
13548
13892
  * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
13549
13893
  * (defaults to `"about:blank"` when omitted).
13894
+ * @interface
13550
13895
  */
13551
13896
  declare type ViewCreationOptions = Partial<ViewOptions> & {
13552
13897
  name: string;
@@ -13559,6 +13904,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
13559
13904
  /**
13560
13905
  * Generated when a window has a view detached from it.
13561
13906
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
13907
+ * @interface
13562
13908
  */
13563
13909
  declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
13564
13910
  type: 'view-detached';
@@ -13582,7 +13928,7 @@ declare namespace ViewEvents {
13582
13928
  AttachedEvent,
13583
13929
  CreatedEvent,
13584
13930
  DestroyedEvent,
13585
- HiddenEvent_2 as HiddenEvent,
13931
+ HiddenEvent,
13586
13932
  HotkeyEvent,
13587
13933
  ShownEvent,
13588
13934
  WillPropagateViewEvent,
@@ -13607,6 +13953,9 @@ declare type ViewInfo = {
13607
13953
  favicons: string[];
13608
13954
  };
13609
13955
 
13956
+ /**
13957
+ * Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
13958
+ */
13610
13959
  declare class ViewModule extends Base {
13611
13960
  /**
13612
13961
  * Creates a new View.
@@ -13689,6 +14038,7 @@ declare class ViewModule extends Base {
13689
14038
 
13690
14039
  /**
13691
14040
  * User-facing options for a view.
14041
+ * @interface
13692
14042
  */
13693
14043
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
13694
14044
 
@@ -13749,6 +14099,9 @@ declare interface ViewsPreventingUnloadPayload {
13749
14099
  closeType: 'view' | 'window';
13750
14100
  }
13751
14101
 
14102
+ /**
14103
+ * @interface
14104
+ */
13752
14105
  declare type ViewState = ViewCreationOptions & {
13753
14106
  backgroundThrottling: boolean;
13754
14107
  componentName: 'view';
@@ -14718,6 +15071,7 @@ declare type WebRequestHeader = {
14718
15071
  /**
14719
15072
  * Generated when a window is being moved by the user.
14720
15073
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
15074
+ * @interface
14721
15075
  */
14722
15076
  declare type WillMoveEvent = WillMoveOrResizeEvent & {
14723
15077
  type: 'will-move';
@@ -14725,6 +15079,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
14725
15079
 
14726
15080
  /**
14727
15081
  * A general will-move or will-resize event without event type.
15082
+ * @interface
14728
15083
  */
14729
15084
  declare type WillMoveOrResizeEvent = NamedEvent & {
14730
15085
  height: number;
@@ -14742,7 +15097,7 @@ declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedE
14742
15097
  /**
14743
15098
  * A View event that does propagate to (republish on) parent topics.
14744
15099
  */
14745
- declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent_2 | HotkeyEvent | ShownEvent | TargetChangedEvent;
15100
+ declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
14746
15101
 
14747
15102
  /**
14748
15103
  * A WebContents event that does propagate to (republish on) parent topics.
@@ -14752,10 +15107,11 @@ declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelection
14752
15107
  /**
14753
15108
  * A Window event that does propagate to (republish on) parent topics.
14754
15109
  */
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;
15110
+ 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
15111
 
14757
15112
  /**
14758
15113
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
15114
+ * @interface
14759
15115
  */
14760
15116
  declare type WillRedirectEvent = NamedEvent & {
14761
15117
  type: 'will-redirect';
@@ -14768,6 +15124,7 @@ declare type WillRedirectEvent = NamedEvent & {
14768
15124
  * Generated when a window is being resized by the user.
14769
15125
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
14770
15126
  * 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.
15127
+ * @interface
14771
15128
  */
14772
15129
  declare type WillResizeEvent = WillMoveOrResizeEvent & {
14773
15130
  type: 'will-resize';
@@ -15923,7 +16280,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15923
16280
  * moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
15924
16281
  * ```
15925
16282
  */
15926
- moveBy(deltaLeft: number, deltaTop: number): Promise<void>;
16283
+ moveBy(deltaLeft: number, deltaTop: number, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15927
16284
  /**
15928
16285
  * Moves the window to a specified location.
15929
16286
  * @param left The left position of the window
@@ -15949,7 +16306,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15949
16306
  * moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
15950
16307
  * ```
15951
16308
  */
15952
- moveTo(left: number, top: number): Promise<void>;
16309
+ moveTo(left: number, top: number, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15953
16310
  /**
15954
16311
  * Resizes the window by a specified amount.
15955
16312
  * @param deltaWidth The change in the width of the window
@@ -15978,7 +16335,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
15978
16335
  * resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
15979
16336
  * ```
15980
16337
  */
15981
- resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin_2.AnchorType): Promise<void>;
16338
+ resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin_2.AnchorType, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
15982
16339
  /**
15983
16340
  * Resizes the window to the specified dimensions.
15984
16341
  * @param width The change in the width of the window
@@ -16007,7 +16364,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16007
16364
  * resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
16008
16365
  * ```
16009
16366
  */
16010
- resizeTo(width: number, height: number, anchor: OpenFin_2.AnchorType): Promise<void>;
16367
+ resizeTo(width: number, height: number, anchor: OpenFin_2.AnchorType, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
16011
16368
  /**
16012
16369
  * Restores the window to its normal state (i.e., unminimized, unmaximized).
16013
16370
  *
@@ -16058,7 +16415,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16058
16415
  setAsForeground(): Promise<void>;
16059
16416
  /**
16060
16417
  * 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
16418
  *
16063
16419
  * @example
16064
16420
  * ```js
@@ -16085,7 +16441,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16085
16441
  * }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
16086
16442
  * ```
16087
16443
  */
16088
- setBounds(bounds: Partial<OpenFin_2.Bounds>): Promise<void>;
16444
+ setBounds(bounds: Partial<OpenFin_2.Bounds>, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
16089
16445
  /**
16090
16446
  * Shows the window if it is hidden.
16091
16447
  * @param force Show will be prevented from showing when force is false and
@@ -16376,6 +16732,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16376
16732
 
16377
16733
  /**
16378
16734
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
16735
+ * @interface
16379
16736
  */
16380
16737
  declare type WindowAlertRequestedEvent = NamedEvent & {
16381
16738
  type: 'window-alert-requested';
@@ -16383,6 +16740,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16383
16740
 
16384
16741
  /**
16385
16742
  * Returned from getBounds call. bottom and right are never used for setting.
16743
+ * @interface
16386
16744
  */
16387
16745
  declare type WindowBounds = Bounds & {
16388
16746
  bottom: number;
@@ -16391,6 +16749,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16391
16749
 
16392
16750
  /**
16393
16751
  * Generated when a window has closed.
16752
+ * @interface
16394
16753
  */
16395
16754
  declare type WindowClosedEvent = NamedEvent & {
16396
16755
  type: 'closed';
@@ -16399,6 +16758,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16399
16758
  /**
16400
16759
  * Generated when a window has been prevented from closing.
16401
16760
  * @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.
16761
+ * @interface
16402
16762
  */
16403
16763
  declare type WindowCloseRequestedEvent = NamedEvent & {
16404
16764
  type: 'close-requested';
@@ -16406,6 +16766,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16406
16766
 
16407
16767
  /**
16408
16768
  * Generated when a window has initiated the closing routine.
16769
+ * @interface
16409
16770
  */
16410
16771
  declare type WindowClosingEvent = NamedEvent & {
16411
16772
  type: 'closing';
@@ -16413,6 +16774,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16413
16774
 
16414
16775
  /**
16415
16776
  * Generated when a child window is created.
16777
+ * @interface
16416
16778
  */
16417
16779
  declare type WindowCreatedEvent = NamedEvent & {
16418
16780
  type: 'window-created';
@@ -16423,6 +16785,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16423
16785
  *
16424
16786
  * Note that `name` is the only required property — albeit the `url` property is usually provided as well
16425
16787
  * (defaults to `"about:blank"` when omitted).
16788
+ * @interface
16426
16789
  */
16427
16790
  declare type WindowCreationOptions = Partial<WindowOptions> & {
16428
16791
  name: string;
@@ -16465,6 +16828,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16465
16828
 
16466
16829
  /**
16467
16830
  * Generated when a child window ends loading.
16831
+ * @interface
16468
16832
  */
16469
16833
  declare type WindowEndLoadEvent = NamedEvent & {
16470
16834
  type: 'window-end-load';
@@ -16489,7 +16853,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16489
16853
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
16490
16854
  ExternalProcessExitedEvent,
16491
16855
  ExternalProcessStartedEvent,
16492
- HiddenEvent,
16856
+ WindowHiddenEvent,
16493
16857
  PreloadScriptInfoRunning,
16494
16858
  PreloadScriptInfo,
16495
16859
  PreloadScriptsStateChangeEvent,
@@ -16539,9 +16903,19 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16539
16903
  */
16540
16904
  declare type WindowEventType = WindowEvent['type'];
16541
16905
 
16906
+ /**
16907
+ * Generated when a window has been hidden.
16908
+ * @interface
16909
+ */
16910
+ declare type WindowHiddenEvent = NamedEvent & {
16911
+ type: 'hidden';
16912
+ reason: 'closing' | 'hide' | 'hide-on-close';
16913
+ };
16914
+
16542
16915
  /**
16543
16916
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
16544
16917
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
16918
+ * @interface
16545
16919
  */
16546
16920
  declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
16547
16921
  type: 'hotkey';
@@ -16557,11 +16931,15 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16557
16931
 
16558
16932
  /**
16559
16933
  * Generated when a window is initialized.
16934
+ * @interface
16560
16935
  */
16561
16936
  declare type WindowInitializedEvent = NamedEvent & {
16562
16937
  type: 'initialized';
16563
16938
  };
16564
16939
 
16940
+ /**
16941
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
16942
+ */
16565
16943
  declare class _WindowModule extends Base {
16566
16944
  /**
16567
16945
  * Asynchronously returns a Window object that represents an existing window.
@@ -16652,6 +17030,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16652
17030
 
16653
17031
  /**
16654
17032
  * Generated when a child window is not responding.
17033
+ * @interface
16655
17034
  */
16656
17035
  declare type WindowNotRespondingEvent = NamedEvent & {
16657
17036
  type: 'window-not-responding';
@@ -16664,6 +17043,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16664
17043
  };
16665
17044
  };
16666
17045
 
17046
+ /**
17047
+ * @interface
17048
+ */
16667
17049
  declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
16668
17050
 
16669
17051
  declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
@@ -16671,6 +17053,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16671
17053
  /**
16672
17054
  * Generated after window options are changed using the window.updateOptions method.
16673
17055
  * @remarks Will not fire if the diff object is empty.
17056
+ * @interface
16674
17057
  */
16675
17058
  declare type WindowOptionsChangedEvent_2 = NamedEvent & {
16676
17059
  type: 'options-changed';
@@ -16682,6 +17065,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16682
17065
 
16683
17066
  /**
16684
17067
  * Generated when a child window is responding.
17068
+ * @interface
16685
17069
  */
16686
17070
  declare type WindowRespondingEvent = NamedEvent & {
16687
17071
  type: 'window-responding';
@@ -16689,6 +17073,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16689
17073
 
16690
17074
  /**
16691
17075
  * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
17076
+ * @interface
16692
17077
  */
16693
17078
  declare type WindowRestoredEvent = NamedEvent & {
16694
17079
  type: 'restored';
@@ -16696,6 +17081,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16696
17081
 
16697
17082
  /**
16698
17083
  * Generated when a hidden window has been shown.
17084
+ * @interface
16699
17085
  */
16700
17086
  declare type WindowShownEvent = NamedEvent & {
16701
17087
  type: 'shown';
@@ -16704,6 +17090,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16704
17090
  /**
16705
17091
  * Generated when a window has been prevented from showing.
16706
17092
  * @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.
17093
+ * @interface
16707
17094
  */
16708
17095
  declare type WindowShowRequestedEvent = NamedEvent & {
16709
17096
  type: 'show-requested';
@@ -16711,6 +17098,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16711
17098
 
16712
17099
  /**
16713
17100
  * Generated when a child window starts loading.
17101
+ * @interface
16714
17102
  */
16715
17103
  declare type WindowStartLoadEvent = NamedEvent & {
16716
17104
  type: 'window-start-load';
@@ -16752,6 +17140,10 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16752
17140
  */
16753
17141
  declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
16754
17142
 
17143
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
17144
+ positioningOptions?: OpenFin_2.PositioningOptions;
17145
+ };
17146
+
16755
17147
  declare type WorkspacePlatformOptions = {
16756
17148
  /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
16757
17149
  [key: string]: any;
@@ -16759,6 +17151,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16759
17151
 
16760
17152
  /**
16761
17153
  * A generic request to write any supported data to the clipboard.
17154
+ * @interface
16762
17155
  */
16763
17156
  declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
16764
17157
  data: {
@@ -16777,6 +17170,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16777
17170
 
16778
17171
  /**
16779
17172
  * A request to write data to the clipboard.
17173
+ * @interface
16780
17174
  */
16781
17175
  declare type WriteClipboardRequest = BaseClipboardRequest & {
16782
17176
  /**
@@ -16785,6 +17179,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16785
17179
  data: string;
16786
17180
  };
16787
17181
 
17182
+ /**
17183
+ * @interface
17184
+ */
16788
17185
  declare type WriteImageClipboardRequest = BaseClipboardRequest & {
16789
17186
  /**
16790
17187
  * Can be either a base64 string, or a DataURL string. If using DataURL, the