FDC3 Technical Reference
Summary
- FDC3 Options are to used configure FDC3
- FDC3 API provides runtime programmatic access to FDC3
- FDC3 Message Event is fired whenver an FDC3 Message is sent or received
FDC3 Options
The FDC3 Options section of Adaptable Options is the primary way to configure and manage FDC3:
| Property | Description | Default |
|---|---|---|
| actionColumnDefaultConfiguration | Configures the default FDC3 Actions column | |
| contexts | Configures FDC3 standard Contexts that AdapTable will listen for and broadcast | |
| enableLogging | Enable logging message exchanges to Console | false |
| gridDataContextMapping | Maps Context Type to AdapTable Grid Data | |
| intents | Configures FDC3 standard Intents that AdapTable will listen for and raise | |
| resolveContextData | Builds Context Data (useful for postprocessing Context Data mapped from Grid data) | |
| uiControlsDefaultConfiguration | Customises FDC3 UI Controls |
FDC3 Intent Options
The FDC3 Intent Options property handles FDC3 Intents behaviour:
| Property | Description |
|---|---|
| handleIntent | Handles incoming Intents (standard and custom) |
| handleIntentResolution | Handles the IntentResolution that a raised Intent might return |
| listensFor | Subscribe to given standard Intent(s) |
| raises | Raises given standard Intent(s) on various Grid Actions |
FDC3 Context Options
The FDC3 Context Options property handles FDC3 Context behaviour:
| Property | Description |
|---|---|
| broadcasts | Broadcasts given standard Context(s) on various Grid Actions |
| handleContext | Handles incoming Contexts (standard and custom) |
| listensFor | Subscribe to given standard Context(s) |
FDC3 API
The FDC3 API section of Adaptable API contains functions relating to FDC3:
| Method | Description |
|---|---|
| broadcastFromPrimaryKey(primaryKeyValue, contextType, channel) | Broadcasts the given Context from the given Row Node with the given Primary Key Value |
| broadcastFromRow(rowNode, contextType, channel) | Broadcasts the given Context from the given Row Node |
| buildContextDataForPrimaryKey(contextType, primaryKeyValue) | Builds FDC3 Context Data based on the given Context Type and the Row Node with the given Primary Key Value |
| buildContextDataFromRow(contextType, rowNode) | Builds FDC3 Context Data based on the given Context Type and Row Node |
| getContextLabel(contextType) | Returns the human-friendly label for the given Context Type |
| getDesktopAgent() | Returns the FDC3 Desktop Agent |
| isStandardContextType(contextType) | Checks if the given Context Type is a FDC3 standard Context Type |
| isStandardIntentType(intentType) | Checks if the given Intent is a FDC3 standard Intent Type |
| raiseIntentForContextFromPrimaryKey(primaryKeyValue, contextType, appIdentifier) | Finds and raises an Intent based on the given Context from the given Row Node with the given Primary Key Value |
| raiseIntentForContextFromRow(rowNode, contextType, appIdentifier) | Finds and raises an Intent based on the given Context from the given Row Node |
| raiseIntentFromPrimaryKey(primaryKeyValue, intent, contextType, appIdentifier) | Raises an Intent with the given Context from the given Row Node with the given Primary Key Value |
| raiseIntentFromRow(rowNode, intent, contextType, appIdentifier) | Raises an Intent with the given Context from the given Row Node |
FDC3 Message Event
The FDC3 Message Event is triggered whenever a FDC3 Message is sent or received.
Fdc3MessageInfo
There are 2 different Message Info objects that the Event provides depending whether the FDC3 message was sent or received:
- The
Fdc3MessageSentInfoobject provides details of sent messages:
| Property | Description |
|---|---|
| app | Target application for the message |
| context | Full FDC3 Context for object related to the Event |
| direction | Direction - always 'sent' |
| eventType | Event Type: RaiseIntent, RaiseIntentForContext,BroadcastMessage |
| intent | FDC3 Intent which caused Event to fire (if type is RaiseIntent) |
| adaptableContext | Custom application Context provided in AdaptableOptions.adaptableContext |
- The
Fdc3MessageReceivedInfoobject provides details of received messages:
| Property | Description |
|---|---|
| context | Full FDC3 Context for object related to the Event |
| direction | Direction - always 'received' |
| eventType | EventType: IntentRaised, ContextBroadcast |
| intent | FDC3 Intent which caused Event to fire (if type is IntentRaised) |
| metadata | Metadata associated with the FDC3 Context |
| adaptableContext | Custom application Context provided in AdaptableOptions.adaptableContext |
Event Subscription
Subscribing to the Event is done the same way as with all Adaptable Events:
api.eventApi.on('Fdc3Message', (eventInfo: Fdc3MessageSentInfo) => {
// do something with the info
});
api.eventApi.on('Fdc3Message', (eventInfo: Fdc3MessageReceivedInfo) => {
// do something with the info
});