Lime Web Components API Documentation - v7.11.0
    Preparing search index...

    Interface GatheredAISummaryAlpha

    A provider's summary, as gathered with detail: 'summary'.

    interface GatheredAISummary {
        actions?: string[];
        ancestorContext: LimeWebComponentContext;
        summary?: Record<string, JsonValue>;
        type: string;
    }

    Hierarchy

    Index

    Properties

    actions?: string[]

    The ids of the actions the provider offers. Absent when it offers none.

    ancestorContext: LimeWebComponentContext

    The component's LimeWebComponentContext at the time of gathering.

    The LimeWebComponentContext injected into the component by the framework. Describes the component's own limetype/id and, via the parent chain, its ancestors in the UI hierarchy.

    The ancestor chain may be incomplete, so do not rely on it to reach every record above the component.

    import { LimeWebComponentContext } from '@limetech/lime-web-components';

    const ancestorContext: LimeWebComponentContext = {
    limetype: 'company',
    id: 3184,
    };
    import { LimeWebComponentContext } from '@limetech/lime-web-components';

    const ancestorContext: LimeWebComponentContext = {
    limetype: 'deal',
    id: 2045,
    // The deal list the component is nested in. It has no id of its own, and
    // the company the list belongs to is not part of the chain.
    parent: {
    limetype: 'deal',
    id: null,
    },
    };
    summary?: Record<string, JsonValue>

    What the provider's getSummary returned. Absent when it returned nothing.

    type: string

    The provider's contextType label.

    Identifies the kind of context this contribution represents (e.g. 'current-user', 'table-view', 'explorer-view'). Copied from the provider by the registry at gather time.