@openfin/core 25.68.30 → 25.70.2

package/src/api/platform/Instance.d.ts

@@ -1,122 +1,122 @@
-import { View } from '../view';
-import { EmitterBase } from '../base';
-import { Channel } from '../interappbus/channel/index';
-import ChannelClient from '../interappbus/channel/client';
-import { LayoutModule } from './layout';
-import PlatformEvents = OpenFin.PlatformEvents;
-/** Manages the life cycle of windows and views in the application.
- *
- * Enables taking snapshots of itself and applying them to restore a previous configuration
- * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
- * @namespace
- */
-export declare class Platform extends EmitterBase<PlatformEvents> {
-    #private;
-    Layout: LayoutModule;
-    private _channel;
-    Application: OpenFin.Application;
-    identity: OpenFin.ApplicationIdentity;
-    constructor(identity: OpenFin.ApplicationIdentity, channel: Channel);
-    getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient>;
-    /**
-     * Creates a new view and attaches it to a specified target window.
-     * @param { View~options } viewOptions View creation options
-     * @param { Identity } [target] The window to which the new view is to be attached. If no target, create a view in a new window.
-     * @param { Identity } [targetView] If provided, the new view will be added to the same tabstrip as targetView.
-     * @return { Promise<View> }
-     * @tutorial Platform.createView
-     */
-    createView(viewOptions: OpenFin.PlatformViewCreationOptions, target?: OpenFin.Identity, targetView?: OpenFin.Identity): Promise<View>;
-    /**
-     * Creates a new Window.
-     * @param { Window~options } options Window creation options
-     * @return { Promise<_Window> }
-     * @tutorial Platform.createWindow
-     */
-    createWindow(options: OpenFin.PlatformWindowCreationOptions): Promise<OpenFin.Window & OpenFin.Identity>;
-    /**
-     * Closes current platform, all its windows, and their views.
-     * @return { Promise<void> }
-     * @tutorial Platform.quit
-     */
-    quit(): Promise<void>;
-    /**
-     * Closes a specified view in a target window.
-     * @param { Identity } viewIdentity View identity
-     * @return { Promise<void> }
-     * @tutorial Platform.closeView
-     */
-    closeView(viewIdentity: OpenFin.Identity): Promise<void>;
-    /**
-     * ***DEPRECATED - please use Platform.createView.***
-     * Reparents a specified view in a new target window.
-     * @param { Identity } viewIdentity View identity
-     * @param { Identity } target new owner window identity
-     * @return { Promise<View> }
-     * @tutorial Platform.createView
-     */
-    reparentView(viewIdentity: OpenFin.Identity, target: OpenFin.Identity): Promise<View>;
-    /**
-     * Returns a snapshot of the platform in its current state.
-     *
-     * Can be used to restore an application to a previous state.
-     * @return { Promise<Snapshot> }
-     * @tutorial Platform.getSnapshot
-     */
-    getSnapshot(): Promise<OpenFin.Snapshot>;
-    /**
-     * Adds a snapshot to a running Platform.
-     * Requested snapshot must be a valid Snapshot object, or a url or filepath to such an object.
-     *
-     * Can optionally close existing windows and overwrite current platform state with that of a snapshot.
-     *
-     * The function accepts either a snapshot taken using {@link Platform#getSnapshot getSnapshot},
-     * or a url or filepath to a snapshot JSON object.
-     * @param { Snapshot | string } requestedSnapshot Snapshot to apply, or a url or filepath.
-     * @param { ApplySnapshotOptions } [options] Optional parameters to specify whether existing windows should be closed.
-     * @return { Promise<Platform> }
-     * @tutorial Platform.applySnapshot
-     */
-    applySnapshot(requestedSnapshot: OpenFin.Snapshot | string, options?: OpenFin.ApplySnapshotOptions): Promise<Platform>;
-    /**
-     * Fetches a JSON manifest using the browser process and returns a Javascript object.
-     * Can be overwritten using {@link Platform#init Platform.init}.
-     * @param { string } manifestUrl The URL of the manifest to fetch.
-     * @return { Promise<any> }
-     * @tutorial Platform.fetchManifest
-     */
-    fetchManifest(manifestUrl: string): Promise<any>;
-    launchLegacyManifest: (manifestUrl: string) => Promise<Platform>;
-    /**
-     * Retrieves a manifest by url and launches a legacy application manifest or snapshot into the platform.  Returns a promise that
-     * resolves to the wrapped Platform.
-     * @param {string} manifestUrl - The URL of the manifest that will be launched into the platform.  If this app manifest
-     * contains a snapshot, that will be launched into the platform.  If not, the application described in startup_app options
-     * will be launched into the platform. The applicable startup_app options will become {@link View~options View Options}.
-     * @return {Promise<Platform>}
-     * @tutorial Platform.launchContentManifest
-     * @experimental
-     */
-    launchContentManifest(manifestUrl: string): Promise<Platform>;
-    /**
-     * Set the context of a host window. The context will be available to the window itself, and to its child Views. It will be saved in any platform snapshots.
-     * It can be retrieved using {@link Platform#getWindowContext getWindowContext}.
-     * @param {any} context - A field where serializable context data can be stored to be saved in platform snapshots.
-     * @param {Identity} [target] - A target window or view may optionally be provided. If no target is provided, the update will be applied
-     * to the current window (if called from a Window) or the current host window (if called from a View).
-     * @return {Promise<void>}
-     * @tutorial Platform.setWindowContext
-     * @experimental
-     */
-    setWindowContext(context?: any, target?: OpenFin.Identity): Promise<void>;
-    /**
-     * Get the context context of a host window that was previously set using {@link Platform#setWindowContext setWindowContext}.
-     * The context will be saved in any platform snapshots.  Returns a promise that resolves to the context.
-     * @param {Identity} [target] - A target window or view may optionally be provided. If no target is provided, target will be
-     * the current window (if called from a Window) or the current host window (if called from a View).
-     * @return {Promise<any>}
-     * @tutorial Platform.getWindowContext
-     * @experimental
-     */
-    getWindowContext(target?: OpenFin.Identity): Promise<any>;
-}
+import { View } from '../view';
+import { EmitterBase } from '../base';
+import { Channel } from '../interappbus/channel/index';
+import ChannelClient from '../interappbus/channel/client';
+import { LayoutModule } from './layout';
+import PlatformEvents = OpenFin.PlatformEvents;
+/** Manages the life cycle of windows and views in the application.
+ *
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
+ * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
+ * @namespace
+ */
+export declare class Platform extends EmitterBase<PlatformEvents> {
+    #private;
+    Layout: LayoutModule;
+    private _channel;
+    Application: OpenFin.Application;
+    identity: OpenFin.ApplicationIdentity;
+    constructor(identity: OpenFin.ApplicationIdentity, channel: Channel);
+    getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient>;
+    /**
+     * Creates a new view and attaches it to a specified target window.
+     * @param { View~options } viewOptions View creation options
+     * @param { Identity } [target] The window to which the new view is to be attached. If no target, create a view in a new window.
+     * @param { Identity } [targetView] If provided, the new view will be added to the same tabstrip as targetView.
+     * @return { Promise<View> }
+     * @tutorial Platform.createView
+     */
+    createView(viewOptions: OpenFin.PlatformViewCreationOptions, target?: OpenFin.Identity, targetView?: OpenFin.Identity): Promise<View>;
+    /**
+     * Creates a new Window.
+     * @param { Window~options } options Window creation options
+     * @return { Promise<_Window> }
+     * @tutorial Platform.createWindow
+     */
+    createWindow(options: OpenFin.PlatformWindowCreationOptions): Promise<OpenFin.Window & OpenFin.Identity>;
+    /**
+     * Closes current platform, all its windows, and their views.
+     * @return { Promise<void> }
+     * @tutorial Platform.quit
+     */
+    quit(): Promise<void>;
+    /**
+     * Closes a specified view in a target window.
+     * @param { Identity } viewIdentity View identity
+     * @return { Promise<void> }
+     * @tutorial Platform.closeView
+     */
+    closeView(viewIdentity: OpenFin.Identity): Promise<void>;
+    /**
+     * ***DEPRECATED - please use Platform.createView.***
+     * Reparents a specified view in a new target window.
+     * @param { Identity } viewIdentity View identity
+     * @param { Identity } target new owner window identity
+     * @return { Promise<View> }
+     * @tutorial Platform.createView
+     */
+    reparentView(viewIdentity: OpenFin.Identity, target: OpenFin.Identity): Promise<View>;
+    /**
+     * Returns a snapshot of the platform in its current state.
+     *
+     * Can be used to restore an application to a previous state.
+     * @return { Promise<Snapshot> }
+     * @tutorial Platform.getSnapshot
+     */
+    getSnapshot(): Promise<OpenFin.Snapshot>;
+    /**
+     * Adds a snapshot to a running Platform.
+     * Requested snapshot must be a valid Snapshot object, or a url or filepath to such an object.
+     *
+     * Can optionally close existing windows and overwrite current platform state with that of a snapshot.
+     *
+     * The function accepts either a snapshot taken using {@link Platform#getSnapshot getSnapshot},
+     * or a url or filepath to a snapshot JSON object.
+     * @param { Snapshot | string } requestedSnapshot Snapshot to apply, or a url or filepath.
+     * @param { ApplySnapshotOptions } [options] Optional parameters to specify whether existing windows should be closed.
+     * @return { Promise<Platform> }
+     * @tutorial Platform.applySnapshot
+     */
+    applySnapshot(requestedSnapshot: OpenFin.Snapshot | string, options?: OpenFin.ApplySnapshotOptions): Promise<Platform>;
+    /**
+     * Fetches a JSON manifest using the browser process and returns a Javascript object.
+     * Can be overwritten using {@link Platform#init Platform.init}.
+     * @param { string } manifestUrl The URL of the manifest to fetch.
+     * @return { Promise<any> }
+     * @tutorial Platform.fetchManifest
+     */
+    fetchManifest(manifestUrl: string): Promise<any>;
+    launchLegacyManifest: (manifestUrl: string) => Promise<Platform>;
+    /**
+     * Retrieves a manifest by url and launches a legacy application manifest or snapshot into the platform.  Returns a promise that
+     * resolves to the wrapped Platform.
+     * @param {string} manifestUrl - The URL of the manifest that will be launched into the platform.  If this app manifest
+     * contains a snapshot, that will be launched into the platform.  If not, the application described in startup_app options
+     * will be launched into the platform. The applicable startup_app options will become {@link View~options View Options}.
+     * @return {Promise<Platform>}
+     * @tutorial Platform.launchContentManifest
+     * @experimental
+     */
+    launchContentManifest(manifestUrl: string): Promise<Platform>;
+    /**
+     * Set the context of a host window. The context will be available to the window itself, and to its child Views. It will be saved in any platform snapshots.
+     * It can be retrieved using {@link Platform#getWindowContext getWindowContext}.
+     * @param {any} context - A field where serializable context data can be stored to be saved in platform snapshots.
+     * @param {Identity} [target] - A target window or view may optionally be provided. If no target is provided, the update will be applied
+     * to the current window (if called from a Window) or the current host window (if called from a View).
+     * @return {Promise<void>}
+     * @tutorial Platform.setWindowContext
+     * @experimental
+     */
+    setWindowContext(context?: any, target?: OpenFin.Identity): Promise<void>;
+    /**
+     * Get the context context of a host window that was previously set using {@link Platform#setWindowContext setWindowContext}.
+     * The context will be saved in any platform snapshots.  Returns a promise that resolves to the context.
+     * @param {Identity} [target] - A target window or view may optionally be provided. If no target is provided, target will be
+     * the current window (if called from a Window) or the current host window (if called from a View).
+     * @return {Promise<any>}
+     * @tutorial Platform.getWindowContext
+     * @experimental
+     */
+    getWindowContext(target?: OpenFin.Identity): Promise<any>;
+}