@interopio/desktop API Reference

Access via:io.appManager.myInstance

Describes an app instance.

Properties (4)

Property Type Default Required Description
application⚓︎ Application x

The app object of the instance.
id⚓︎ string x

App instance ID.
interopInstance⚓︎ Instance x

Access to the Interop instance. Use this to invoke Interop methods for the app instance.
title⚓︎ string | undefined x

Title of the app instance.

7 Methods

activate()⚓︎

() => Promise<InvocationResult<any>>

Activates the app instance.

getContext()⚓︎

() => Promise<Record<string, any>>

Retrieves the starting context of the instance.

getWindow()⚓︎

() => Promise<IOConnectWindow>

Retrieves the window object corresponding to the app instance.

onInteropReady()⚓︎

(callback: (instance: Instance) => any) => UnsubscribeFunction

Notifies when the Interop library is ready to be used.

Parameters (1)

Name Type Required Description
callback⚓︎ (instance: Instance) => any

Callback function for handling the event.

onStopped()⚓︎

(callback: (instance: Instance) => any) => UnsubscribeFunction

Notifies when the instance is stopped.

Parameters (1)

Name Type Required Description
callback⚓︎ (instance: Instance) => any

Callback function for handling the event.

startedBy()⚓︎

() => Promise<StartedByInfo>

Retrieves information about how the current app instance was started, and about the identity of the initiator.

io.Connect Desktop 9.3

stop()⚓︎

() => Promise<void>

Stops the app instance.