@interopio/desktop API Reference

Access via:io.windows

Window Management API.

Properties (1)

Property Type Default Required Description
groups⚓︎ GroupsAPI x

API for managing window groups.

19 Methods

autoArrange()⚓︎

(displayId?: number) => Promise<void>

Arranges the io.Connect Windows automatically in a grid on the specified display using the entire working area of the display. If called a second time, and the user hasn't broken manually the window arrangement, the windows will be restored to their previous state.

Parameters (1)

Name Type Required Description
displayId⚓︎ number x

ID of the display on which to arrange the windows.

configure()⚓︎

(options: WindowsConfiguration) => Promise<void>

Configures global io.Connect Windows settings.

Parameters (1)

Name Type Required Description
options⚓︎ WindowsConfiguration

Configuration options.

createFlydown()⚓︎

(targetWindowId: string, config: FlydownOptions) => Promise<Flydown>

Creates a flydown window.

Parameters (2)

Name Type Required Description
targetWindowId⚓︎ string

ID of the window for which to create the flydown.
config⚓︎ FlydownOptions

Options for creating a flydown window.

createPopup()⚓︎

(options: CreatePopupOptions) => Promise<CreatePopupResult>

Creates a window to be used as a popup window. The created window will be frameless and hidden.

io.Connect Desktop 10.0

Parameters (1)

Name Type Required Description
options⚓︎ CreatePopupOptions

Options for creating a popup window.

find()⚓︎

(name: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => IOConnectWindow | undefined

Finds a window by name.

Parameters (3)

Name Type Required Description
name⚓︎ string

Unique window name.
success⚓︎ (window: IOConnectWindow) => void x

Callback function for handling the successfully returned result.
error⚓︎ (error: string) => void x

Callback function for handling errors.

findById()⚓︎

(id: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => IOConnectWindow | undefined

Finds a window by ID.

Parameters (3)

Name Type Required Description
id⚓︎ string

Window ID.
success⚓︎ (window: IOConnectWindow) => void x

Callback function for handling the successfully returned result.
error⚓︎ (error: string) => void x

Callback function for handling errors.

list()⚓︎

(success?: (windows: IOConnectWindow[]) => void) => IOConnectWindow[]

Lists all windows.

Parameters (1)

Name Type Required Description
success⚓︎ (windows: IOConnectWindow[]) => void x

Callback function for handling the successfully returned result.

my()⚓︎

() => IOConnectWindow | undefined

Retrieves the current window.

onArrangementChanged()⚓︎

(callback: (data: { areWindowsArranged: boolean; displayId: number; }) => void) => UnsubscribeFunction

Notifies when io.Connect Windows are arranged automatically or restored to their previous state using the autoArrange() method. The event will fire also when the user manually breaks the automatic window arrangement.

Parameters (1)

Name Type Required Description
callback⚓︎ (data: { areWindowsArranged: boolean; displayId: number; }) => void

Callback function for handling the event. Receives an object with areWindowsArranged and displayId properties. The areWindowsArranged flag will be set to true if the autoArrange() method is called initially for arranging the windows. When the method is called a second time for restoring the windows to their previous state, or the user manually breaks the window arrangement, the flag will be false.

onTabAttached()⚓︎

(callback: (tabWindow: IOConnectWindow, newTabGroupId: string, tabHeaderVisible: boolean) => void) => UnsubscribeFunction

Notifies when a tab window is attached to a tab group.

Parameters (1)

Name Type Required Description
callback⚓︎ (tabWindow: IOConnectWindow, newTabGroupId: string, tabHeaderVisible: boolean) => void

Callback function for handling the event.

onTabDetached()⚓︎

(callback: (window: IOConnectWindow, tabGroupId: string, oldTabGroupId: string) => void) => UnsubscribeFunction

Notifies when a tab window is detached from a tab group.

Parameters (1)

Name Type Required Description
callback⚓︎ (window: IOConnectWindow, tabGroupId: string, oldTabGroupId: string) => void

Callback function for handling the event.

onWindowAdded()⚓︎

(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a new window is opened.

Parameters (1)

Name Type Required Description
callback⚓︎ (window: IOConnectWindow) => void

Callback function for handling the event.

onWindowFrameColorChanged()⚓︎

(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when the window frame color is changed.

Parameters (1)

Name Type Required Description
callback⚓︎ (window: IOConnectWindow) => void

Callback function for handling the event.

onWindowGotFocus()⚓︎

(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a window receives focus.

Parameters (1)

Name Type Required Description
callback⚓︎ (window: IOConnectWindow) => void

Callback function for handling the event.

onWindowLostFocus()⚓︎

(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a window loses focus.

Parameters (1)

Name Type Required Description
callback⚓︎ (window: IOConnectWindow) => void

Callback function for handling the event.

onWindowRemoved()⚓︎

(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a window is closed.

Parameters (1)

Name Type Required Description
callback⚓︎ (window: IOConnectWindow) => void

Callback function for handling the event.

open()⚓︎

(name: string, url: string, options?: WindowCreateOptions, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Opens a new io.Connect Window.

Parameters (5)

Name Type Required Description
name⚓︎ string

Unique window name.
url⚓︎ string

URL to be loaded in the new window.
options⚓︎ WindowCreateOptions x

Options for creating a new window.
success⚓︎ (window: IOConnectWindow) => void x

Callback function for handling the successfully returned result.
error⚓︎ (error: string) => void x

Callback function for handling errors.

ready()⚓︎

() => Promise<any>

Notifies when the Window Management library has been fully initialized.

showPopup()⚓︎

(targetWindowId: string, config: PopupOptions) => Promise<void>

Shows a popup window. As of io.Connect Desktop 10.0, the popup window must be a frameless window.

Parameters (2)

Name Type Required Description
targetWindowId⚓︎ string

ID of the window for which to show the popup.
config⚓︎ PopupOptions

Options for showing a popup window.