@interopio/desktop API Reference

An object containing all the possible settings when restoring a workspace from a layout.

Properties (14)

Property Type Default Required Description
activateFrame⚓︎ boolean x x

If true, the Workspaces Frame instance containing the restored Workspace will be activated. This means that the Workspaces Frame window will gain focus, will be restored to its normal state (e.g., if it has been previously minimized), and will be brought in front of other existing windows. Defaults to the configuration passed in the workspaces.json file or to false. Available only in io.Connect Desktop.
allowSystemHibernation⚓︎ boolean x x

If true, will allow the Workspace to be hibernated via the platform configuration. This setting doesn't apply to programmatic hibernation via the hibernate() method of a Workspace instance.
applicationName⚓︎ string x x

The application name of the workspace app that should be used for the new frame. Available only in io.Connect Desktop.
context⚓︎ object x x

An object which will be set as the window context of all windows inside this workspace.
frameId⚓︎ string x x

A string id of an existing frame. If provided, this workspace will be opened in that specific frame
icon⚓︎ string x x

Sets the icon related for the workspace. The icon will be used for example for pinned workspaces.
isPinned⚓︎ boolean x x

Controls whether the workspace will be opened in a pinned or in a normal state
isSelected⚓︎ boolean x x

Controls whether the workspace will be focused or not in the frame when opened
loadingStrategy⚓︎ LoadingStrategy x x x
newFrame⚓︎ NewFrameConfig | boolean x x

A setting used to declare that the workspace must be in a new frame and also provide options for that new frame
noTabHeader⚓︎ boolean x x

Opens the workspace without a workspace tab element
positionIndex⚓︎ number x x

Specifies the position of the Workspace within the Frame instance. This index is ignored by the init() method for initializing an empty Frame.
reuseWorkspaceId⚓︎ string x x

Used for replacing the specified workspace instead of creating a new one
title⚓︎ string x x

The title of the new workspace.