MPILocation

public struct MPILocation : MPINavigatable

MPILocation represents a specific area of interest such as a store location

Note

An MPILocation‘s MPINodes and MPIPolygons can be on multiple MPIMaps, or in multiple non-adjacent places on the same MPIMap. For example, all washrooms at a given venue could belong to one MPILocation. A washroom location might a have a few MPIPolygons spread throughout the venue for each one that exists. On the other hand, a department store could live on multiple floors. A single store can just have one presence, and therefore one MPIPolygon . Some Locations just have a single point with MPINodes.

Note

MPILocation has an ID and will be linked to [MPINode], [MPIPolygon].
  • id

    Id of the MPILocation

    Note

    id can be used for the lifetime of the data you get back, but it may not be present in future calls.
    • Example: 5ae73f56ee385250dd000004

    Declaration

    Swift

    public let id: String

  • Name of the MPILocation

    • Example: “Mappedin”

    Declaration

    Swift

    public let name: String

  • Type of the MPILocation

    • Example: “tenant”

    Declaration

    Swift

    public let type: String

  • Categories of the MPILocation

    • Example: [“583f251a58657d7c32000000”]

    Declaration

    Swift

    public let categories: [String]

  • Description of the MPILocation

    • Example: “Mappedin helps make the indoors discoverable”

    Declaration

    Swift

    public let description: String?

  • Sort order of the MPILocation

    Declaration

    Swift

    public let sortOrder: Double?

  • Logo of the MPILocation

    Declaration

    Swift

    public let logo: MPIImage?

  • Phone of the MPILocation

    Declaration

    Swift

    public let phone: MPIPhone?

  • Social media accounts of the MPILocation

    Declaration

    Swift

    public let social: MPISocial?

  • Brand color of the MPILocation

    Declaration

    Swift

    public let color: MPIColor?

  • Short name of the MPILocation

    Declaration

    Swift

    public let shortName: String?

  • Url of the details of the MPILocation

    Declaration

    Swift

    public let detailsUrl: String?

  • id of the parent location of the MPILocation

    Declaration

    Swift

    public let parent: String?

  • Tags of the MPILocation

    • Example: “Wayfinding”

    Declaration

    Swift

    public let tags: [String]?

  • External id of the MPILocation

    Note

    externalId is for a more durable use than id or if the data in the Mappedin CMS is being synced from somewhere else

    Declaration

    Swift

    public let externalId: String?

  • Picture of the MPILocation

    Declaration

    Swift

    public let picture: MPIPicture?

  • States of the MPILocation

    Declaration

    Swift

    public let states: [MPILocationState]?

  • Operation hours of the MPILocation

    Declaration

    Swift

    public let operationalHours: [MPIOpeningHours]?

  • Sibling groups of the MPILocation

    Declaration

    Swift

    public let siblingGroups: [MPISiblingGroup]?

  • Gallery images of the MPILocation

    Declaration

    Swift

    public let gallery: [MPIGalleryImage]?

  • An array of nodes linked to the MPILocation

    Declaration

    Swift

    public internal(set) var nodes: [MPINode]? { get }

  • An array of polygons linked to the MPILocation

    Declaration

    Swift

    public internal(set) var polygons: [MPIPolygon]? { get }

  • MPINavigatable type

    Declaration

    Swift

    public var navigatableType: String { get }