io.Connect Browser

4.0.0

io.Connect Browser allows web apps to integrate with other apps that are part of the same io.Connect Browser project via a set of APIs. io.Connect Browser enables you to share data between apps, expose functionality, manage windows, notifications, and more.

Referencing

The @interopio/browser library is available both as a single JavaScript file, which you can include in your web apps using a <script> tag, and also as a module, which you can import in your apps:

<script type="text/javascript" src="browser.umd.js"></script>

Or:

import IOBrowser from "@interopio/browser";

Initialization

The @interopio/browser library attaches the IOBrowser() factory function to the global window object. Invoke this function to initialize the library and connect to the io.Connect Browser environment. The IOBrowser() factory function accepts an optional Config object as an argument, which you can use to provide settings for the library (e.g., initialize additional io.Connect libraries, configure the library behavior or some of its APIs). The factory function resolves with the initialized io.Connect API object, which you can use to access all available io.Connect APIs:

import IOBrowser from "@interopio/browser";
import IOWorkspaces from "@interopio/workspaces-api";

const initializeIOConnect = async () => {
  // Initializing the Workspaces API.
  const initOptions = {
    libraries: [IOWorkspaces]
  };

  // Use the initialized API object to access the io.Connect APIs.
  const io = await IOBrowser(initOptions);

  // Here, the library is already initialized and you can access all available io.Connect APIs.
  const myWorkspace = await io.workspaces.restoreWorkspace("My Workspace");
};

initializeIOConnect().catch(console.error);

Description

Describes an instance of the initialized io.Connect library.

Properties

Property	Type	Description
agm	API	Interop library.
appManager	API	App Management API.
channels	API	Channels API.
contexts	API	Contexts library.
info	object	Info object containing versions of all included libraries and io.Connect itself.
intents	API	Intents API.
interop	API	Interop library.
layouts	API	Layouts API.
modals	API	Modals API.
notifications	API	Notifications API.
prefs	API	App Preferences API.
search	API	Search API.
themes	API	Themes API.
version	string	io.Connect version.
windows	API	Window Management API.
workspaces	API	Workspaces API.

Methods

done

feedback

donemethod

Signature

() => Promise<void>

Description

Disposes the io.Connect API. This will remove all Interop methods and streams registered by the application.

feedbackmethod

Signature

(info?: FeedbackInfo) => void

Description

Brings up the IOConnect Desktop feedback dialog.

Parameters

Name	Type	Required	Description
info	FeedbackInfo

Description

Describes the configuration for the IOBrowser() factory function.

Properties

Property	Type	Default	Description
contexts	ContextsConfig		Settings for the Contexts API.
exposeAPI	boolean	true	Configures whether the library will share the initialized API object upon request via a custom web event.
intentResolver	IntentResolverUIConfig
intents	Config		Settings for the Intents Resolver UI.
libraries	((io: API, config?: Config \| IOConnectDesktop) => Promise<void>)[]		List of references to the factory functions of additional io.Connect libraries to be initialized internally (e.g., `&commat;interopio/workspaces-api`, `&commat;interopio/search-api`). The APIs provided by these libraries can then be accessed via the initialized io.Connect API object (e.g., `io.workspaces`, `io.search`).
memoizeAPI	boolean	false	If `true`, when the io.Connect API factory function is invoked more than once in the same app, it will return the already initialized API object instead of throwing an error.
modals	ModalsUIConfig		Settings for the io.Connect modals.
notifications	Settings		Settings for the Notifications API.
systemLogger	SystemLogger		Configures the system logger. Used mostly during development.
widget	WidgetConfig		Settings for the io.Connect widget.

Properties

Property	Type	Default	Description
awaitFactory	boolean	true	Whether to wait for IOBrowserIntentResolverUI factory to resolve
enable	boolean
timeout	number	5000	Timeout to wait for the IOBrowserIntentResolverUI factory to be fetched from the remote source

Properties

Property	Type	Default	Description
alerts	{ enabled: boolean; }		Settings for the io.Connect alerts.
awaitFactory	boolean	true	If `true`, the `&commat;interopio/browser` library will wait for the `IOBrowserModalsUI()` factory function to resolve before completing its initialization.
dialogs	{ enabled: boolean; }		Settings for the io.Connect dialogs.
timeout	number	5000	Interval in milliseconds to wait for the `IOBrowserModalsUI()` factory function to be fetched from the remote source.

Properties

Property	Type	Default	Required	Description
callback	(logInfo: any) => void
level	IOConnectCore

Description

Settings for the Channel Selector UI.

Properties

Property	Type	Default	Required	Description
displayMode	WidgetChannelsDisplayMode	"all"		Determines which of the available Channels to display (all or only FDC3 ones).
selector	WidgetChannelSelectorConfig			Settings for the Channel Selector UI.

Description

Settings for the Widget Channel Selector UI.

Properties

Property	Type	Default	Required	Description
enable	boolean	true		If `true`, will enable the Channel Selector UI in the widget.
type	WidgetChannelSelectorType	"default"		Type of the Channel Selector UI.

Description

Describes the configuration for the io.Connect widget.

Properties

Property	Type	Default	Description
awaitFactory	boolean	true	If `true`, the `&commat;interopio/browser` library will wait for the `IOBrowserWidget()` factory function to resolve before completing its initialization.
channels	WidgetChannels		Settings for the Channel Selector UI.
displayInWorkspace	boolean	false	If `true`, the widget will be visible in the app even if the app is currently in a Workspace.
enable	boolean		If `true`, will enable the widget for the Browser Client unless the app origin has been blocked in the Main app configuration.
mode	WidgetMode	"default"	Mode for displaying the widget.
position	WidgetPosition	"bottom"	Initial position for the widget within the window.
timeout	number	5000	Interval in milliseconds to wait for the `IOBrowserWidget()` factory function to be fetched from the remote source.