@interopio/desktop API Reference

Describes an io.Connect Window.

Properties (43)

Property Type Default Required Description
allowWorkspaceDrop⚓︎ boolean x

If true, the user is able to drop the current window in a Workspace.
application⚓︎ Application | undefined x

The app associated with the current window. Can be undefined if the window wasn't started as an app.
appName⚓︎ string | undefined x

Name of the app associated with the current window. Can be undefined if the window wasn't started as an app.
bottomNeighbours⚓︎ IOConnectWindow[] x

Retrieves the bottom neighbors of the window.
bounds⚓︎ Bounds x

Retrieves the bounds of the window.
frameButtons⚓︎ ButtonInfo[] x

Retrieves all frame buttons.
frameColor⚓︎ string x

Retrieves the color of the window frame.
frameId⚓︎ string x

The ID of the frame in which the window is placed.
group⚓︎ Group x

Retrieves the group of the window.
groupId⚓︎ string x

Retrieves the ID of the group of the window.
hostInstance⚓︎ Instance | string x

Interop instance of the io.Connect Desktop library.
id⚓︎ string x

ID of the current window.
interopInstance⚓︎ Instance | undefined x

Interop instance of the window. Used for easier access to the Interop API.
isCollapsed⚓︎ boolean x

If true, the window is collapsed.
isFocused⚓︎ boolean x

If true, the window is on focus.
isGroupHeaderVisible⚓︎ boolean x

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

If true, the window is locked.
isPinned⚓︎ boolean x

Flag indicating whether the tab of the current window is pinned. Pinned tabs are placed before the regular tab windows and they contain only the window title. Pinned tab windows don't have a "Close" button, effectively preventing the user from closing them. Available only for tab windows in web groups.

io.Connect Desktop 9.5
isSticky⚓︎ boolean x

If true, the window is able to stick to other windows.
isTabHeaderVisible⚓︎ boolean x

If true, the tab header of the window is visible.
isTabSelected⚓︎ boolean x

If true, the tab window is selected.
isVisible⚓︎ boolean x

If true, the window is visible.
jumpList⚓︎ JumpList x

API for managing window jump lists.
leftNeighbours⚓︎ IOConnectWindow[] x

Retrieves the left neighbors of the window.
maxHeight⚓︎ number x

Retrieves the maximum height of the window in pixels.
maxWidth⚓︎ number x

Retrieves the maximum width of the window in pixels.
minHeight⚓︎ number x

Retrieves the minimum height of the window in pixels.
minWidth⚓︎ number x

Retrieves the minimum width of the window in pixels.
mode⚓︎ WindowMode x

Retrieves the mode of the window.
name⚓︎ string x

Name of the current window. Window names are unique within the framework.
opened⚓︎ boolean x

If true, the window is opened.
placementSettings⚓︎ PlacementSettings x

Retrieves the current placement settings.
rightNeighbours⚓︎ IOConnectWindow[] x

Retrieves the right neighbors of the window.
settings⚓︎ WindowSettings x

Settings of the current window.
state⚓︎ WindowState x

Retrieves the state of the window.
tabGroupId⚓︎ string x

ID of the tab group in which the current window is located.
tabIndex⚓︎ number x

Tab index of the current window.
tabs⚓︎ IOConnectWindow[] x

Retrieves all tabs that are in the same tab group as the current window. Available only when the window is in "tab" mode.
title⚓︎ string x

Title of the current window.
topNeighbours⚓︎ IOConnectWindow[] x

Retrieves the top neighbors of the window.
url⚓︎ string x

URL of the current window.
windowType⚓︎ "electron" | "remote" x

Type of the window.
zoomFactor⚓︎ number x

Retrieves the current zoom factor.

122 Methods

activate()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Activates the current window. This is the same as calling focus().

Parameters (2)

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

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

Callback function for handling errors.

addFrameButton()⚓︎

