IFClite TypeScript API
    Preparing search index...

    Interface EmbedMessageEnvelope

    Base envelope for all messages crossing the iframe boundary

    interface EmbedMessageEnvelope {
        data?: unknown;
        error?: EmbedError;
        requestId?: string;
        responseId?: string;
        source: "ifc-lite-embed";
        type: string;
        version: "1.0";
    }
    Index
    data? error? requestId? responseId? source type version
    data?: unknown

    Payload data

    error?: EmbedError

    Present on error responses

    requestId?: string

    Present on requests, echoed in responses for correlation

    responseId?: string

    Present on responses, matches the original requestId

    source: "ifc-lite-embed"

    Always 'ifc-lite-embed' - used to filter out unrelated messages

    type: string

    Command or event name

    version: "1.0"

    Protocol version for forward compatibility

    Settings
    Member Visibility

    On This Page
    Properties