@interopio/desktop API Reference

Describes a Layout. The optional properties are populated depending on the options used for retrieving the Layout.

Properties (7)

Property Type Default Required Description
accessInfo⚓︎ LayoutAccessInfo x x

Information about the owner of the Layout and the users and groups with access to it. When retrieving Layouts, available only if requested via the includeAccessInfo property. Not available for Layouts from local Layout stores.
components⚓︎ LayoutComponent[] x x

Array of component objects describing the apps that are saved in the Layout. When retrieving Layouts, available only if requested via the includeComponents property.
context⚓︎ unknown x x

Context saved with the Layout. When retrieving Layouts, available only if requested via the includeContext property.
id⚓︎ string x

ID of the Layout. Assigned by io.Manager when it's used as a Layout store. For other Layout stores, formed by the name and the type of the Layout.
metadata⚓︎ object x x

Metadata saved with the Layout.
name⚓︎ string x

Name of the Layout, unique per Layout type.
type⚓︎ LayoutType x

Type of the Layout.