MPILocation

@Serializable
data class MPILocation(    val id: String,     val name: String? = null,     val type: String? = null,     val description: String? = null,     val sortOrder: Double? = null,     val logo: MPIImage? = null,     val phone: MPIPhone? = null,     val social: MPISocial? = null,     val shortName: String? = null,     val detailsUrl: String? = null,     val parent: String? = null,     val tags: List<String>? = null,     val externalId: String? = null,     val picture: MPIPicture? = null,     val states: List<MPILocationState>? = null,     val operationalHours: List<MPIOpeningHours>? = null,     val siblingGroups: List<MPISiblingGroup>? = null,     val gallery: List<MPIGalleryImage>? = null) : MPINavigatable

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

  • Note: A 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.

Constructors

Link copied to clipboard
fun MPILocation(    id: String,     name: String? = null,     type: String? = null,     description: String? = null,     sortOrder: Double? = null,     logo: MPIImage? = null,     phone: MPIPhone? = null,     social: MPISocial? = null,     shortName: String? = null,     detailsUrl: String? = null,     parent: String? = null,     tags: List<String>? = null,     externalId: String? = null,     picture: MPIPicture? = null,     states: List<MPILocationState>? = null,     operationalHours: List<MPIOpeningHours>? = null,     siblingGroups: List<MPISiblingGroup>? = null,     gallery: List<MPIGalleryImage>? = null)

Types

Link copied to clipboard
@Serializable
data class MPITinyNode(val node: String, val map: String)

MPITinyNode is a MPINode with only id and id of its map

Properties

Link copied to clipboard
var categories: List<MPICategory>

A list of categories linked to the MPILocation

Link copied to clipboard
val description: String? = null

Description of the MPILocation

Link copied to clipboard
val detailsUrl: String? = null

Url of the details of the MPILocation

Link copied to clipboard
val externalId: String? = null

External id of the MPILocation

Link copied to clipboard
val gallery: List<MPIGalleryImage>? = null

Gallery images of the MPILocation

Link copied to clipboard
open override val id: String

Id of the MPILocation

Link copied to clipboard
val logo: MPIImage? = null

Logo of the MPILocation

Link copied to clipboard
val name: String? = null

Name of the MPILocation

Link copied to clipboard
var nodes: List<MPINavigatable.MPINode>

An array of nodes linked to the MPILocation

Link copied to clipboard
val operationalHours: List<MPIOpeningHours>? = null

Operation hours of the MPILocation

Link copied to clipboard
val parent: String? = null

id of the parent location of the MPILocation

Link copied to clipboard
val phone: MPIPhone? = null

Phone of the MPILocation

Link copied to clipboard
val picture: MPIPicture? = null

Picture of the MPILocation

Link copied to clipboard
var polygons: List<MPINavigatable.MPIPolygon>

An array of polygons linked to the MPILocation

Link copied to clipboard
val shortName: String? = null

Short name of the MPILocation

Link copied to clipboard
val siblingGroups: List<MPISiblingGroup>? = null

Sibling groups of the MPILocation

Link copied to clipboard
val social: MPISocial? = null

Social media accounts of the MPILocation

Link copied to clipboard
val sortOrder: Double? = null

Sort order of the MPILocation

Link copied to clipboard
val states: List<MPILocationState>? = null

States of the MPILocation

Link copied to clipboard
val tags: List<String>? = null

Tags of the MPILocation

Link copied to clipboard
val type: String? = null

Type of the MPILocation