Poi

data class Poi(    val id: Int,     val pathId: Int,     val startOffset: Distance,     val endOffset: Distance,     val entryId: Int,     val category: Int,     val categoryName: String,     val brandNames: List<String>,     val name: String,     val coordinate: GeoCoordinate,     val entryPointCoordinate: GeoCoordinate,     val bufferRadius: Distance,     val formattedId: String,     val parentCategories: List<Int>,     val subscribedCategory: Int,     val type: Poi.Type) : HorizonElement

Describes a Point of Interest (POI).

Constructors

Link copied to clipboard
fun Poi(    id: Int,     pathId: Int,     startOffset: Distance,     endOffset: Distance,     entryId: Int,     category: Int,     categoryName: String,     brandNames: List<String>,     name: String,     coordinate: GeoCoordinate,     entryPointCoordinate: GeoCoordinate,     bufferRadius: Distance,     formattedId: String,     parentCategories: List<Int>,     subscribedCategory: Int,     type: Poi.Type)

Creates a POI horizon element.

Types

Link copied to clipboard
value class Type

POI types.

Properties

Link copied to clipboard
val brandNames: List<String>

Collection of POI Brand names.

Link copied to clipboard
val bufferRadius: Distance

POI zone buffer radius.

Link copied to clipboard
val category: Int

Category of the POI.

Link copied to clipboard
val categoryName: String

Name of the POI category.

Link copied to clipboard
val coordinate: GeoCoordinate

Coordinate of the POI.

Link copied to clipboard
open override val endOffset: Distance
Link copied to clipboard
val entryId: Int

Identifier of the POI entry.

Link copied to clipboard
val entryPointCoordinate: GeoCoordinate

Coordinate of the POI entry point.

Link copied to clipboard
val formattedId: String

Formatted identifier of the POI. The encoding is as follows: nds:productId:updateRegionId:localPoiId where productId,updateRegionId and localPoiId are map-specific values.

Link copied to clipboard
open override val id: Int

Identifier of this element.

Link copied to clipboard
val name: String

Name of the POI.

Link copied to clipboard
val parentCategories: List<Int>

Identifiers of the POI parent categories.

Link copied to clipboard
open override val pathId: Int

Identifier of the path this element belongs to.

Link copied to clipboard
open override val startOffset: Distance

Start offset on the path.

Link copied to clipboard
val subscribedCategory: Int

Subtype of the POI.

Link copied to clipboard
val type: Poi.Type

Type of the POI.