MPLocation

open class MPLocation

MPLocation

Author

Jose J Varó - Copyright © 2018 MapsPeople A/S. All rights reserved.

Types

Link copied to clipboard
class Builder
MPLocation builder class

Functions

Link copied to clipboard
open fun equals(o: Any): Boolean
Link copied to clipboard
@Nullable
open fun getActiveFrom(): Long
Optional active-from field in UTC
Link copied to clipboard
@Nullable
open fun getActiveTo(): Long
Optional active-to field in UTC
Link copied to clipboard
@Nullable
open fun getAliases(): Array<String>
An array of aliases (search keywords, "familiar" names,etc)
Link copied to clipboard
@Nullable
open fun getAnchor(): Point
An optional anchor point
Link copied to clipboard
@NonNull
open fun getBookable(): Boolean
Link copied to clipboard
@Nullable
open fun getBuilding(): String
Gets the building this location's parent building, if any
Link copied to clipboard
@NonNull
open fun getCMSType(): String
Gets this location's original type set through the CMS
Link copied to clipboard
@Nullable
open fun getContact(@Nullable key: String): DataField
An optional field to place contact info
Link copied to clipboard
@Nullable
open fun getDescription(): String
Gets the description text, if any
Link copied to clipboard
@Nullable
open fun getExternalId(): String
The externalId property, if set
Link copied to clipboard
@Nullable
open fun getField(@Nullable key: String): DataField
An optional space for misc fields
Link copied to clipboard
open fun getFloor(): Int
The floor index if this POI is inside a building
Link copied to clipboard
@Nullable
open fun getFloorName(): String
A floor's name (alias)
Link copied to clipboard
@NonNull
open fun getGeometry(): Geometry
Retrieves the Geometry of an MPLocation (Point, PolygonGeometry, etc.
Link copied to clipboard
open fun getGeometryArea(): Float
Link copied to clipboard
open fun getGeometryType(): Int
Returns the Geometry type as a in integer value (TYPE_POINT, (TYPE_POLYGON, etc.
Link copied to clipboard
@Nullable
open fun getImageURL(): String
An optional image In the MapsIndoors Standard App it is used to show an office's image, etc.
Link copied to clipboard
@NonNull
open fun getLatLng(): LatLng
Get the position of this location as a LatLng
Link copied to clipboard
@Nullable
open fun getLiveUpdate(domainType: String): LiveUpdate
A liveUpdate element for the matching domainType
Link copied to clipboard
@Nullable
open fun getLiveValueForKey(domainType: String, propertyKey: String): Any
Gets a property from a LiveUpdate matching the domainType and propertyKey
Link copied to clipboard
@Nullable
open fun getMarkerBitmap(): Bitmap
An optional image The bitmap used in the marker if it has one.
Link copied to clipboard
@NonNull
open fun getName(): String
Get the location's name
Link copied to clipboard
@NonNull
open fun getPoint(): Point
In case of a Point, the geometry object itself, if a PolygonGeometry, the anchor point or a calculated center
Link copied to clipboard
@Nullable
open fun getProperty(@NonNull key: String): Any
Link copied to clipboard
@Nullable
open fun getRoomId(): String
The room id property, if set
Link copied to clipboard
open fun getStatus(): Integer
Gets this location's status
Link copied to clipboard
@Nullable
open fun getType(): String
Gets this location's current type (office, meeting room, etc.) that sets its visual look and behaviour.
Link copied to clipboard
@Nullable
open fun getVenue(): String
Gets the venue this location belongs to.
Link copied to clipboard
open fun has(@NonNull key: String): Boolean
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
@MainThread
open fun hideInfoWindow()
Hides the info window if it is shown This method has no effect if this marker is not visible
Link copied to clipboard
open fun isActive(): Boolean
Gets if the location is active
Link copied to clipboard
@MainThread
open fun isInfoWindowShown(): Boolean
Returns whether the info window is currently shown
Link copied to clipboard
open fun isInsideABuilding(): Boolean
true if this location is inside a building, false otherwise (for example, a bike shed next)
Link copied to clipboard
open fun isLocationOfTypeArea(): Boolean
Checks if this location object is of the requested (location) type This method checks the value of the locationType property
Link copied to clipboard
open fun isLocationOfTypeAsset(): Boolean
Checks if this location object is of the requested (location) type This method checks the value of the locationType property
Link copied to clipboard
open fun isLocationOfTypeBuilding(): Boolean
Checks if this location object is of the requested (location) type This method checks the value of the locationType property
Link copied to clipboard
open fun isLocationOfTypeFloor(): Boolean
Checks if this location object is of the requested (location) type This method checks the value of the locationType property
Link copied to clipboard
open fun isLocationOfTypePOI(): Boolean
Checks if this location object is of the requested (location) type This method checks the value of the locationType property
Link copied to clipboard
open fun isLocationOfTypeRoom(): Boolean
Checks if this location object is of the requested (location) type This method checks the value of the locationType property
Link copied to clipboard
open fun isLocationOfTypeVenue(): Boolean
Checks if this location object is of the requested (location) type This method checks the value of the locationType property
Link copied to clipboard
open fun isOfCategory(@Nullable category: String): Boolean
Checks if this location is of the given category
Link copied to clipboard
open fun isSearchable(): Boolean
Gets if the location is searchable
Link copied to clipboard
open fun isVisible(): Boolean
Link copied to clipboard
open fun setAlpha(value: Float)
Link copied to clipboard
@Nullable
open fun setLiveUpdate(liveUpdate: LiveUpdate)
Set a liveUpdate
Link copied to clipboard
@MainThread
open fun showInfoWindow()
Shows the info window of this marker on the map, if the marker is visible
Link copied to clipboard
@NonNull
open fun toString(): String

Properties

Link copied to clipboard
@get:Nullable
open val categories: Array<String>
Link copied to clipboard
open val floorIndex: Int
Link copied to clipboard
@NonNull
@get:NonNull
open val id: String
Link copied to clipboard
@get:Nullable
open val liveUpdates: HashMap<String, LiveUpdate>
Link copied to clipboard
@Nullable
@get:Nullable
open var tag: Any
Custom data blob

Inheritors

Link copied to clipboard