Methods
(static) connectSync(name, interopConfigopt) → {InteropClient}
Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | The name of the Interop Broker to connect to. For Platforms, this will default to the uuid of the Platform. |
|
interopConfig |
InteropConfig |
<optional> |
Information relevant to the Interop Broker. Typically a declaration of what context(s) the entity wants to subscribe to, and the current Context Group of the entity. |
- Tutorials:
Returns:
- Type
- InteropClient
(async, static) init(name, overrideopt) → {Promise.<InteropBroker>}
Initializes an Interop Broker. This is called under-the-hood for Platforms.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | Name of the Interop Broker. |
|
override |
OverrideCallback.<InteropBroker> |
<optional> |
A callback function that can be used to extend or replace default Interop Broker behavior. |
- Tutorials:
Returns:
- Type
- Promise.<InteropBroker>