@interopio/desktop API Reference

Apps

⚠️ Note that the Apps API is still an experimental feature. This means that it may have hidden issues and may be subject to changes in future releases.

The Apps API is designed to replace the legacy App Management API accessible via the io.appManager object. The legacy App Management API is still supported, but will be entirely removed in a future release. It's highly recommended to migrate to the new Apps API.

The Apps API provides a modern, fully asynchronous way to manage io.Connect Desktop apps. It offers abstractions for:

  • App - a program as a logical entity, registered in io.Connect Desktop with some metadata (name, description, icon, etc.) and with all the configuration needed to spawn one or more instances of it. The Apps API provides facilities for retrieving app metadata and for detecting when an app is started.

  • Instance - a running copy of an app. The Apps API provides facilities for starting/stopping app instances and tracking app-related events.

The Apps API is accessible via the io.apps object.

Available since io.Connect Desktop 10.0.