MapsIndoorsSDK/com.mapsindoors.mapssdk/MPLocation

MPLocation

open class MPLocation

MPLocation

Author

Types

Builder

class Builder

MPLocation builder class

Functions

equals

open fun equals(o: Any): Boolean

getActiveFrom

@Nullable

open fun getActiveFrom(): Long

Optional active-from field in UTC

getActiveTo

@Nullable

open fun getActiveTo(): Long

Optional active-to field in UTC

getAliases

@Nullable

open fun getAliases(): Array<String>

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

getAnchor

@Nullable

open fun getAnchor(): Point

An optional anchor point

getBookable

@NonNull

open fun getBookable(): Boolean

getBuilding

@Nullable

open fun getBuilding(): String

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

getCMSType

@NonNull

@Deprecated

~~open~~ ~~fun~~ ~~getCMSType~~(): String

Gets this location's original type set through the CMS

getContact

@Nullable

open fun getContact(@Nullable key: String): DataField

An optional field to place contact info

getDescription

@Nullable

open fun getDescription(): String

Gets the description text, if any

getExternalId

@Nullable

open fun getExternalId(): String

The externalId property, if set

getField

@Nullable

open fun getField(@Nullable key: String): DataField

An optional space for misc fields

getFloor

open fun getFloor(): Int

The floor index if this POI is inside a building

getFloorName

@Nullable

open fun getFloorName(): String

A floor's name (alias)

getGeometry

@NonNull

open fun getGeometry(): Geometry

Retrieves the Geometry of an MPLocation (Point, PolygonGeometry, etc.

getGeometryArea

open fun getGeometryArea(): Float

getGeometryType

open fun getGeometryType(): Int

Returns the Geometry type as a in integer value (TYPE_POINT, (TYPE_POLYGON, etc.

getImageURL

@Nullable

open fun getImageURL(): String

An optional image In the MapsIndoors Standard App it is used to show an office's image, etc.

getLatLng

@NonNull

open fun getLatLng(): LatLng

Get the position of this location as a LatLng

getLiveUpdate

@Nullable

open fun getLiveUpdate(domainType: String): LiveUpdate

A liveUpdate element for the matching domainType

getLiveValueForKey

@Nullable

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

Gets a property from a LiveUpdate matching the domainType and propertyKey

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(): Point

In case of a Point, the geometry object itself, if a PolygonGeometry, the anchor point or a calculated center

getProperty

@Nullable

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

getRoomId

@Nullable

@Deprecated

~~open~~ ~~fun~~ ~~getRoomId~~(): String

The room id property, if set

getStatus

open fun getStatus(): Integer

Gets this location's status

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 venue this location belongs to.

has

open fun has(@NonNull key: String): Boolean

hashCode

open fun hashCode(): Int

hideInfoWindow

@MainThread

open fun hideInfoWindow()

Hides the info window if it is shown This method has no effect if this marker is not visible

isActive

open fun isActive(): Boolean

Gets if the location is active

isInfoWindowShown

@MainThread

open fun isInfoWindowShown(): Boolean

Returns whether the info window is currently shown

isInsideABuilding

open fun isInsideABuilding(): Boolean

true if this location is inside a building, false otherwise (for example, a bike shed next)

isLocationOfTypeArea

open fun isLocationOfTypeArea(): Boolean