Interface UICommandExport

Defines a command for the UI, to be interpreted by the client.

Interface

UICommand

interface UICommand {
    commandId: string;
    targetElementId?: string;
    payload: Record<string, any>;
    metadata?: Record<string, any>;
}

Properties

commandId targetElementId? payload metadata?

Properties

commandId

commandId: string

Optional targetElementId

targetElementId?: string

payload

payload: Record<string, any>

Optional metadata

metadata?: Record<string, any>

Settings

Member Visibility

Theme

On This Page

commandIdtargetElementIdpayloadmetadata