@interopio/desktop API Reference

Optional configuration object for initializing the io.Connect library.

Properties (19)

Property Type Default Required Description
application⚓︎ string x x

Application name. If not specified, the value depends on the hosting environment. For the browser - document.title + random number (e.g., ClientList321333). In desktop - containerName + browserWindowName (e.g., Internal.ClientList).
appManager⚓︎ boolean | Mode "startOnly" x

Initializes or disables the App Management API. You can also specify mode in which that App Management API will be initialized.
apps⚓︎ boolean false x

Initializes or disables the Apps API.
auth⚓︎ Auth | string x x

Authentication can use one of the following flows:

  • username/password;
  • token - access tokens can be generated after successful login from the Auth Provider (e.g., Auth0);
  • gatewayToken - Gateway tokens are time limited tokens generated by the Gateway after an explicit request. To generate one, use the io.connection.authToken() method;
  • sspi - using sessionId and authentication challenge callback;
bus⚓︎ boolean x x

Enable or disable the Pub/Sub API.
channels⚓︎ boolean | Configuration false x

Initializes or disables the Channels API.
contexts⚓︎ boolean | ContextsConfig x x

Enable, disable and configure the Contexts API.
customLogger⚓︎ CustomLogger x x

Pass this to override the build-in logger and handle logging on your own
displays⚓︎ boolean true x

Initializes or disables the Displays API.
exposeAPI⚓︎ boolean true x

Determines whether io.Connect will share the initialized API object upon request via a custom web event.
gateway⚓︎ GatewayConfig x x

Configurations for the io.Connect Gateway connection.
identity⚓︎ { [key: string]: string | number | boolean } x x

Specify custom identity fields. Those can also override some of the system fields assigned
insights⚓︎ boolean | Settings x x

io.Insights settings for metrics, tracing and logging.
intents⚓︎ Config x x

Configuration for the Intents Resolver UI.
layouts⚓︎ boolean | Mode | Configuration "slim" x

Initializes or disables the Layouts API. You can also specify mode and configuration with which that Layouts API will be initialized.
libraries⚓︎ ((io: API, config?: Config) => Promise<void>)[] x x

A list of io.Connect factory functions that will be initialized internally to provide access to specific functionalities.
logger⚓︎ LogLevel | LoggerConfig x x

Defines logging levels per output target.
metrics⚓︎ boolean | MetricsConfig x x

Metrics configurations.
windows⚓︎ boolean true x

Initializes or disables the Window Management API.