Class: Fdc3

Fdc3

The FDC3 Client Library provides a set APIs to be used for FDC3 compliance, while using our Interop API under the hood. In order to use this set of APIs you will need to setup your own InteropBroker or use a Platform application, which does the setup for you. Refer to our documentation on our Interop API.

Methods

(async, static) addContextListener(handler, contextType) → {Promise.<Unsubscribe>}

EXPERIMENTAL

Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts.

Parameters:
Name Type Description
handler ContextHandler

Handler for incoming context.
contextType string

The type of context you wish to handle.
Tutorials:
Returns:
Type
Promise.<Unsubscribe>

(async, static) broadcast(context) → {Promise.<void>}

EXPERIMENTAL

Broadcasts a context for the channel of the current entity.

Parameters:
Name Type Description
context Context

New context to set.
Tutorials:
Returns:
Type
Promise.<void>

(async, static) getSystemChannels() → {Promise.<Array.<ContextGroupInfo>>}

EXPERIMENTAL

Returns the Interop-Broker-defined context groups available for an entity to join.

Tutorials:
Returns:
Type
Promise.<Array.<ContextGroupInfo>>

(async, static) joinChannel(contextGroupId, targetopt) → {Promise.<void>}

EXPERIMENTAL

Join all Interop Clients at the given identity to context group contextGroupId. If no target is specified, it adds the sender to the context group. Because multiple Channel connections/Interop Clients can potentially exist at a uuid/name combo, we currently join all Channel connections/Interop Clients at the given identity to the context group. If an endpointId is provided (which is unlikely, unless the call is coming from an external adapter), then we only join that single connection to the context group. For all intents and purposes, there will only be 1 connection present in Platform and Browser implementations, so this point is more-or-less moot.

Parameters:
Name Type Attributes Description
contextGroupId string

Id of the context group.
target Identity <optional>

Identity of the entity you wish to join to a context group.
Tutorials:
Returns:
Type
Promise.<void>

(async, static) leaveCurrentChannel(targetopt) → {Promise.<void>}

EXPERIMENTAL

Removes the specified target from a context group. If no target is specified, it removes the sender from their context group.

Parameters:
Name Type Attributes Description
target Identity <optional>

Identity of the entity you wish to join to a context group.
Tutorials:
Returns:
Type
Promise.<void>