Fdc3Api
Provides run-time access to AdapTable's FDC3 functionality
TypeScript
export interfaceMethods
| 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 |
Method Details
broadcastFromPrimaryKey
Broadcasts the given Context from the given Row Node with the given Primary Key Value
TypeScript
broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, channel?: Channel): Promise<void> | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| primaryKeyValue | string | number | The Primary Key Value |
| contextType | ContextType | The FDC3 Context Type |
| channel | Channel | (optional) Channel to broadcast to; if not provided, the Context will be broadcast to whatever User Channel the app is joined to |
Returns
Promise<void> | undefined
broadcastFromRow
Broadcasts the given Context from the given Row Node
TypeScript
broadcastFromRow(rowNode: IRowNode, contextType: ContextType, channel?: Channel): Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
| rowNode | IRowNode | The Row Node |
| contextType | ContextType | The FDC3 Context Type |
| channel | Channel | (optional) Channel to broadcast to; if not provided, the Context will be broadcast to whatever User Channel the app is joined to |
Returns
Promise<void>
buildContextDataForPrimaryKey
Builds FDC3 Context Data based on the given Context Type and the Row Node with the given Primary Key Value
TypeScript
buildContextDataForPrimaryKey(contextType: ContextType, primaryKeyValue: string | number): Context | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| contextType | ContextType | The FDC3 Context Type |
| primaryKeyValue | string | number | The Primary Key Value |
Returns
Context | undefined
buildContextDataFromRow
Builds FDC3 Context Data based on the given Context Type and Row Node
TypeScript
buildContextDataFromRow(contextType: ContextType, rowNode: IRowNode): Context;Parameters
| Parameter | Type | Description |
|---|---|---|
| contextType | ContextType | The FDC3 Context Type |
| rowNode | IRowNode | The Row Node |
Returns
Context
getContextLabel
Returns the human-friendly label for the given Context Type
TypeScript
getContextLabel(contextType: ContextType): string;Parameters
| Parameter | Type | Description |
|---|---|---|
| contextType | ContextType | The FDC3 Context Type |
Returns
string
getDesktopAgent
Returns the FDC3 Desktop Agent
TypeScript
getDesktopAgent(): DesktopAgent;Returns
DesktopAgent
isStandardContextType
Checks if the given Context Type is a FDC3 standard Context Type
TypeScript
isStandardContextType(contextType: string): boolean;Parameters
| Parameter | Type |
|---|---|
| contextType | string |
Returns
boolean
isStandardIntentType
Checks if the given Intent is a FDC3 standard Intent Type
TypeScript
isStandardIntentType(intentType: string): boolean;Parameters
| Parameter | Type |
|---|---|
| intentType | string |
Returns
boolean
raiseIntentForContextFromPrimaryKey
Finds and raises an Intent based on the given Context from the given Row Node with the given Primary Key Value
TypeScript
raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| primaryKeyValue | string | number | The Primary Key Value |
| contextType | ContextType | The FDC3 Context Type |
| appIdentifier | AppIdentifier | The App Identifier |
Returns
Promise<IntentResolution> | undefined
raiseIntentForContextFromRow
Finds and raises an Intent based on the given Context from the given Row Node
TypeScript
raiseIntentForContextFromRow(rowNode: IRowNode, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;Parameters
| Parameter | Type | Description |
|---|---|---|
| rowNode | IRowNode | The Row Node |
| contextType | ContextType | The FDC3 Context Type |
| appIdentifier | AppIdentifier | The App Identifier |
Returns
Promise<IntentResolution>
raiseIntentFromPrimaryKey
Raises an Intent with the given Context from the given Row Node with the given Primary Key Value
TypeScript
raiseIntentFromPrimaryKey(primaryKeyValue: string | number, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| primaryKeyValue | string | number | The Primary Key Value |
| intent | Intent | The FDC3 Intent |
| contextType | ContextType | The FDC3 Context Type |
| appIdentifier | AppIdentifier | The App Identifier |
Returns
Promise<IntentResolution> | undefined
raiseIntentFromRow
Raises an Intent with the given Context from the given Row Node
TypeScript
raiseIntentFromRow(rowNode: IRowNode, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;Parameters
| Parameter | Type | Description |
|---|---|---|
| rowNode | IRowNode | The Row Node |
| intent | Intent | The FDC3 Intent |
| contextType | ContextType | The FDC3 Context Type |
| appIdentifier | AppIdentifier | The App Identifier |
Returns
Promise<IntentResolution>