Handles requests to apply a snapshot to the current Platform.
Payload containing the snapshot to be applied, as well as any options.
Optional identity: IdentityIdentity of the entity that called Platform.applySnapshot. Undefined if called internally (e.g. when opening the initial snapshot).
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.
Closes a view
Specifies the target view to be closed.
Optional identity: IdentityIdentity of the entity that called 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 Platform.closeWindow.
Object that contains the Window Identity and related options.
Creates a new view and attaches it to a specified target window.
Creation options for the new view.
Identity of the entity that called Platform.createView.
Handles requests to create a window in the current platform.
Optional identity: IdentityIf Platform.createWindow was called, the identity of the caller will be here.
If createWindow was called as part of applying a snapshot or creating a view without a target window, identity will be undefined.
Handles requests to fetch manifests in the current platform.
Payload containing the manifestUrl to be fetched.
If Platform.fetchManifest
was called, the identity of the caller will be here.
If fetchManifest was called internally, callerIdentity will be the provider's identity.
Gets the current state of windows and their views and returns a snapshot object containing that info.
Snapshot of current platform state.
Undefined unless you've defined a custom getSnapshot protocol.
Identity of the entity that called Platform.getSnapshot.
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 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.
PlatformProvider.getUserDecisionForBeforeUnload
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.
The new context.
Object containing the requested context update,
the target's identity, and the target's entityType.
Optional identity: IdentityIdentity of the entity that called Platform.getWindowContext.
Undefined when getWindowContext is called internally
(e.g. when getting a window's context for the purpose of raising a "host-context-changed" event on a reparented view).
Handles the closing of a Window and/or its Views. Called in PlatformProvider.closeWindow. The return of 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 that it raised.
The event payload for the window whose context has changed.
The new context will be contained as payload.diff.customContext.newVal.
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.
An array of WindowOptions with their position modified to fit on screen.
The snapshot to be applied.
An array of WindowOptions for any windows that would be off-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 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.
Optional identity: IdentityIdentity of the entity that called Platform#replaceLayout Platform.replaceLayout.
Undefined if replaceLayout is called internally (e.g. while applying a snapshot).
Optional identity: IdentityHandles 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.
The new context.
Object containing the requested context update,
the target's identity, and the target's entityType.
Optional identity: IdentityIdentity of the entity that called Platform.setWindowContext.
Undefined if setWindowContext is called internally (e.g. while applying a snapshot).
Generated using TypeDoc
This class handles Platform actions. It does not need to be used directly by developers. However, its methods can be overriden by passing an
overrideCallbackto Platform#init Platform.init in order to implement custom Platform behavior. (See {@tutorial Platform.init})For an overview of Provider customization, see https://developers.openfin.co/docs/platform-customization#section-customizing-platform-behavior.