MapsIndoorsSDK/com.mapsindoors.core/MPLocation

MPLocation

open class MPLocation : MPEntity

Types

Builder

class Builder

MPLocation builder class

Functions

equals

open fun equals(o: Any): Boolean

getAliases

@Nullable

open fun getAliases(): Array<String>

An array of aliases (search keywords, "familiar" names,etc)

getBaseType

@NonNull

open fun getBaseType(): MPLocationBaseType

Gets this location's base type (Room, Building, Venue, etc.

getBounds

open fun getBounds(): MPLatLngBounds

getBuildingName

@Nullable

open fun getBuildingName(): String

Gets the building this location's parent building, if any

getCategories

@Nullable

open fun getCategories(): Array<String>

The categories that this location belongs to, if any

getDescription

@Nullable

open fun getDescription(): String

Gets the description text, if any

getExternalId

@Nullable

open fun getExternalId(): String

The externalId property, if set

getFloorIndex

open fun getFloorIndex(): Int

The floor index if this POI is inside a building

getFloorName

@Nullable

open fun getFloorName(): String

A floor's name (alias)

getGeometry

@Nullable

open fun getGeometry(): MPGeometry

Retrieves the Geometry of an MPLocation (MPPoint, MPPolygonGeometry, etc.

getImageURL

@Nullable

open fun getImageURL(): String

An optional image url

getLiveUpdate

@Nullable

open fun getLiveUpdate(@NonNull domainType: String): LiveUpdate

A liveUpdate element for the matching domainType

getLiveUpdates

@NonNull

open fun getLiveUpdates(): HashMap<String, LiveUpdate>

The liveUpdates property, if set

getLiveValueForKey

@Nullable

open fun getLiveValueForKey(@NonNull domainType: String, @NonNull propertyKey: String): Any

Gets a property from a LiveUpdate matching the domainType and propertyKey

getLocationId

@NonNull

open fun getLocationId(): String

getLocationSettings

@Nullable

open fun getLocationSettings(): MPLocationSettings

Gets the location settings

getMarkerBitmap

@Nullable

open fun getMarkerBitmap(): Bitmap

An optional image The bitmap used in the marker if it has one.

getName

@NonNull

open fun getName(): String

Get the location's name

getPoint

@NonNull

open fun getPoint(): MPPoint

In case of a MPPoint, the geometry object itself, if a MPPolygonGeometry, the anchor point or a calculated center

getPosition

@NonNull

open fun getPosition(): MPPoint

An optional anchor point

getProperty

@Nullable

open fun getProperty(@NonNull key: String): Any

Returns a property on the location.

getType

@Nullable

open fun getType(): String

Gets this location's current type (office, meeting room, etc.) that sets its visual look and behaviour.

getVenue

@Nullable

open fun getVenue(): String

Gets the administrative ID of the venue this location belongs to.

hashCode

open fun hashCode(): Int

initialize

open fun initialize()

isBookable

open fun isBookable(): Boolean

isInfoWindowShown

open fun isInfoWindowShown(): Boolean

Returns whether the info window is currently shown

isPoint

open fun isPoint(): Boolean

setLiveUpdate

open fun setLiveUpdate(@Nullable liveUpdate: LiveUpdate)

Set a liveUpdate

setLocationSettings

open fun setLocationSettings(@Nullable locationSettings: MPLocationSettings)

Sets the location settings

setPosition

open fun setPosition(@NonNull point: MPPoint)

Update the location's position

showInfoWindow

open fun showInfoWindow(visible: Boolean)

Shows the info window of this marker on the map, if the marker is visible

toString

@NonNull

open fun toString(): String