MPINavigatable

sealed class MPINavigatable

Types

MPILocation
Link copied to clipboard
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: 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.

MPINode
Link copied to clipboard
data class MPINode(id: String, x: Double?, y: Double?, map: String?, externalId: String?, accessible: Boolean?, paths: List<MPIPathNode>?) : MPINavigatable
MPINode represents a position, anchored to a specific MPIMap
MPIPolygon
Link copied to clipboard
data class MPIPolygon(id: String, map: String, layer: String?, layerId: String?, externalId: String?, name: String?) : MPINavigatable
MPIPolygon represents the geographical area covered by a MPILocation in a venue.
MPIVortex
Link copied to clipboard
data class MPIVortex(id: String, name: String?, type: MPINavigatable.MPIVortexType?) : MPINavigatable
MPIVortex is a special entity that represents a way to move between two or more MPIMaps at a given venue.
MPIVortexType
Link copied to clipboard
enum MPIVortexType : Enum<MPINavigatable.MPIVortexType>
MPIVortexType represents the type of entity to move from one MPIMap to another MPIMap
MPIVortexTypeSerializer
Link copied to clipboard
object MPIVortexTypeSerializer
Initialization to assign each vortex to its corresponding vortex type

Functions

equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open fun hashCode(): Int
toString
Link copied to clipboard
open fun toString(): String

Properties

id
Link copied to clipboard
abstract val id: String

Inheritors

MPINavigatable
Link copied to clipboard
MPINavigatable
Link copied to clipboard
MPINavigatable
Link copied to clipboard
MPINavigatable
Link copied to clipboard