The browser window factory for the Workspace Platform.
The storage API for the Workspace Platform.
Theme API for the Workspace Platform.
Launch a browser snapshot that contains windows with pages.
the browser snapshot to launch or a url or filepath to retrieve a JSON snapshot.
Closes content from the current workspace and applies the given workspace to the user's desktop. Makes that workspace the active workspace.
the workspace to apply to the desktop and set as the current active workspace.
Closes a specified view in a target window.
View identity
Closes a window. If enableBeforeUnload is enabled in the Platform options, any beforeunload handler set on Views will fire This behavior can be disabled by setting skipBeforeUnload to false in the options parameter.
Creates a new view and attaches it to a specified target window.
View creation options
Creates a new Window.
Window creation options
Fetches a JSON manifest using the browser process and returns a Javascript object. Can be overwritten using {@link Platform#init Platform.init}.
The URL of the manifest to fetch.
Gets a workspace data structure that represents the current state of the user's desktop.
Get a snapshot that contains browser windows with pages.
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.
Launch an application.
```ts import * as WorkspacePlatform from '@openfin/workspace-platform';
const workspacePlatform = WorkspacePlatform.getCurrentSync(); const req = { app: { appId: 'myAppId', title: 'appTitle', manifest: 'http://localhost/app.json', manifestType: AppManifestType.Manifest, icons:[ { icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png", src: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png", type: "ico", }, ] } } workspacePlatform.launchApp(req);
```
the launch app request.
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.
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}.
Closes current platform, all its windows, and their views.
DEPRECATED - please use Platform.createView. Reparents a specified view in a new target window.
View identity
new owner window identity
Sets the workspace as the current active workspace. Does not apply the workspace to the user's desktop.
the workspace to set as current active workspace.
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}.
A field where serializable context data can be stored to be saved in platform snapshots.
Generated using TypeDoc
Controller for a Workspace Platform.