Payload containing the snapshot to be applied, as well as any options.
Closes a view
Specifies the target
view to be closed.
Identity of the entity that called {@link Platform#closeView Platform.closeView}.
Implementation for creating a saved page in persistent storage.
the create saved page 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.
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 a single page in persistent storage.
Implementation for getting a list of saved pages from persistent storage.
an optional query.
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.
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.
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.
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.
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.
Generated using TypeDoc
Handles requests to apply a snapshot to the current Platform.