@interopio/desktop API Reference

Access via:io.v2.default

API for managing the default Global Layout which io.Connect Desktop will load upon startup.

4 Methods

clear()⚓︎

() => Promise<void>

Clears the default Global Layout.

get()⚓︎

() => Promise<Layout | null>

Retrieves the default Global Layout. Resolves with null if no default Global Layout has been set.

onChanged()⚓︎

(handler: (layout: Layout | null) => void) => Promise<UnsubscribeFunction>

Notifies when the default Global Layout is set or cleared. Resolves with an unsubscribe function.

Parameters (1)

Name Type Required Description
handler⚓︎ (layout: Layout | null) => void

Callback function for handling the event. Receives the default Global Layout, or null.

set()⚓︎

(layout: LayoutSelect) => Promise<void>

Sets a new default Global Layout.

Parameters (1)

Name Type Required Description
layout⚓︎ LayoutSelect

The Layout to set as the new default Global Layout.