@interopio/desktop API Reference

Access via:io.windows.groups

API for managing window groups.

Properties (1)

Property Type Default Required Description
my⚓︎ Group x

Returns the current group of the window.

12 Methods

close()⚓︎

(group: Group | string, options?: CloseOptions) => Promise<void>

Closes a window group.

io.Connect Desktop 9.3

Parameters (2)

Name Type Required Description
group⚓︎ Group | string

The Group object or the ID of the window group to be closed.
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.

create()⚓︎

(options: CreateGroupsOptions) => Promise<Group[]>

Creates window groups.

io.Connect Desktop 9.3

Parameters (1)

Name Type Required Description
options⚓︎ CreateGroupsOptions

Options for creating window groups.

findGroupByWindow()⚓︎

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

Finds a group by a provided window object or window ID.

Parameters (3)

Name Type Required Description
winId⚓︎ string | IOConnectWindow

An io.Connect Window object or a window ID by which to find a window group.
success⚓︎ (group: Group) => void x

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

Callback function for handling errors.

getMyGroup()⚓︎

() => Promise<Group>

Retrieves the current window group.

io.Connect Desktop 9.3

hibernate()⚓︎

(groupId: string) => Promise<string>

Hibernates a window group.

Parameters (1)

Name Type Required Description
groupId⚓︎ string

ID of the window group to hibernate.

list()⚓︎

(success?: (groups: Group[]) => void) => Group[]

Lists all window groups.

Parameters (1)

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

Callback function for handling the successfully returned result.

onGroupAdded()⚓︎

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

Notifies when a new window group is added.

Parameters (1)

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

Callback function for handling the event.

onGroupRemoved()⚓︎

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

Notifies when a window group is removed.

Parameters (1)

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

Callback function for handling the event.

onHibernated()⚓︎

(callback?: (groupId: string) => void) => () => void

Notifies when a window group is hibernated.

Parameters (1)

Name Type Required Description
callback⚓︎ (groupId: string) => void x

Callback function for handling the event.

onResumed()⚓︎

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

Notifies when a window group is resumed.

Parameters (1)

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

Callback function for handling the event.

resume()⚓︎

(groupId: string, activate?: boolean) => Promise<void>

Resumes a previously hibernated window group.

Parameters (2)

Name Type Required Description
groupId⚓︎ string

ID of the window group to resume.
activate⚓︎ boolean x

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

waitForGroup()⚓︎

(groupId: string) => Promise<Group>

Waits for a group to be loaded.

Parameters (1)

Name Type Required Description
groupId⚓︎ string

ID of the group to be awaited.