RaiseIntentConfig

Config used when raising an FDC3 Intent

TypeScript
export interface

Properties

PropertyTypeDescription
actionButtonFdc3AdaptableButtonDefinition of Action Button (to be put in default FDC3 Action Column)
actionColumn\{ columnId: string; friendlyName?: string; button:Fdc3AdaptableButton; width?: number; \}Custom FDC3 Action Column definition for the Intent
contextMenu\{ columnIds: string[]; icon?: '_defaultFdc3' |AdaptableIcon; \}Columns to display a 'Raise Intent' Context Menu item
contextTypeContextTypeKey of Context being Raised
handleIntentResolution(context:HandleFdc3IntentResolutionContext) => Promise<void>Handles the IntentResolution for this specific raise intent configuration

Property Details

actionButton

Definition of Action Button (to be put in default FDC3 Action Column)

TypeScript
actionButton?: Fdc3AdaptableButton;
Property Value

Fdc3AdaptableButton

actionColumn

Custom FDC3 Action Column definition for the Intent

TypeScript
actionColumn?: {
        columnId: string;
        friendlyName?: string;
        button: Fdc3AdaptableButton;
        width?: number;
    };
Property Value

\{ columnId: string; friendlyName?: string; button:Fdc3AdaptableButton; width?: number; \}

contextMenu

Columns to display a 'Raise Intent' Context Menu item

TypeScript
contextMenu?: {
        columnIds: string[];
        icon?: '_defaultFdc3' | AdaptableIcon;
    };
Property Value

\{ columnIds: string[]; icon?: '_defaultFdc3' |AdaptableIcon; \}

contextType

Key of Context being Raised

TypeScript
contextType: ContextType;
Property Value

ContextType

handleIntentResolution

Handles the IntentResolution for this specific raise intent configuration

TypeScript
handleIntentResolution?: (context: HandleFdc3IntentResolutionContext) => Promise<void>;
Property Value

(context:HandleFdc3IntentResolutionContext) => Promise<void>