@interopio/browser API Reference

Options for restoring a Layout.

Properties (7)

Property Type Default Required Description
closeMe⚓︎ boolean true x

If true, will close the current app before restoring a Layout. If closeRunningInstances is set to false, this will default to false too.
closeRunningInstances⚓︎ boolean true x

If true, will close all visible running instances before restoring the Layout. The only exception is the Main app (Web Platform) - it will never be closed when restoring a Layout.
context⚓︎ object x x

Context object that will be passed to the restored apps. It will be merged with the saved context object.
name⚓︎ string x

Name of the Layout to restore.
restoreWorkspacesByReference⚓︎ boolean x x

If true, Workspaces saved in a Global Layout will be restored in their original (unmodified) state when the Global Layout is restored. If false, Workspaces will be restored in the exact state in which they were when the Global Layout was saved. This will override the "restoreWorkspacesByReference" property specified in the definition of the Workspaces App. Defaults to the value of the "restoreWorkspacesByReference" property specified in the Workspaces App definition.

io.Connect Desktop 10.0
timeout⚓︎ number 60000 x

Timeout in milliseconds for restoring the Layout. If the time limit is hit, all apps opened up to this point will be closed and an error will be thrown.
type⚓︎ string "Global" x

Type of the Layout to restore.