MVFv3 API Documentation
    Preparing search index...

    Type Alias EnterpriseLocationInstancesSchema

    Enterprise Location Instances are a way to describe an Enterprise Location that has some properties different from the parent. Eg, it may have different siblingGroups or state. These must be linked to BOTH an EnterpriseLocation and a LocationInstance.

    It is otherwise a Partial.

    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 EnterpriseLocationInstancesSchema = {
        locationInstances?: (
            {
                id: `eli_${string}`;
                locationInstanceId: `loci_${string}`;
                parentId: `el_${string}`;
            } & {
                amenity?: string;
                cmsId?: string;
                gallery?: { image: string; caption?: string; embeddedUrl?: string }[];
                picture?: string;
                primaryCategory?: `lcat_${string}`;
                showFloatingLabelWhenImagePresent?: boolean;
                showLogo?: boolean;
                siblingGroups?: { label: string; siblings: `loc_${string}`[] }[];
                sortOrder?: number;
                states?: {
                    type:
                        | "unknown"
                        | "closed-temporarily"
                        | "new"
                        | "pop-up"
                        | "coming-soon"
                        | "relocated";
                    end?: string;
                    start?: string;
                }[];
                tags?: string[];
                type?: string;
            }
        )[];
    }
    Index

    Properties

    locationInstances?

    Properties

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

    Type declaration

    • id: `eli_${string}`

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

    • locationInstanceId: `loci_${string}`

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

    • parentId: `el_${string}`

      The parent Enterprise Location for this Enterprise Location Instance.

    • Optionalamenity?: string
    • OptionalcmsId?: string
    • Optionalgallery?: { image: string; caption?: string; embeddedUrl?: string }[]
    • Optionalpicture?: string
    • OptionalprimaryCategory?: `lcat_${string}`
    • OptionalshowFloatingLabelWhenImagePresent?: boolean
    • OptionalshowLogo?: boolean
    • OptionalsiblingGroups?: { label: string; siblings: `loc_${string}`[] }[]
    • OptionalsortOrder?: number
    • Optionalstates?: {
          type:
              | "unknown"
              | "closed-temporarily"
              | "new"
              | "pop-up"
              | "coming-soon"
              | "relocated";
          end?: string;
          start?: string;
      }[]
    • Optionaltags?: string[]
    • Optionaltype?: string

    Settings

    Member Visibility

    On This Page

    Properties