@interopio/desktop API Reference

Access via:io.windows.groups.my

Describes a window group.

Properties (5)

Property Type Default Required Description
id⚓︎ string x

ID of the current group.
isHeaderVisible⚓︎ boolean x

If true, the header of the group is visible.
isHibernated⚓︎ boolean x

If true, the window group is hibernated.
isVisible⚓︎ boolean x

If true, the window group is visible.
windows⚓︎ IOConnectWindow[] x

Lists all windows in the group.

18 Methods

capture()⚓︎

(options?: CaptureOptions) => Promise<string>

Captures the entire window group as a Base64 string.

Parameters (1)

Name Type Required Description
options⚓︎ CaptureOptions x

Options for capturing the window group.

close()⚓︎

(options?: CloseOptions) => Promise<void>

Closes the window group.

io.Connect Desktop 9.3

Parameters (1)

Name Type Required Description
options⚓︎ CloseOptions x

Options for closing the group that can be used to prevent closing the group and control whether to show a confirmation dialog before closing it.

find()⚓︎

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

Finds a window by ID or by a window object.

Parameters (2)

Name Type Required Description
window⚓︎ string | IOConnectWindow

Window ID or a window object by which to find a window in the group.
success⚓︎ (window: IOConnectWindow) => void x

Callback function for handling the successfully returned result.

getTitle()⚓︎

() => Promise<string>

Returns the current title of the window group.

hide()⚓︎

() => Promise<void>

Hides a window group.

hideHeader()⚓︎

(success?: (group: Group) => void, error?: (error: string) => void) => Promise<Group>

Hides the window group header.

Parameters (2)

Name Type Required Description
success⚓︎ (group: Group) => void x

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

Callback function for handling errors.

maximize()⚓︎

(success?: (group: Group) => void, error?: (error: string) => void) => void

Maximizes a window group.

Parameters (2)

Name Type Required Description
success⚓︎ (group: Group) => void x

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

Callback function for handling errors.

onClosing()⚓︎

(callback: (prevent: (options?: PreventClosingOptions) => void) => Promise<void>) => UnsubscribeFunction

Notifies when the window group is about to be closed.

Parameters (1)

Name Type Required Description
callback⚓︎ (prevent: (options?: PreventClosingOptions) => void) => Promise<void>

Callback function for handling the event. Returns a Promise that will be awaited before the window group is closed. The timeout for waiting is 30 seconds. A function for preventing the closing is passed to the callback as a parameter.

onHeaderVisibilityChanged()⚓︎

(callback: (group: Group) => void) => UnsubscribeFunction

Notifies when the visibility of the window group header is changed.

Parameters (1)

Name Type Required Description
callback⚓︎ (group: Group) => void

Callback function for handling the event.

onVisibilityChanged()⚓︎

(callback: (group: Group) => void) => UnsubscribeFunction

Notifies when the visibility of a window group is changed.

Parameters (1)

Name Type Required Description
callback⚓︎ (group: Group) => void

Callback function for handling the event.

onWindowAdded()⚓︎

(callback: (group: Group, window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a new window is added to the group.

Parameters (1)

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

Callback function for handling the event.

onWindowRemoved()⚓︎

(callback: (group: Group, window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a window is removed from the group.

Parameters (1)

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

Callback function for handling the event.

reload()⚓︎

() => Promise<void>

Reloads a window group. Available only for web groups.

restore()⚓︎

(success?: (group: Group) => void, error?: (error: string) => void) => void

Restores a window group.

Parameters (2)

Name Type Required Description
success⚓︎ (group: Group) => void x

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

Callback function for handling errors.

setTitle()⚓︎

(title: string) => Promise<Group>

Changes the title of the window group.

Parameters (1)

Name Type Required Description
title⚓︎ string

New title for the window group.

show()⚓︎

(activate?: boolean) => Promise<void>

Shows a previously hidden window group.

Parameters (1)

Name Type Required Description
activate⚓︎ boolean x

Flag indicating whether to activate the group and focus the last focused app window.

showHeader()⚓︎

(success?: (group: Group) => void, error?: (error: string) => void) => Promise<Group>

Shows the window group header.

Parameters (2)

Name Type Required Description
success⚓︎ (group: Group) => void x

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

Callback function for handling errors.

showPopup()⚓︎

(config: PopupOptions) => Promise<void>

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

io.Connect Desktop 9.3

Parameters (1)

Name Type Required Description
config⚓︎ PopupOptions

Options for showing a popup window.