Payload containing the snapshot to be applied, as well as any options.
Applies a workspace to the user's desktop. Makes that workspace the active workspace.
true if the workspace was applied, false if the workspace was not applied.
It takes in an array of Views and returns an object specifying which of them are trying to prevent an unload and which are not.
Array of Views
Closes a view
Specifies the target view to be closed.
Identity of the entity that called {@link Platform#closeView Platform.closeView}.
Closes a Window. By default it will fire any before unload handler set by a View in the Window. This can be disabled by setting skipBeforeUnload in the options object of the payload. This method is called by {@link Platform#closeWindow Platform.closeWindow}.
Object that contains the Window Identity and related options.
Implementation for creating a saved page in persistent storage.
the create saved page request.
Implementation for creating a saved workspace in persistent storage.
the create saved workspace request.
Creates a new view and attaches it to a specified target window.
Creation options for the new view.
Identity of the entity that called {@link Platform#createView Platform.createView}.
Handles requests to create a window in the current platform.
Implementation for deleting a saved page in persistent storage.
of the id of the page to delete.
Implementation for deleting a saved workspace in persistent storage.
of the id of the workspace to delete.
Handles requests to fetch manifests in the current platform.
Payload containing the manifestUrl to be fetched.
If {@link Platform#fetchManifest Platform.fetchManifest}
was called, the identity of the caller will be here.
If fetchManifest was called internally, callerIdentity will be the provider's identity.
Implementation for getting the dock provider from persistent storage.
The id of the dock provider to get.
Implementation for getting a single page in persistent storage.
Implementation for getting a list of saved pages from persistent storage.
an optional query.
Implementation for getting a single workspace in persistent storage.
Implementation for getting a list of saved workspaces from persistent storage.
an optional query.
Implementation for getting selected theme scheme.
Gets the current state of windows and their views and returns a snapshot object containing that info.
Undefined unless you've defined a custom getSnapshot protocol.
Identity of the entity that called {@link Platform#getSnapshot Platform.getSnapshot}.
Snapshot of current platform state.
Handle the decision of whether a Window or specific View should close when trying to prevent an unload. This is meant to be overridden. Called in {@link PlatformProvider#closeWindow PlatformProvider.closeWindow}. Normally you would use this method to show a dialog indicating that there are Views that are trying to prevent an unload. By default it will always return all Views passed into it as meaning to close.
Gets all the Views attached to a Window that should close along with it. This is meant to be overridable in the case where you want to return other Views that may not be attached to the Window that is closing.
Handles requests to get a window's context. target may be a window or a view.
If it is a window, that window's customContext will be returned.
If it is a view, the customContext of that view's current host window will be returned.
Object containing the requested context update,
the target's identity, and the target's entityType.
The new context.
Implementation for handling Workspace analytics events
the payload received by the provider
Handles the closing of a Window and/or its Views. Called in {@link PlatformProvider#closeWindow PlatformProvider.closeWindow}. The return of {@link PlatformProvider#getUserDecisionForBeforeUnload PlatformProvider.getUserDecisionForBeforeUnload} is passed into this method.
Decision object
Called when a window's customContext is updated. Responsible for raising the host-context-updated event on that window's child views.
The event payload for the window whose context has changed.
The new context will be contained as payload.diff.customContext.newVal.
The event that it raised.
Implementation for showing a global context menu given a menu template, handler callback, and screen coordinates. For an example of overriding, see WorkspacePlatformOverrideCallback.
the payload received by the provider call
OF identity of the entity from which the request originated
Implementation for showing a page tab context menu given a menu template, handler callback, and screen coordinates. For an example of overriding, see WorkspacePlatformOverrideCallback.
the payload received by the provider call
OF identity of the entity from which the request originated
Implementation for showing a context menu for save button given a menu template, handler callback, and screen coordinates. For an example of overriding, see WorkspacePlatformOverrideCallback.
the payload received by the provider call
OF identity of the entity from which the request originated
Implementation for showing a view tab context menu given a menu template, handler callback, and screen coordinates. For an example of overriding, see WorkspacePlatformOverrideCallback.
the payload received by the provider call
OF identity of the entity from which the request originated
Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen. Returns an array of windows with modified positions, such that any off-screen windows are positioned in the top left corner of the main monitor.
The snapshot to be applied.
An array of WindowOptions for any windows that would be off-screen.
An array of WindowOptions with their position modified to fit on screen.
Closes the current Platform and all child windows and views.
Undefined unless you have implemented a custom quite protocol.
Identity of the entity that called {@link Platform#quit Platform.quit}.
Replaces a Platform window's layout with a new layout. Any views that were in the old layout but not the new layout will be destroyed.
Contains the target window and an opts object with a layout property to apply.
Implementation for saving a dock provider config to persistent storage.
The new dock config to save to persistent storage.
Implementation for setting selected theme scheme.
scheme to be set
Handles requests to set a window's context. target may be a window or a view.
If it is a window, that window's customContext will be updated.
If it is a view, the customContext of that view's current host window will be updated.
Object containing the requested context update,
the target's identity, and the target's entityType.
The new context.
Implementation for updating a saved page in persistent storage.
the update saved page request.
Implementation for updating a saved workspace in persistent storage.
the update saved workspace request.
Generated using TypeDoc
Handles requests to apply a snapshot to the current Platform.