Member Junction
    Preparing search index...

    Interface DataAccessIdentity

    Machine-readable identity of what a data call resolved to.

    Field names mirror ComponentSpec.dataRequirements (ComponentQueryDataRequirement.name / .categoryPath, ComponentEntityDataRequirement.name) so a caller can correlate what a component declared against what it actually called, without parsing a display string.

    It mirrors that vocabulary rather than referencing the spec, because a record must be able to describe a call that appears nowhere in dataRequirements.

    interface DataAccessIdentity {
        categoryPath?: string;
        entityName?: string;
        queryId?: string;
        queryName?: string;
        viewId?: string;
        viewName?: string;
    }
    Index

    Properties

    categoryPath? entityName? queryId? queryName? viewId? viewName?

    Properties

    categoryPath?: string

    Category path that disambiguates queryName — ComponentQueryDataRequirement.categoryPath.

    entityName?: string

    Entity name — corresponds to ComponentEntityDataRequirement.name.

    queryId?: string

    Present when the call named a query by ID, which takes precedence over name.

    queryName?: string

    Query name — corresponds to ComponentQueryDataRequirement.name. Not unique alone.

    viewId?: string

    Present when the call named a saved view by ID.

    viewName?: string

    Present when the call named a saved view by name.

    Settings

    Member Visibility

    On This Page

    Properties