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: GeoPoint, val entryPointCoordinate: GeoPoint, val bufferRadius: Distance, val formattedId: String, val parentCategories: List<Int>, val subscribedCategory: Int, val type: Poi.Type) : HorizonElement

Describes a Point of Interest (POI) on the horizon element.

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

Parameters

id

Identifier of this element.

pathId

Identifier of the path this element belongs to.

startOffset

Start offset on the path.

endOffset

End offset on the path.

entryId

Identifier of the POI entry.

category

Category of the POI.

categoryName

Name of the POI category.

brandNames

Collection of POI Brand names.

name

Name of the POI.

coordinate

Coordinate of the POI.

entryPointCoordinate

Coordinate of the POI entry point.

bufferRadius

POI zone buffer radius.

formattedId

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

parentCategories

Identifiers of the POI parent categories.

subscribedCategory

Subtype of the POI.

type

Type of the 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: GeoPoint, entryPointCoordinate: GeoPoint, bufferRadius: Distance, formattedId: String, parentCategories: List<Int>, subscribedCategory: Int, type: Poi.Type)

Types

Link copied to clipboard
value class Type

POI types.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val endOffset: Distance
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val id: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val pathId: Int
Link copied to clipboard
open override val startOffset: Distance
Link copied to clipboard
Link copied to clipboard