@openfin/core 34.78.9 → 34.78.10

package/out/mock-public.d.ts

@@ -845,7 +845,10 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
 };
 
 /**
- *  An Application event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}.  Events are
+ *  discriminated by {@link ApplicationEvent.type | their type}.  Event payloads unique to `Application` can be found
+ *  under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
+ *  from which they propagate).
  */
 declare type ApplicationEvent = {
     topic: 'application';
@@ -1572,6 +1575,9 @@ declare type BaseViewEvent = NamedEvent & {
     viewIdentity: OpenFin_2.Identity;
 };
 
+/**
+ * User decision of whether a Window or specific View should close when trying to prevent an unload.
+ */
 declare interface BeforeUnloadUserDecision {
     /**
      * Specifies if the Window should close.
@@ -2327,7 +2333,9 @@ declare namespace ChannelEvents {
 }
 
 /**
- * A Channel event type.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}.  Events are
+ *  discriminated by {@link ChannelEvent.type | their type}.  Event payloads unique to `Channel` can be found
+ *  under the {@link OpenFin.ChannelEvents} namespace.
  */
 declare type ChannelEventType = ChannelEvent['type'];
 
@@ -2873,6 +2881,9 @@ declare type CloseViewPayload = {
     view: Identity_5;
 };
 
+/**
+ * Represents the shape of payload that contains the Window Identity and related options.
+ */
 declare interface CloseWindowPayload {
     /**
      *
@@ -4028,7 +4039,9 @@ declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
 };
 
 /**
- * An external application event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}.  Events are
+ *  discriminated by {@link ExternalApplicationEvent.type | their type}.  Event payloads unique to `ExternalApplication` can be found
+ *  under the {@link OpenFin.ExternalApplicationEvents} namespace.
  */
 declare type ExternalApplicationEvent = {
     topic: 'externalapplication';
@@ -4513,7 +4526,9 @@ declare namespace FrameEvents {
 }
 
 /**
- * A Frame event type.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}.  Events are
+ *  discriminated by {@link _Frame.type | their type}.  Event payloads unique to `Frame` can be found
+ *  under the {@link OpenFin.FrameEvents} namespace.
  */
 declare type FrameEventType = FrameEvent['type'];
 
@@ -4723,7 +4738,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
 }
 
 /**
- * A global hotkey event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}.  Events are
+ *  discriminated by {@link GlobalHotkeyEvent.type | their type}.  Event payloads unique to `GlobalHotkey` can be found
+ *  under the {@link OpenFin.GlobalHotkeyEvents} namespace.
  */
 declare type GlobalHotkeyEvent = {
     topic: 'global-hotkey';
@@ -5077,6 +5094,9 @@ declare class InterApplicationBus extends Base {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+/**
+ * Define whether to enable interop action logging.
+ */
 declare interface InteropActionLoggingOption {
     enabled: boolean;
 }
@@ -8399,12 +8419,11 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
      */
     closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
     /**
-     * ***DEPRECATED - please use Platform.createView.***
+     * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
      * Reparents a specified view in a new target window.
      * @param viewIdentity View identity
      * @param target new owner window identity
      *
-     * @tutorial Platform.createView
      */
     reparentView(viewIdentity: OpenFin_2.Identity, target: OpenFin_2.Identity): Promise<View>;
     /**
@@ -8752,7 +8771,9 @@ declare type PlatformApiReadyEvent = BaseEvent & {
 };
 
 /**
- * A Platform event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}.  Events are
+ *  discriminated by {@link PlatformEvent.type | their type}.  Event payloads unique to `Platform` can be found
+ *  under the {@link OpenFin.PlatformEvents} namespace.
  */
 declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
 
@@ -9495,30 +9516,109 @@ declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
 
 declare type PopupInteraction = 'clicked' | 'dismissed';
 
+/**
+ * Popup window options.
+ */
 declare interface PopupOptions {
+    /**
+     * Window creation options when using `showPopupWindow` to create a new window.
+     */
     initialOptions?: Optional<WindowCreationOptions, 'name'>;
+    /**
+     * Updatable window options applied to new and existing windows when shown as popups.
+     */
     additionalOptions?: UpdatableWindowOptions;
+    /**
+     * If a window with this `name` exists, it will be shown as a popup.
+     * Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
+     */
     name?: string;
+    /**
+     * Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
+     */
     url?: string;
+    /**
+     * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
+     * @defaultValue 300
+     */
     height?: number;
+    /**
+     * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
+     * @defaultValue 300
+     */
     width?: number;
+    /**
+     * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
+     * @defaultValue 0
+     */
     x?: number;
+    /**
+     * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
+     * @defaultValue 0
+     */
     y?: number;
+    /**
+     * Determines what happens if the popup window is blurred.
+     * * 'modal' restricts resizing and positioning in the caller.
+     * * 'hide' hides the popup window on blur.
+     * * 'close' closes the popup window on blur.
+     * @defaultValue 'close'
+     */
     blurBehavior?: PopupBlurBehavior;
+    /**
+     * Determines what happens when the popup window calls `dispatchPopupResult`.
+     * * 'none' will do nothing.
+     * * 'hide' hides the popup window on `dispatchPopupResult`.
+     * * 'close' closes the popup window on `dispatchPopupResult`.
+     * @defaultValue 'close'
+     */
     resultDispatchBehavior?: PopupResultBehavior;
+    /**
+     * Hide the popup window instead of closing when `close` is called on it.
+     * <br>Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
+     * @defaultValue false
+     */
     hideOnClose?: boolean;
+    /**
+     * Determines if the popup window should or should not be focused when it is shown.
+     * @defaultValue true
+     */
     focus?: boolean;
+    /**
+     * Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
+     */
     onPopupReady?: (popupWindow: _Window) => any;
+    /**
+     * Executed when this window's popup calls `dispatchPopupResult`.
+     * <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
+     */
     onPopupResult?: (payload: PopupResult) => any;
 }
 
+/**
+ * The Popup result.
+ *
+ * @typeParam T - Type of data the Popup result contains
+ */
 declare interface PopupResult<T = any> {
+    /**
+     * `name` and `uuid` of the popup window that called dispatched this result.
+     */
     identity: {
         name: string;
         uuid: string;
     };
+    /**
+     * Result of the user interaction with the popup window.
+     */
     result: PopupInteraction;
+    /**
+     * Data passed to `dispatchPopupResult`.
+     */
     data?: T;
+    /**
+     * The last dispatch result.
+     */
     lastDispatchResult?: PopupResult;
 }
 
@@ -9754,10 +9854,25 @@ declare type ProcessDetails = {
     pid: number;
 };
 
+/**
+ * Process logging options
+ */
 declare interface ProcessLoggingOptions {
+    /**
+     * Periodic Logging Interval (in seconds)
+     */
     interval?: number;
+    /**
+     * Outlier Detection options
+     */
     outlierDetection?: {
+        /**
+         * Outlier Interval (in seconds)
+         */
         interval?: number;
+        /**
+         * Number of Process Info entries to collect for outlier analysis
+         */
         entries?: number;
     };
 }
@@ -12217,7 +12332,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
 }
 
 /**
- * A system event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}.  Events are
+ *  discriminated by {@link SystemEvent.type | their type}.  Event payloads unique to `System` can be found
+ *  under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
+ *  from which they propagate).
  */
 declare type SystemEvent = {
     topic: 'system';
@@ -13314,7 +13432,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
 };
 
 /**
- * A View event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}.  Events are
+ *  discriminated by {@link ViewEvent.type | their type}.  Event payloads unique to `View` can be found
+ *  under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
  */
 declare type ViewEvent = {
     topic: 'view';
@@ -13478,6 +13598,9 @@ declare class ViewOverlay {
     setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
 }
 
+/**
+ * Represents the payload shape for Views that are trying to prevent an unload.
+ */
 declare interface ViewsPreventingUnloadPayload {
     /**
      * Specifies if the Window should close.
@@ -13511,6 +13634,9 @@ declare type ViewState = ViewCreationOptions & {
     minWidth?: number;
 };
 
+/**
+ * The statuses of views specifying which of them are trying to prevent an unload and which are not.
+ */
 declare interface ViewStatuses {
     /**
      * Identities of the Views that are preventing an unload.
@@ -15968,6 +16094,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      */
     closePopupMenu(): Promise<void>;
     /**
+     * @PORTED
      * @typedef {object} PopupOptions@typedef {object} PopupOptions
      * @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
      * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -15985,6 +16112,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
              * @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
              */
          /**
+          * @PORTED
           * @typedef {object} PopupResult@typedef {object} PopupResult
           * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
           * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -16130,7 +16258,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
           */
          name: string;
          /**
-          * The right-most coordinate of the window
+          * The right-most coordinate of the window.
           */
          right: number;
          state: string;
@@ -16153,7 +16281,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      };
 
      /**
-      * A Window event.
+      *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}.  Events are
+      *  discriminated by {@link WindowEvent.type | their type}.  Event payloads unique to `Window` can be found
+      *  under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
       */
      declare type WindowEvent = {
          topic: 'window';

package/out/mock.d.ts

@@ -851,7 +851,10 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
 };
 
 /**
- *  An Application event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}.  Events are
+ *  discriminated by {@link ApplicationEvent.type | their type}.  Event payloads unique to `Application` can be found
+ *  under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
+ *  from which they propagate).
  */
 declare type ApplicationEvent = {
     topic: 'application';
@@ -1589,6 +1592,9 @@ declare type BaseViewEvent = NamedEvent & {
     viewIdentity: OpenFin_2.Identity;
 };
 
+/**
+ * User decision of whether a Window or specific View should close when trying to prevent an unload.
+ */
 declare interface BeforeUnloadUserDecision {
     /**
      * Specifies if the Window should close.
@@ -2361,7 +2367,9 @@ declare namespace ChannelEvents {
 }
 
 /**
- * A Channel event type.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}.  Events are
+ *  discriminated by {@link ChannelEvent.type | their type}.  Event payloads unique to `Channel` can be found
+ *  under the {@link OpenFin.ChannelEvents} namespace.
  */
 declare type ChannelEventType = ChannelEvent['type'];
 
@@ -2910,6 +2918,9 @@ declare type CloseViewPayload = {
     view: Identity_5;
 };
 
+/**
+ * Represents the shape of payload that contains the Window Identity and related options.
+ */
 declare interface CloseWindowPayload {
     /**
      *
@@ -4138,7 +4149,9 @@ declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
 };
 
 /**
- * An external application event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}.  Events are
+ *  discriminated by {@link ExternalApplicationEvent.type | their type}.  Event payloads unique to `ExternalApplication` can be found
+ *  under the {@link OpenFin.ExternalApplicationEvents} namespace.
  */
 declare type ExternalApplicationEvent = {
     topic: 'externalapplication';
@@ -4626,7 +4639,9 @@ declare namespace FrameEvents {
 }
 
 /**
- * A Frame event type.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}.  Events are
+ *  discriminated by {@link _Frame.type | their type}.  Event payloads unique to `Frame` can be found
+ *  under the {@link OpenFin.FrameEvents} namespace.
  */
 declare type FrameEventType = FrameEvent['type'];
 
@@ -4839,7 +4854,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
 }
 
 /**
- * A global hotkey event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}.  Events are
+ *  discriminated by {@link GlobalHotkeyEvent.type | their type}.  Event payloads unique to `GlobalHotkey` can be found
+ *  under the {@link OpenFin.GlobalHotkeyEvents} namespace.
  */
 declare type GlobalHotkeyEvent = {
     topic: 'global-hotkey';
@@ -5208,6 +5225,9 @@ declare class InterAppPayload {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+/**
+ * Define whether to enable interop action logging.
+ */
 declare interface InteropActionLoggingOption {
     enabled: boolean;
 }
@@ -8831,12 +8851,11 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
      */
     closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
     /**
-     * ***DEPRECATED - please use Platform.createView.***
+     * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
      * Reparents a specified view in a new target window.
      * @param viewIdentity View identity
      * @param target new owner window identity
      *
-     * @tutorial Platform.createView
      */
     reparentView(viewIdentity: OpenFin_2.Identity, target: OpenFin_2.Identity): Promise<View>;
     /**
@@ -9211,7 +9230,9 @@ declare type PlatformApiReadyEvent = BaseEvent & {
 };
 
 /**
- * A Platform event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}.  Events are
+ *  discriminated by {@link PlatformEvent.type | their type}.  Event payloads unique to `Platform` can be found
+ *  under the {@link OpenFin.PlatformEvents} namespace.
  */
 declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
 
@@ -9993,30 +10014,109 @@ declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
 
 declare type PopupInteraction = 'clicked' | 'dismissed';
 
+/**
+ * Popup window options.
+ */
 declare interface PopupOptions {
+    /**
+     * Window creation options when using `showPopupWindow` to create a new window.
+     */
     initialOptions?: Optional<WindowCreationOptions, 'name'>;
+    /**
+     * Updatable window options applied to new and existing windows when shown as popups.
+     */
     additionalOptions?: UpdatableWindowOptions;
+    /**
+     * If a window with this `name` exists, it will be shown as a popup.
+     * Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
+     */
     name?: string;
+    /**
+     * Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
+     */
     url?: string;
+    /**
+     * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
+     * @defaultValue 300
+     */
     height?: number;
+    /**
+     * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
+     * @defaultValue 300
+     */
     width?: number;
+    /**
+     * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
+     * @defaultValue 0
+     */
     x?: number;
+    /**
+     * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
+     * @defaultValue 0
+     */
     y?: number;
+    /**
+     * Determines what happens if the popup window is blurred.
+     * * 'modal' restricts resizing and positioning in the caller.
+     * * 'hide' hides the popup window on blur.
+     * * 'close' closes the popup window on blur.
+     * @defaultValue 'close'
+     */
     blurBehavior?: PopupBlurBehavior;
+    /**
+     * Determines what happens when the popup window calls `dispatchPopupResult`.
+     * * 'none' will do nothing.
+     * * 'hide' hides the popup window on `dispatchPopupResult`.
+     * * 'close' closes the popup window on `dispatchPopupResult`.
+     * @defaultValue 'close'
+     */
     resultDispatchBehavior?: PopupResultBehavior;
+    /**
+     * Hide the popup window instead of closing when `close` is called on it.
+     * <br>Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
+     * @defaultValue false
+     */
     hideOnClose?: boolean;
+    /**
+     * Determines if the popup window should or should not be focused when it is shown.
+     * @defaultValue true
+     */
     focus?: boolean;
+    /**
+     * Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
+     */
     onPopupReady?: (popupWindow: _Window) => any;
+    /**
+     * Executed when this window's popup calls `dispatchPopupResult`.
+     * <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
+     */
     onPopupResult?: (payload: PopupResult) => any;
 }
 
+/**
+ * The Popup result.
+ *
+ * @typeParam T - Type of data the Popup result contains
+ */
 declare interface PopupResult<T = any> {
+    /**
+     * `name` and `uuid` of the popup window that called dispatched this result.
+     */
     identity: {
         name: string;
         uuid: string;
     };
+    /**
+     * Result of the user interaction with the popup window.
+     */
     result: PopupInteraction;
+    /**
+     * Data passed to `dispatchPopupResult`.
+     */
     data?: T;
+    /**
+     * The last dispatch result.
+     */
     lastDispatchResult?: PopupResult;
 }
 
@@ -10252,10 +10352,25 @@ declare type ProcessDetails = {
     pid: number;
 };
 
+/**
+ * Process logging options
+ */
 declare interface ProcessLoggingOptions {
+    /**
+     * Periodic Logging Interval (in seconds)
+     */
     interval?: number;
+    /**
+     * Outlier Detection options
+     */
     outlierDetection?: {
+        /**
+         * Outlier Interval (in seconds)
+         */
         interval?: number;
+        /**
+         * Number of Process Info entries to collect for outlier analysis
+         */
         entries?: number;
     };
 }
@@ -12721,7 +12836,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
 }
 
 /**
- * A system event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}.  Events are
+ *  discriminated by {@link SystemEvent.type | their type}.  Event payloads unique to `System` can be found
+ *  under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
+ *  from which they propagate).
  */
 declare type SystemEvent = {
     topic: 'system';
@@ -13912,7 +14030,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
 };
 
 /**
- * A View event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}.  Events are
+ *  discriminated by {@link ViewEvent.type | their type}.  Event payloads unique to `View` can be found
+ *  under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
  */
 declare type ViewEvent = {
     topic: 'view';
@@ -14076,6 +14196,9 @@ declare class ViewOverlay {
     setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
 }
 
+/**
+ * Represents the payload shape for Views that are trying to prevent an unload.
+ */
 declare interface ViewsPreventingUnloadPayload {
     /**
      * Specifies if the Window should close.
@@ -14109,6 +14232,9 @@ declare type ViewState = ViewCreationOptions & {
     minWidth?: number;
 };
 
+/**
+ * The statuses of views specifying which of them are trying to prevent an unload and which are not.
+ */
 declare interface ViewStatuses {
     /**
      * Identities of the Views that are preventing an unload.
@@ -16650,6 +16776,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      */
     closePopupMenu(): Promise<void>;
     /**
+     * @PORTED
      * @typedef {object} PopupOptions@typedef {object} PopupOptions
      * @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
      * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -16667,6 +16794,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
              * @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
              */
          /**
+          * @PORTED
           * @typedef {object} PopupResult@typedef {object} PopupResult
           * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
           * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -16812,7 +16940,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
           */
          name: string;
          /**
-          * The right-most coordinate of the window
+          * The right-most coordinate of the window.
           */
          right: number;
          state: string;
@@ -16835,7 +16963,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      };
 
      /**
-      * A Window event.
+      *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}.  Events are
+      *  discriminated by {@link WindowEvent.type | their type}.  Event payloads unique to `Window` can be found
+      *  under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
       */
      declare type WindowEvent = {
          topic: 'window';