MPILocation

data class MPILocation(id: String, name: String?, type: String?, categories: List<String>, description: String?, sortOrder: Double?, logo: MPIImage?, phone: MPIPhone?, social: MPISocial?, color: MPIColor?, shortName: String?, detailsUrl: String?, parent: String?, tags: List<String>?, externalId: String?, picture: MPIPicture?, states: List<MPILocationState>?, operationalHours: List<MPIOpeningHours>?, siblingGroups: List<MPISiblingGroup>?, gallery: List<MPIGalleryImage>?) : 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.

Constructors

MPILocation
Link copied to clipboard
fun MPILocation(id: String, name: String? = null, type: String? = null, categories: List<String>, description: String? = null, sortOrder: Double? = null, logo: MPIImage? = null, phone: MPIPhone? = null, social: MPISocial? = null, color: MPIColor? = 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

MPITinyNode
Link copied to clipboard
data class MPITinyNode(node: String, map: String)
MPITinyNode is an MPINode with only id and id of its map

Functions

component1
Link copied to clipboard
operator fun component1(): String
component10
Link copied to clipboard
operator fun component10(): MPIColor?
component11
Link copied to clipboard
operator fun component11(): String?
component12
Link copied to clipboard
operator fun component12(): String?
component13
Link copied to clipboard
operator fun component13(): String?
component14
Link copied to clipboard
operator fun component14(): List<String>?
component15
Link copied to clipboard
operator fun component15(): String?
component16
Link copied to clipboard
operator fun component16(): MPIPicture?
component17
Link copied to clipboard
operator fun component17(): List<MPILocationState>?
component18
Link copied to clipboard
operator fun component18(): List<MPIOpeningHours>?
component19
Link copied to clipboard
operator fun component19(): List<MPISiblingGroup>?
component2
Link copied to clipboard
operator fun component2(): String?
component20
Link copied to clipboard
operator fun component20(): List<MPIGalleryImage>?
component3
Link copied to clipboard
operator fun component3(): String?
component4
Link copied to clipboard
operator fun component4(): List<String>
component5
Link copied to clipboard
operator fun component5(): String?
component6
Link copied to clipboard
operator fun component6(): Double?
component7
Link copied to clipboard
operator fun component7(): MPIImage?
component8
Link copied to clipboard
operator fun component8(): MPIPhone?
component9
Link copied to clipboard
operator fun component9(): MPISocial?
copy
Link copied to clipboard
fun copy(id: String, name: String? = null, type: String? = null, categories: List<String>, description: String? = null, sortOrder: Double? = null, logo: MPIImage? = null, phone: MPIPhone? = null, social: MPISocial? = null, color: MPIColor? = 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): MPINavigatable.MPILocation
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String

Properties

categories
Link copied to clipboard
val categories: List<String>
Categories of the MPILocation
  • Example: "583f251a58657d7c32000000"

color
Link copied to clipboard
val color: MPIColor? = null
Brand color of the MPILocation
description
Link copied to clipboard
val description: String? = null
Description of the MPILocation
  • Example: "Mappedin helps make the indoors discoverable"

detailsUrl
Link copied to clipboard
val detailsUrl: String? = null
Url of the details of the MPILocation
  • Example: "https://www.mappedin.com/wayfinding/web-app"

externalId
Link copied to clipboard
val externalId: String? = null
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

gallery
Link copied to clipboard
val gallery: List<MPIGalleryImage>? = null
Gallery images of the MPILocation
id
Link copied to clipboard
open override val id: String
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.

logo
Link copied to clipboard
val logo: MPIImage? = null
Logo of the MPILocation
name
Link copied to clipboard
val name: String? = null
Name of the MPILocation
  • Example: "Mappedin"

nodes
Link copied to clipboard
var nodes: List<MPINavigatable.MPINode>
An array of nodes linked to the MPILocation
operationalHours
Link copied to clipboard
val operationalHours: List<MPIOpeningHours>? = null
Operation hours of the MPILocation
parent
Link copied to clipboard
val parent: String? = null
id of the parent location of the MPILocation
phone
Link copied to clipboard
val phone: MPIPhone? = null
Phone of the MPILocation
picture
Link copied to clipboard
val picture: MPIPicture? = null
Picture of the MPILocation
polygons
Link copied to clipboard
var polygons: List<MPINavigatable.MPIPolygon>
An array of polygons linked to the MPILocation
shortName
Link copied to clipboard
val shortName: String? = null
Short name of the MPILocation
siblingGroups
Link copied to clipboard
val siblingGroups: List<MPISiblingGroup>? = null
Sibling groups of the MPILocation
social
Link copied to clipboard
val social: MPISocial? = null
Social media accounts of the MPILocation
sortOrder
Link copied to clipboard
val sortOrder: Double? = null
Sort order of the MPILocation
states
Link copied to clipboard
val states: List<MPILocationState>? = null
States of the MPILocation
tags
Link copied to clipboard
val tags: List<String>? = null
Tags of the MPILocation
  • Example: "Wayfinding"

type
Link copied to clipboard
val type: String? = null
Type of the MPILocation
  • Example: "tenant"