@openfin/core 34.78.16 → 34.78.18

package/out/mock-alpha.d.ts

@@ -517,6 +517,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
     /**
      * Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
      * If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
+     *
      * Note: If the "name" property is omitted it defaults to "tasks".
      * @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
      *
@@ -787,6 +788,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
     getProcessInfo(): Promise<OpenFin_2.AppProcessInfo>;
     /**
      * Sets file auto download location. It's only allowed in the same application.
+     *
      * Note: This method is restricted by default and must be enabled via
      * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param downloadLocation file auto download location
@@ -808,6 +810,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
     setFileDownloadLocation(downloadLocation: string): Promise<void>;
     /**
      * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
+     *
      * Note: This method is restricted by default and must be enabled via
      * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      *
@@ -867,7 +870,7 @@ declare type ApplicationEvent = {
     topic: 'application';
 } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
 
-declare type ApplicationEvent_2 = ApplicationEvents.ApplicationEvent;
+declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
 
 declare namespace ApplicationEvents {
     export {
@@ -1206,6 +1209,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * @defaultValue false
      *
      * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
+     *
      * Note: if the Platform Provider is showing, it won't close automatically.
      * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
      */
@@ -1626,7 +1630,7 @@ declare type BaseEvent = {
     type: string;
 };
 
-declare type BaseEvent_2 = BaseEvents.BaseEvent;
+declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
 
 declare namespace BaseEvents {
     export {
@@ -3214,8 +3218,9 @@ declare type ConstWindowOptions = {
     closeOnLastViewRemoved: boolean;
     /**
      * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
-     * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
-     * somewhat above center vertically.
+     * this value will be ignored for subsequent launches in favor of the cached value.
+     *
+     * **NOTE:** On macOS _defaultCenter_ is somewhat above center vertically.
      */
     defaultCentered: boolean;
     /**
@@ -3277,6 +3282,7 @@ declare type ConstWindowOptions = {
      * @defaultValue true
      *
      * Caches the location of the window.
+     *
      * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
      */
     saveWindowState: boolean;
@@ -3289,7 +3295,8 @@ declare type ConstWindowOptions = {
      * @defaultValue false
      *
      * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
-     * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
+     *
+     * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
      * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
      */
     smallWindow: boolean;
@@ -3405,7 +3412,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
     frameName: string;
     /**
      * The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation.
-     * <br>Note: It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
+     *
+     * Note: It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
      */
     rule: OpenFin_2.ContentCreationRule;
     /**
@@ -3874,9 +3882,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
     protected identity: ApplicationIdentity;
     constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
     eventNames: () => (string | symbol)[];
-    emit: <EventType extends EmitterEventType>(eventType: EventType, payload: Extract<EmitterEvent, {
-        type: EventType;
-    }>, ...args: any[]) => boolean;
+    /* Excluded from this release type: emit */
     private hasEmitter;
     private getOrCreateEmitter;
     listeners: (type: string | symbol) => Function[];
@@ -3885,6 +3891,8 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
     protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin_2.SubscriptionOptions) => Promise<void | EventEmitter>;
     /**
      * Adds a listener to the end of the listeners array for the specified event.
+     *
+     * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
      */
     on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
     /**
@@ -3893,15 +3901,21 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
     addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
+     *
+     * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
      */
     once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
     /**
      * Adds a listener to the beginning of the listeners array for the specified event.
+     *
+     * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
      */
     prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
      * after which it is removed. The listener is added to the beginning of the listeners array.
+     *
+     * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
      */
     prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
     /**
@@ -4060,6 +4074,21 @@ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends stri
     type: EventType;
 }>, ...args: any[]) => void;
 
+declare namespace Events {
+    export {
+        ApplicationEvents,
+        BaseEvents,
+        ExternalApplicationEvents,
+        FrameEvents,
+        GlobalHotkeyEvents,
+        PlatformEvents,
+        SystemEvents,
+        ViewEvents,
+        WebContentsEvents,
+        WindowEvents
+    }
+}
+
 /* Excluded from this release type: EventWithId */
 
 /* Excluded from this release type: ExcludeRequested */
@@ -4207,7 +4236,7 @@ declare type ExternalApplicationEvent = {
     topic: 'externalapplication';
 } & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
 
-declare type ExternalApplicationEvent_2 = ExternalApplicationEvents.ExternalApplicationEvent;
+declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
 
 declare namespace ExternalApplicationEvents {
     export {
@@ -4702,7 +4731,7 @@ declare type FrameEvent = {
     topic: 'frame';
 } & (FrameConnectedEvent | FrameDisconnectedEvent);
 
-declare type FrameEvent_2 = FrameEvents.FrameEvent;
+declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
 
 declare namespace FrameEvents {
     export {
@@ -4945,7 +4974,7 @@ declare type GlobalHotkeyEvent = {
     hotkey: 'string';
 } & (RegisteredEvent | UnregisteredEvent);
 
-declare type GlobalHotkeyEvent_2 = GlobalHotkeyEvents.GlobalHotkeyEvent;
+declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
 
 declare namespace GlobalHotkeyEvents {
     export {
@@ -7089,6 +7118,7 @@ declare type LayoutItemConfig = {
 };
 
 declare class LayoutManager {
+    #private;
     private readonly splitterController;
     private readonly tabDragController;
     private readonly layoutContentCache;
@@ -7981,8 +8011,9 @@ declare type MutableWindowOptions = {
     hotkeys: Hotkey[];
     /**
      * A URL for the icon to be shown in the window title bar and the taskbar.
-     * When omitted, inherits from the parent application._
-     *  note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
+     * When omitted, inherits from the parent application.
+     *
+     * Note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
      */
     icon: string;
     /**
@@ -8161,6 +8192,7 @@ declare namespace OpenFin_2 {
         ExternalApplicationModule,
         _Frame as Frame,
         _FrameModule,
+        GlobalHotkey,
         Channel,
         ChannelClient,
         ChannelProvider,
@@ -8179,6 +8211,7 @@ declare namespace OpenFin_2 {
         InteropModule,
         SnapshotSource,
         SnapshotSourceModule,
+        System,
         LayoutEntityDefinition,
         LayoutEntityTypes,
         LayoutPosition,
@@ -8430,16 +8463,7 @@ declare namespace OpenFin_2 {
         AppVersionErrorEvent,
         AppVersionCompleteEvent,
         AppVersionRuntimeStatusEvent,
-        BaseEvents,
-        WebContentsEvents,
-        SystemEvents,
-        ApplicationEvents,
-        WindowEvents,
-        ViewEvents,
-        GlobalHotkeyEvents,
-        FrameEvents,
-        PlatformEvents,
-        ExternalApplicationEvents,
+        Events,
         BaseEvent_2 as BaseEvent,
         WebContentsEvent_2 as WebContentsEvent,
         SystemEvent_2 as SystemEvent,
@@ -8464,7 +8488,17 @@ declare namespace OpenFin_2 {
         ChannelClientConnectionListener,
         ChannelClientDisconnectionListener,
         ChannelProviderDisconnectionListener,
-        RoutingInfo
+        RoutingInfo,
+        ApplicationEvents,
+        BaseEvents,
+        ExternalApplicationEvents,
+        FrameEvents,
+        GlobalHotkeyEvents,
+        PlatformEvents,
+        SystemEvents,
+        ViewEvents,
+        WebContentsEvents,
+        WindowEvents
     }
 }
 export default OpenFin_2;
@@ -8521,10 +8555,8 @@ declare type PickOfType<T extends Record<any, any>, TTarget> = {
 
 /** Manages the life cycle of windows and views in the application.
  *
- * Enables taking snapshots of itself and applyi
- * ng them to restore a previous configuration
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
- *
  */
 declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
     #private;
@@ -9153,7 +9185,7 @@ declare type PlatformApiReadyEvent = BaseEvent & {
  */
 declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
 
-declare type PlatformEvent_2 = PlatformEvents.PlatformEvent;
+declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
 
 declare namespace PlatformEvents {
     export {
@@ -9962,7 +9994,8 @@ declare type PopupOptions = {
     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.
+     *
+     * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
      * @defaultValue false
      */
     hideOnClose?: boolean;
@@ -9977,7 +10010,8 @@ declare type PopupOptions = {
     onPopupReady?: (popupWindow: _Window) => any;
     /**
      * Executed when this window's popup calls `dispatchPopupResult`.
-     * <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
+     *
+     * Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
      */
     onPopupResult?: (payload: PopupResult) => any;
 };
@@ -12299,7 +12333,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
     showDeveloperTools(identity: Identity_2): Promise<void>;
     /**
      * Attempt to close an external process. The process will be terminated if it
-     * has not closed after the elapsed timeout in milliseconds.<br>
+     * has not closed after the elapsed timeout in milliseconds.
+     *
      * Note: This method is restricted by default and must be enabled via
      * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param options A object defined in the TerminateExternalRequestType interface
@@ -12331,7 +12366,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      */
     updateProxySettings(options: ProxyConfig): Promise<void>;
     /**
-     * Downloads the given application asset<br>
+     * Downloads the given application asset.
+     *
      * Note: This method is restricted by default and must be enabled via
      * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param appAsset App asset object
@@ -12900,7 +12936,7 @@ declare type SystemEvent = {
     topic: 'system';
 } & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
 
-declare type SystemEvent_2 = SystemEvents.SystemEvent;
+declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
 
 declare namespace SystemEvents {
     export {
@@ -14035,7 +14071,7 @@ declare type ViewEvent = {
     topic: 'view';
 } & (NonPropagatedViewEvent | WillPropagateViewEvent);
 
-declare type ViewEvent_2 = ViewEvents.ViewEvent;
+declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
 
 declare namespace ViewEvents {
     export {
@@ -14468,7 +14504,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
     /**
      * Navigates the WebContents to a specified URL.
      *
-     * @remarks The url must contain the protocol prefix such as http:// or https://.
+     * Note: The url must contain the protocol prefix such as http:// or https://.
      * @param url - The URL to navigate the WebContents to.
      *
      * @example
@@ -14636,7 +14672,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * Prints the WebContents.
      * @param options Printer Options
      *
-     * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
+     * Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
      * is empty and the default settings for printing.
      *
      * Use the CSS style `page-break-before: always;` to force print to a new page.
@@ -14660,7 +14696,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * @param searchTerm Term to find in page
      * @param options Search options
      *
-     * @remarks By default, each subsequent call will highlight the next text that matches the search term.
+     * Note: By default, each subsequent call will highlight the next text that matches the search term.
      *
      * Returns a promise with the results for the request. By subscribing to the
      * found-in-page event, you can get the results of this call as well.
@@ -14850,7 +14886,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
     /**
      * Retrieves the process information associated with a WebContents.
      *
-     * @remarks This includes any iframes associated with the WebContents
+     * Note: This includes any iframes associated with the WebContents
      *
      * @example
      * View:
@@ -15020,7 +15056,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
     /**
      * Shows a popup window.
      *
-     * @remarks If this WebContents is a view and its attached window has a popup open, this will close it.
+     * Note: If this WebContents is a view and its attached window has a popup open, this will close it.
      *
      * Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
      * that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
@@ -15028,7 +15064,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
      * will be dismissed.
      *
-     * NOTE: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
+     * Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
      *
      * @example
      *
@@ -15236,7 +15272,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
  */
 declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
 
-declare type WebContentsEvent_2 = WebContentsEvents.WebContentsEvent;
+declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent;
 
 declare namespace WebContentsEvents {
     export {
@@ -16993,7 +17029,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
          topic: 'window';
      } & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
 
-     declare type WindowEvent_2 = WindowEvents.WindowEvent;
+     declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
 
      declare namespace WindowEvents {
          export {