com.tomtom.sdk.maps.visualization:poi/com.tomtom.sdk.map.display.visualization.poi/Poi

Poi

class Poi(val name: String, val coordinate: GeoPoint, val categoryId: Long, val categoryName: String, val detourTime: Duration? = null, val detourDistance: Distance? = null, val detourOffset: Distance? = null, val chargingPark: ChargingPark? = null, val openingHours: OpeningHours? = null)

Represents a Point of Interest (POI) with associated metadata.

Important: This is a Public Preview API. It may be changed or removed at any time.

A Poi encapsulates the data required to plot a point on a map, including its coordinates and additional information such as its category and potential detour metrics.

Constructors

Poi

constructor(name: String, coordinate: GeoPoint, categoryId: Long, categoryName: String, detourTime: Duration? = null, detourDistance: Distance? = null, detourOffset: Distance? = null, chargingPark: ChargingPark? = null, openingHours: OpeningHours? = null)

Properties

categoryId

val categoryId: Long

An identifier that represents the category of the POI. This could be used to differentiate between types of POIs, such as restaurants, parks, etc.

categoryName

val categoryName: String

The name associated with the category of the Poi.

chargingPark

val chargingPark: ChargingPark? = null

Contains information about the EV charging station such as connector types.

coordinate

val coordinate: GeoPoint

The geographical coordinates that determine the `exact location of the Poi on a map.

detourDistance

val detourDistance: Distance? = null

An optional measurement that represents the distance required to detour to this POI from a specific route. If not provided, it defaults to null.

detourOffset

val detourOffset: Distance? = null

An optional measurement representing the distance from the starting point of a route to where a detour to the Poi begins. If not provided, it defaults to null.

detourTime

val detourTime: Duration? = null

An optional measurement that represents the time required to detour to this POI from a specific route. If not provided, it defaults to null.

name

val name: String

The name or title of the Point of Interest. For instance, "Eiffel Tower" or "Central Park".

openingHours

val openingHours: OpeningHours? = null

The Point Of Interest's opening hours in its local time zone.

Functions

equals

open operator override fun equals(other: Any?): Boolean

Checks if this Poi object is equal to another object.

hashCode

open override fun hashCode(): Int

Generates a hash code for this Poi object.