MVFv3 API Documentation
    Preparing search index...

    Type Alias EnterpriseLocationInstance

    A locationInstance is a particular instance of an Enterprise Location that has some properties different from the parent. Eg, it may have siblingGroups, or state. Other differences like name and, in particular, geometryAnchors, will be handled in the parent LocationInstance.

    An Enterprise Location Instance:

    • MUST have a parent, referring to an Enterprise Location.
    • MUST have a locationInstanceId, referring to a LocationInstance.
    • MUST NOT have a locationId.
    • MUST have a unique ID, for localization to work.
    • SHOULD have AT LEAST ONE other Enterprise Location property set.

    It is otherwise a Partial.

    This implies that for an EntepriseLocationInstance to exist, there must also be a LocationInstance for it. Only one EnterpriseLocationInstance should exist for a given LocationInstance. That LocationInstance then MAY only differ from it's parent on the geometryAnchors property, relying on the EnterpriseLocationInstance to provide a unique property such as state.

    If a Location that has an EnterpriseLocation differs only in something covered by Location (say, name and geometryAnchor), there will NOT be an EnterpriseLocationInstance for it.

    Usage example:

    • An EnterpriseLocation representing a kiosk in several places. One of them is new, and has an EnterpriseLocationInstance with the new location state.
    type EnterpriseLocationInstance = {
        id: `eli_${string}`;
        parentId: `el_${string}`;
        locationInstanceId: `loci_${string}`;
        type?: string;
        sortOrder?: number;
        picture?: string;
        cmsId?: string;
        tags?: string[];
        states?: {
            type:
                | "unknown"
                | "closed-temporarily"
                | "new"
                | "pop-up"
                | "coming-soon"
                | "relocated";
            end?: string;
            start?: string;
        }[];
        siblingGroups?: { label: string; siblings: `loc_${string}`[] }[];
        gallery?: { image: string; caption?: string; embeddedUrl?: string }[];
        showFloatingLabelWhenImagePresent?: boolean;
        amenity?: string;
        showLogo?: boolean;
        primaryCategory?: `lcat_${string}`;
    }
    Index

    Properties

    id parentId locationInstanceId type? sortOrder? picture? cmsId? tags? states? siblingGroups? gallery? showFloatingLabelWhenImagePresent? amenity? showLogo? primaryCategory?

    Properties

    id: `eli_${string}`

    The unique ID for this Enterprise Location Instance. This ID might be ephemeral and is really only for localization.

    parentId: `el_${string}`

    The parent Enterprise Location for this Enterprise Location Instance.

    locationInstanceId: `loci_${string}`

    The LocationInstance that will have any Location instance properties set, in particular geometryAnchors.

    type?: string
    sortOrder?: number
    picture?: string
    cmsId?: string
    tags?: string[]
    states?: {
        type:
            | "unknown"
            | "closed-temporarily"
            | "new"
            | "pop-up"
            | "coming-soon"
            | "relocated";
        end?: string;
        start?: string;
    }[]
    siblingGroups?: { label: string; siblings: `loc_${string}`[] }[]
    gallery?: { image: string; caption?: string; embeddedUrl?: string }[]
    showFloatingLabelWhenImagePresent?: boolean
    amenity?: string
    showLogo?: boolean
    primaryCategory?: `lcat_${string}`

    Settings

    Member Visibility

    On This Page

    Properties