profi-sdk-aos-model/com.sygic.profi.model.pm.poi/PMPoi

PMPoi

data class PMPoi(val id: String, val iso: String, val location: PMPoiLocation, val entryLocation: PMPoiLocation? = null, val category: String, val searchPriority: Int = 0, val displayName: List<PMPoiCategoryDisplayName>? = emptyList())

Custom POI attributes

Constructors

PMPoi

fun PMPoi(id: String, iso: String, location: PMPoiLocation, entryLocation: PMPoiLocation? = null, category: String, searchPriority: Int = 0, displayName: List<PMPoiCategoryDisplayName>? = emptyList())

Properties

category

val category: String

ID of a Custom, or Sygic Place Category.

displayName

val displayName: List<PMPoiCategoryDisplayName>?

A set of display names (human readable texts), in various languages, for the Place. Intended for user interaction.

entryLocation

val entryLocation: PMPoiLocation? = null

Entry location of POI (e.g. gate of an industrial area)

val id: String

Unique, integrator maintained identifier. Used for further updates/deletes on the Places

iso

val iso: String

ISO 3166-1 Alpha-2/ISO 3166-2 code of the country/region, in which the Place is located. Purpose is to provide the ability to filter the search results
based on country. This attribute does not affect the ranking of the search results. This attribute refers to the location of the Place.
If such case occurs where the country (and iso) of location and entry_location is not the same, search is not affected. In this case the anomaly is
possible when the map of location/entry_location is missing. This could result to a navigation to a nearest accessible point while using the maps that
are available. As iso is related to the location, it is necessary to provide the correct value for this field.

location

val location: PMPoiLocation

Location of POI. Determines where pin on map will be placed.

searchPriority

val searchPriority: Int = 0

Search priority of a Place is affecting the final ranking of the search results.
It does NOT mean the search result would be filtered because the lower priority - it simply would rank lower than other results.
The higher the priority the less the growing distance from the searched Place is affecting the ranking.
The lower the priority, the more the increasing distance from the Place is affecting the ranking.
Search ranks all the results depending on the final scores of these results.

Example:
The place with a ranking "1" ranks normally from the vicinity of that place but would be ranked low while being searched from the distance of 300 km.
The place with a ranking "11" is still an interesting search result while being searched from the distance of 300 km.
While searching "airport" from Karlskrona, Sweden , the Ronneby Airport is ranked quite high as it is regionally important airport (lower search priority)
but you are also able to see airports in Malmo, Copenhagen, Stockholm (higher search priority). Regionally important Place (lower search priority) as
Ronneby would not be ranked anywhere near the first results when searching from Stockholm for example.

Minimum value is 1, maximum is 15. Priorities are represented by the following table