(buttonInfo: ButtonInfo, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Adds a frame button to the window.

Parameters (3)

Name Type Required Description
buttonInfo⚓︎ ButtonInfo

Frame button settings.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

attachTab()⚓︎

(tab: IOConnectWindow | string, options?: number | AttachOptions, success?: () => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Attaches a tab window to the current tab window.

Parameters (4)

Name Type Required Description
tab⚓︎ IOConnectWindow | string

The instance or the name of the tab window to attach.
options⚓︎ number | AttachOptions x

Settings for the attached tab.
success⚓︎ () => void x

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

Callback function for handling errors.

capture()⚓︎

(options: CaptureOptions) => Promise<string>

Captures a screenshot of the window.

Parameters (1)

Name Type Required Description
options⚓︎ CaptureOptions

Options for capturing the window.

center()⚓︎

(display?: Display) => Promise<IOConnectWindow>

Moves the window to the center of the screen.

Parameters (1)

Name Type Required Description
display⚓︎ Display x

Describes the display on which to center the window.

clearPlacement()⚓︎

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

Clears the window placement settings. This means that the window will no longer be automatically snapped to a specific position on the display in case of resolution, scaling, and monitor changes.

io.Connect Desktop 9.9

Parameters (1)

Name Type Required Description
options⚓︎ ClearPlacementSettings x

Settings for clearing the window placement.

clone()⚓︎

(options?: ApplicationStartOptions) => Promise<IOConnectWindow>

Duplicates the current io.Connect Window.

Parameters (1)

Name Type Required Description
options⚓︎ ApplicationStartOptions x

Optional start options that will override the default start options when cloning the window.

close()⚓︎

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

Closes the window.

Parameters (1)

Name Type Required Description
options⚓︎ CloseOptions x

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

close()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Parameters (2)

Name Type Required Description
success⚓︎ (window: IOConnectWindow) => void x x
error⚓︎ (error: string) => void x x

collapse()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Collapses a window.

Parameters (2)

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

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

Callback function for handling errors.

configure()⚓︎

(options: WindowConfiguration) => Promise<IOConnectWindow>

Configures the window.

Parameters (1)

Name Type Required Description
options⚓︎ WindowConfiguration

Configuration options.

createFlydown()⚓︎

(config: FlydownOptions) => Promise<Flydown>

Creates a flydown window.

Parameters (1)

Name Type Required Description
config⚓︎ FlydownOptions

Options for the flydown window.

detachTab()⚓︎

(opt: DetachOptions, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Detaches a tab window from the current tab window.

Parameters (3)

Name Type Required Description
opt⚓︎ DetachOptions

Settings for the detached window.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

dock()⚓︎

(options: DockingOptions) => Promise<DockingPlacement>

Docks the window at the specified position.

io.Connect Desktop 9.1.0

Parameters (1)

Name Type Required Description
options⚓︎ DockingOptions

Options for docking the window.

download()⚓︎

(url: string, options: DownloadOptions) => Promise<DownloadResult>

Downloads a file.

Parameters (2)

Name Type Required Description
url⚓︎ string

URL, data URL or blob which to download.
options⚓︎ DownloadOptions

Download options.

dragMove()⚓︎

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

This method can be used to start dragging the window with the mouse when the left mouse button is pressed.

io.Connect Desktop 9.9

Parameters (1)

Name Type Required Description
options⚓︎ DragMoveOptions x

Options for dragging the window. Use this argument to optionally provide the location of the mouse cursor within the window at the time the dragging operation was initiated. The platform will use that location to place the window under the mouse cursor when the mouse is moving (e.g., in case the mouse has already moved several pixels in any direction before the dragging operation has been initiated by the platform). If the starting mouse location isn't specified, its current position will be used.

executeCode()⚓︎

(code: string) => Promise<any>

Executes code in the context of the io.Connect Window.

io.Connect Desktop 9.5

Parameters (1)

Name Type Required Description
code⚓︎ string

Code to be executed in the context of the window. The code must be supplied as a string.

expand()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Expands a window.

Parameters (2)

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

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

Callback function for handling errors.

flash()⚓︎

(options?: boolean, mode?: FlashMode) => Promise<IOConnectWindow>

Makes the taskbar window icon flash (e.g., to prompt the user to take action).

Parameters (2)

Name Type Required Description
options⚓︎ boolean x

Flag indicating whether to start or stop flashing the taskbar window icon. Defaults to true.
mode⚓︎ FlashMode x

Mode for determining the flashing behavior of the window taskbar icon.

flashTab()⚓︎

(options?: boolean) => Promise<IOConnectWindow>

Makes the tab of the window flash (e.g., to prompt the user to take action).

Parameters (1)

Name Type Required Description
options⚓︎ boolean x

Flag indicating whether to start or stop flashing the window tab. Defaults to true.

focus()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Focuses the current window. This is the same as calling activate().

Parameters (2)

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

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

Callback function for handling errors.

getApplication()⚓︎

() => Promise<Application | undefined>

Retrieves the application associated with the current window.

getBounds()⚓︎

() => Promise<Bounds>

Retrieves the window bounds.

getButtons()⚓︎

() => Promise<WindowButtons>

Retrieves the visible buttons of the window frame.

getChannel()⚓︎

() => Promise<string | undefined>

Retrieves the name of the currently joined Channel, if any.

getChannels()⚓︎

() => Promise<string[]> | undefined

Retrieves the names of all currently joined Channels, if any.

io.Connect Desktop 10.0

getChildWindows()⚓︎

() => Promise<IOConnectWindow[]>

Retrieves all child windows of the window.

getConfiguration()⚓︎

() => Promise<WindowConfiguration>

Retrieves the window configuration.

getContext()⚓︎

() => Promise<any>

Retrieves the window context.

getDisplay()⚓︎

() => Promise<Display>

Retrieves the display on which the window is located.

getDockingConfig()⚓︎

() => Promise<DockingConfig>

Retrieves the current docking configuration for the window as specified in the app definition or as previously set via the setDockingConfig() method.

io.Connect Desktop 10.0

getDockingPlacement()⚓︎

() => Promise<DockingPlacement>

Retrieves the docking placement information for the current window.

io.Connect Desktop 9.1.0

getIcon()⚓︎

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

Retrieves the window icon.

Parameters (2)

Name Type Required Description
success⚓︎ (icon: string) => void x

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

Callback function for handling errors.

getParentWindow()⚓︎

() => Promise<IOConnectWindow | undefined>

Retrieves the parent window of the window.

getSizeConstraints()⚓︎

() => Promise<SizeConstraints>

Retrieves the size constraints of the window.

getTabTooltip()⚓︎

() => Promise<string>

Retrieves the tooltip of a tab window.

getTitle()⚓︎

() => Promise<string>

Retrieves the window title.

getURL()⚓︎

() => Promise<string>

Retrieves the window URL.

goBack()⚓︎

() => Promise<void>

Makes the window navigate back to the previous web page.

goForward()⚓︎

() => Promise<void>

Makes the window navigate forward to the next web page.

hide()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Hides the current window.

Parameters (2)

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

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

Callback function for handling errors.

hideLoader()⚓︎

() => Promise<IOConnectWindow>

Hides the loader animation for the window.

joinChannel()⚓︎

(name: string) => Promise<void>

Joins a new Channel.

Parameters (1)

Name Type Required Description
name⚓︎ string

The name of the Channel to join.

leaveChannel()⚓︎

() => Promise<void>

Leaves the current Channel.

lock()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Locks the window. When in locked state, moving the window will result in moving the entire group (if it's part of any).

Parameters (2)

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

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

Callback function for handling errors.

maximize()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Maximizes a window.

Parameters (2)

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

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

Callback function for handling errors.

maximizeRestore()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Maximizes or restores the current window based on the current window state.

Parameters (2)

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

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

Callback function for handling errors.

minimize()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Minimizes a window.

Parameters (2)

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

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

Callback function for handling errors.

moveResize()⚓︎

(dimension: Partial<Bounds>, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Moves and/or resizes the window.

Parameters (3)

Name Type Required Description
dimension⚓︎ Partial<Bounds>

Location and size for the window.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

moveTo()⚓︎

(top?: number, left?: number) => Promise<IOConnectWindow>

Moves a window to the specified position on the screen.

Parameters (2)

Name Type Required Description
top⚓︎ number x

Distance in pixels from the top edge of the screen for the top window border.
left⚓︎ number x

Distance in pixels from the left edge of the screen for the left window border.

navigate()⚓︎

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

Navigates the window to a new URL.

Parameters (3)

Name Type Required Description
url⚓︎ string

URL to which to navigate.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

navigate()⚓︎

(url: string, options?: LoadURLOptions) => Promise<IOConnectWindow>

Parameters (2)

Name Type Required Description
url⚓︎ string x
options⚓︎ LoadURLOptions x x

onAttached()⚓︎

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

Notifies when the current window is attached to another window.

Parameters (1)

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

Callback function for handling the event.

onBoundsChanged()⚓︎

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

Notifies when the window bounds are changed.

Parameters (1)

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

Callback function for handling the event.

onChannelRestrictionsChanged()⚓︎

(callback: (restrictions: Restrictions) => void) => () => void

Notifies when the restrictions for any existing Channel have changed. Returns an unsubscribe function.

io.Connect Desktop 9.5

Parameters (1)

Name Type Required Description
callback⚓︎ (restrictions: Restrictions) => void

Callback function for handling the event.

onClose()⚓︎

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

Notifies when the window is closed.

Parameters (1)

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

Callback function for handling the event.

onClosing()⚓︎

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

Notifies when the window 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 is closed. The timeout for waiting is subject to configuration in io.Connect Desktop. A function for preventing the closing is passed to the callback as a parameter.

onCollapsed()⚓︎

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

Notifies when the window is collapsed.

Parameters (1)

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

Callback function for handling the event.

onContextUpdated()⚓︎

(callback: (context: any, window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when the window context is updated.

Parameters (1)

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

Callback function for handling the event.

onDetached()⚓︎

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

Notifies when the current window is detached from another window.

Parameters (1)

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

Callback function for handling the event.

onDockingChanged()⚓︎

(callback: (window: IOConnectWindow, dockingPlacement: DockingPlacement) => void) => UnsubscribeFunction

Notifies when the window docking placement is changed.

io.Connect Desktop 9.1.0

Parameters (1)

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

Callback function for handling the event.

onExpanded()⚓︎

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

Notifies when the window is expanded.

Parameters (1)

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

Callback function for handling the event.

onFocusChanged()⚓︎

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

Notifies when the window focus is changed.

Parameters (1)

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

Callback function for handling the event.

onFrameButtonAdded()⚓︎

(callback: (buttonInfo: ButtonInfo, window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a frame button is added.

Parameters (1)

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

Callback function for handling the event.

onFrameButtonClicked()⚓︎

(callback: (buttonInfo: ButtonInfo, window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a frame button is clicked.

Parameters (1)

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

Callback function for handling the event.

onFrameButtonRemoved()⚓︎

(callback: (buttonInfo: ButtonInfo, window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when a frame button is removed.

Parameters (1)

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

Callback function for handling the event.

onFrameColorChanged()⚓︎

(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.

onGroupChanged()⚓︎

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

Notifies when the window group is changed.

Parameters (1)

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

Callback function for handling the event.

onLockingChanged()⚓︎

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

Notifies when the window is locked or unlocked.

Parameters (1)

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

Callback function for handling the event.

onMaximized()⚓︎

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

Notifies when the window is maximized.

Parameters (1)

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

Callback function for handling the event.

onMinimized()⚓︎

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

Notifies when the window is minimized.

Parameters (1)

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

Callback function for handling the event.

onNavigating()⚓︎

(callback: (args: { newUrl: string }) => Promise<void>) => UnsubscribeFunction

Notifies when the window is about to be navigated to a new URL.

Parameters (1)

Name Type Required Description
callback⚓︎ (args: { newUrl: string }) => Promise<void>

Callback function for handling the event.

onNeighboursChanged()⚓︎

(callback: (neighbours: Neighbours, window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when the neighbors of the window are changed.

Parameters (1)

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

Callback function for handling the event.

onNormal()⚓︎

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

Notifies when the window is restored from minimized or maximized state to normal state.

Parameters (1)

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

Callback function for handling the event.

onPlacementSettingsChanged()⚓︎

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

Notifies when the placement settings for the window are changed.

Parameters (1)

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

Callback function for handling the event.

onRefreshing()⚓︎

(callback: (prevent: () => void) => Promise<void>) => UnsubscribeFunction

Notifies when the window is about to be refreshed.

Parameters (1)

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

Callback function for handling the event. Returns a Promise that will be awaited before the window is refreshed. The timeout for waiting is subject to configuration in io.Connect Desktop. A function for preventing the refresh is passed to the callback as a parameter.

onStickyChanged()⚓︎

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

Notifies when the window stickiness is changed.

Parameters (1)

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

Callback function for handling the event.

onTabHeaderVisibilityChanged()⚓︎

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

Notifies when the visibility of the window tab header changes.

Parameters (1)

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

Callback function for handling the event.

onTabSelectionChanged()⚓︎

(callback: (selectedWindow: IOConnectWindow, previousWindow: IOConnectWindow, window: IOConnectWindow) => void) => UnsubscribeFunction

Notifies when the active tab is changed.

Parameters (1)

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

Callback function for handling the event.

onTitleChanged()⚓︎

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

Notifies when the title of the window is changed.

Parameters (1)

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

Callback function for handling the event.

onUrlChanged()⚓︎

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

Notifies when the window URL is changed.

Parameters (1)

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

Callback function for handling the event.

onVisibilityChanged()⚓︎

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

Notifies when the window visibility changes.

Parameters (1)

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

Callback function for handling the event.

onWindowAttached()⚓︎

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

Notifies when a window is attached to the current window.

Parameters (1)

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

Callback function for handling the event.

onWindowDetached()⚓︎

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

Notifies when a window is detached from the current window.

Parameters (1)

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

Callback function for handling the event.

onZoomFactorChanged()⚓︎

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

Notifies when the zoom factor is changed.

Parameters (1)

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

Callback function for handling the event.

pin()⚓︎

() => Promise<IOConnectWindow>

Pins the tab of the current window. Pinned tabs are placed before the regular tab windows and contain only the window title. Pinned tab windows don't have a "Close" button preventing the user from closing them. Available only for tab windows in web groups.

io.Connect Desktop 9.5

place()⚓︎

(options: PlacementSettings) => Promise<void>

Places the window at the specified position.

Parameters (1)

Name Type Required Description
options⚓︎ PlacementSettings

Window placement settings.

print()⚓︎

(options?: PrintOptions) => Promise<IOConnectWindow | undefined>

Prints the window web page.

Parameters (1)

Name Type Required Description
options⚓︎ PrintOptions x

Print options.

printToPDF()⚓︎

(options?: PrintToPDFOptions) => Promise<string | undefined>

Prints the window web page as a PDF file.

Parameters (1)

Name Type Required Description
options⚓︎ PrintToPDFOptions x

Print to PDF options.

refresh()⚓︎

(ignoreCache?: boolean) => Promise<IOConnectWindow>

Refreshes the current window.

Parameters (1)

Name Type Required Description
ignoreCache⚓︎ boolean x

Flag indicating whether to use the Chromium cache (if false), or the server cache (if true) when refreshing the web page. Defaults to false.

removeFrameButton()⚓︎

(buttonId: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Removes a frame button from the window.

Parameters (3)

Name Type Required Description
buttonId⚓︎ string

ID of the button to remove.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

resetButtons()⚓︎

(buttons: WindowButtons, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Resets the visible buttons of the window frame.

Parameters (3)

Name Type Required Description
buttons⚓︎ WindowButtons

Describes which buttons to be shown on the window frame.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

resizeTo()⚓︎

(width?: number, height?: number) => Promise<IOConnectWindow>

Resizes a window to the specified size.

Parameters (2)

Name Type Required Description
width⚓︎ number x

Width in pixels to which to resize the window.
height⚓︎ number x

Height in pixels to which to resize the window.

restore()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Restores a window.

Parameters (2)

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

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

Callback function for handling errors.

setAllowWorkspaceDrop()⚓︎

(allow: boolean) => Promise<IOConnectWindow>

Specifies whether the user will able to drop the current window in a Workspace.

Parameters (1)

Name Type Required Description
allow⚓︎ boolean

Flag indicating whether the user will be able to drop the window in a Workspace.

setContext()⚓︎

(context: any) => Promise<IOConnectWindow>

Sets the window context.

Parameters (1)

Name Type Required Description
context⚓︎ any x

setDockingConfig()⚓︎

(config: DockingConfig) => Promise<void>

Sets the docking configuration for the window. This will override the docking configuration specified in the app definition.

io.Connect Desktop 10.0

Parameters (1)

Name Type Required Description
config⚓︎ DockingConfig

Docking settings.

setFrameColor()⚓︎

(frameColor: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Sets the window frame color.

Parameters (3)

Name Type Required Description
frameColor⚓︎ string

Can be a color name, such as "red", or a hexadecimal RGB or ARGB value.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

setIcon()⚓︎

(base64Image: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Sets the window icon.

Parameters (3)

Name Type Required Description
base64Image⚓︎ string

Icon as a Base64 string.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

setModalState()⚓︎

(isModal: boolean) => Promise<void>

Makes a window behave like a modal window when it's used as a flydown.

Parameters (1)

Name Type Required Description
isModal⚓︎ boolean

Flag indicating whether the modal behavior is to be turned on or off.

setOnTop()⚓︎

(onTop: boolean | "always", success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Z-index setting for the window.

Parameters (3)

Name Type Required Description
onTop⚓︎ boolean | "always"

If true is passed as an argument, the window will be set on top of the Z-order. This, however, will last only until the window is visible and not joined to an io.Connect Window group. If the window is hidden programmatically or the user snaps it to another io.Connect Window or window group, it will no longer be on top of the Z-order when it becomes visible or when the user tears it off from the group. If "always" is passed, the window will remain permanently on top of the Z-order, regardless of changes to its visibility or whether it joins or leaves an io.Connect Window group. Note that because each io.Connect app window is in fact in an io.Connect Window group container (even though being a single window), the onTop setting actually determines the Z-order of the group container at the moment of its creation. Snapping an io.Connect Window to another io.Connect Window in reality destroys the group container of the snapped window and that window joins the group container of the window to which it is being snapped. Therefore, when joining a window with a specified onTop setting to another window or a window group, its initial onTop value will be overwritten - either permanently (when set to true), or temporarily (when set to "always").
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

setSizeConstraints()⚓︎

(constraints: SizeConstraints, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Changes the size constraints of the window.

Parameters (3)

Name Type Required Description
constraints⚓︎ SizeConstraints

Minimum and maximum width and height constraints for the window in pixels.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

setSticky()⚓︎

(isSticky: boolean, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Enables or disables the stickiness of the current window.

Parameters (3)

Name Type Required Description
isSticky⚓︎ boolean

Flag indicating whether the window will be able to stick to other windows.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

setTabHeaderVisible()⚓︎

(toBeVisible?: boolean, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Hides or shows the tab header of the current window.

Parameters (3)

Name Type Required Description
toBeVisible⚓︎ boolean x

Flag indicating whether to show or hide the tab header.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

setTabTooltip()⚓︎

(tabTooltip: string) => Promise<IOConnectWindow>

Changes the tooltip of a tab window.

Parameters (1)

Name Type Required Description
tabTooltip⚓︎ string

Text to be used as a tooltip.

setTitle()⚓︎

(title: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Sets the title of the current window.

Parameters (3)

Name Type Required Description
title⚓︎ string

New title for the window.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

setVisible()⚓︎

(toBeVisible?: boolean, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Hides or shows the current window.

Parameters (3)

Name Type Required Description
toBeVisible⚓︎ boolean x

Flag indicating whether the window will become visible or hidden.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

setZoomFactor()⚓︎

(factor: number) => Promise<IOConnectWindow>

Changes the zoom level.

Parameters (1)

Name Type Required Description
factor⚓︎ number

Zoom factor.

show()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Shows the current window.

Parameters (2)

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

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

Callback function for handling errors.

showDialog()⚓︎

<T>(options: DialogOptions) => Promise<T | DialogResult>

Shows a dialog with a title, message and response buttons to the user.

Parameters (1)

Name Type Required Description
options⚓︎ DialogOptions

Options for the dialog.

showLoader()⚓︎

(options?: Loader) => Promise<IOConnectWindow>

Shows a loader animation for the window or updates the loader properties (animation type, background or text).

Parameters (1)

Name Type Required Description
options⚓︎ Loader x

Settings for the loader animation.

showPopup()⚓︎

(config: PopupOptions) => Promise<IOConnectWindow>

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

Parameters (1)

Name Type Required Description
config⚓︎ PopupOptions

Options for showing a popup window.

snap()⚓︎

(target: string | IOConnectWindow, options?: SnappingOptions | RelativeDirection, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Snaps the window to another window.

Parameters (4)

Name Type Required Description
target⚓︎ string | IOConnectWindow

ID or instance of the window to which to snap the current window.
options⚓︎ SnappingOptions | RelativeDirection x

Relative direction or options for snapping a window to another window or window group.
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

startDrag()⚓︎

(options: StartDragOptions) => Promise<IOConnectWindow>

Enables moving files from a web page to the OS when a user starts dragging a web page element. Based on the Electron Native File Drag & Drop functionality.

Parameters (1)

Name Type Required Description
options⚓︎ StartDragOptions

Options for the file that will be moved.

toggleCollapse()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Collapses or expands the current window based on the current window state.

Parameters (2)

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

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

Callback function for handling errors.

undock()⚓︎

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

Undocks the window if it is already docked.

io.Connect Desktop 10.0

Parameters (1)

Name Type Required Description
options⚓︎ UndockingOptions x

Options for undocking the window.

ungroup()⚓︎

(options?: UngroupOptions) => Promise<IOConnectWindow | undefined>

Extracts the current window from the window group. If the window is part of a tab group, the entire tab group will be extracted.

Parameters (1)

Name Type Required Description
options⚓︎ UngroupOptions x

Settings for the extracted window.

unlock()⚓︎

(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Unlocks the window. When in unlocked state, moving the window will result in tearing it out from the window group (if it's part of any).

Parameters (2)

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

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

Callback function for handling errors.

unpin()⚓︎

() => Promise<IOConnectWindow>

Unpins the tab of the current window. The previously pinned tab reverts to a normal tab window containing a "Close" button. Available only for tab windows in web groups.

io.Connect Desktop 9.5

updateContext()⚓︎

(context: any, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>

Updates the window context.

Parameters (3)

Name Type Required Description
context⚓︎ any

Context object with which to update the current context (or create a new one if it doesn't exist).
success⚓︎ (window: IOConnectWindow) => void x

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

Callback function for handling errors.

zoomIn()⚓︎

() => Promise<IOConnectWindow>

Zooms in the window.

zoomOut()⚓︎

() => Promise<IOConnectWindow>

Zooms out the window.