@interopio/desktop API Reference

Options for retrieving the contents of Global or Workspace Layouts via the getLayoutContents() method.

Properties (3)

Property Type Default Required Description
getWorkspacesByReference⚓︎ boolean x x

If true, the contents of Workspaces will be retrieved in their original state as described in the original (unmodified) Workspace Layout and not in the state in which they may have been saved in the Global Layout. If false, the contents of Workspaces will be retrieved as saved in the Global Layout. This property is valid only when retrieving the contents of Global Layouts. Defaults to the value of the "restoreWorkspacesByReference" property in the Workspaces App definition.
name⚓︎ string x

Name of the Layout whose contents to retrieve.
type⚓︎ LayoutType x

Type of the Layout. The supported types for this operation are "Global" and "Workspace".