@interopio/desktop API Reference

Settings for the Channel Selector UI.

Properties (4)

Property Type Default Required Description
channelId⚓︎ string x x

Name of the Channel to which the window will be joined by default when it's started.
enabled⚓︎ boolean false x

If true, will allow showing the Channel Selector.
readOnly⚓︎ boolean false x

If true, the Channel Selector will be visible, but the user won't be able to switch between Channels from it.
type⚓︎ "single" | "directionalSingle" | "multi" | "directionalMulti" "single" x

Type of the Channel Selector to show on the io.Connect Windows. The single Channel Selector (default) allows the window to join a single Channel to which it can subscribe and publish data unrestrictedly. The directional single Channel Selector allows the window to join a single Channel, but also enables the user to restrict the window from publishing or from subscribing to the current Channel. The multi Channel Selector allows the window to join multiple Channels simultaneously to which it can subscribe and publish data unrestrictedly. The directional multi Channel Selector allows the window to join multiple Channels, but also enables the user to restrict the window from publishing or from subscribing to the currently joined Channels.