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

Package-level declarations

Pure kotlin data classes for Custom places interfaces

Types

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

Enumeration of POI Actions

data class PMPoiCategory(val id: String, val color: String? = null, val icon: String? = null, val zoomLevel: Float = 0.0f, val priority: Int = 0, val importance: PMPoiCategoryImportance, val showWithoutText: Boolean = false, val parentId: String? = null, val displayName: List<PMPoiCategoryDisplayName>? = emptyList(), val searchPriority: Int = 0)

POI Category

data class PMPoiCategoryDisplayName(val title: String, val subtitle: String? = null, val lng: String? = null, val searchTokens: List<PMPoiCategorySearchToken>? = null)

POI Category Display Name

Importance of POI Category for showing on the map

data class PMPoiCategorySearchToken(val index: String, val refinement: String? = null)

POI Category Search Token

data class PMPoiDynamicData(val poiId: String, val placeData: List<PMPoiPlaceData>? = null)

Custom POI dynamic attributes

data class PMPoiLocation(val latitude: Double, val longitude: Double)

Structure for location

data class PMPoiMsg(val result: PMPoiResult, val text: String? = null)

Message to be shown

data class PMPoiPlaceData(val key: String, val values: List<String>? = null)

Structure for POI data specific to integrator
Custom data. SDK doesn't interpret these just serves upon request to integrator's app.

data class PMPoiPlacesFilter(val iso: String? = null, val page: Int = 0, val size: Int = 0, val areaTl: PMPoiLocation? = null, val areaBr: PMPoiLocation? = null, val categories: List<String>? = null)

Filter used by action PFPoiAction.GetPlaces

data class PMPoiRequest(val correlationId: String? = null, val action: PMPoiAction, val filter: PMPoiPlacesFilter? = null, val placesToUpdate: List<PMPoi>? = null, val placesToDelete: List<String>? = null, val categoriesToUpdate: List<PMPoiCategory>? = null, val categoriesToDelete: List<String>? = null, val dynamicDataToUpdate: List<PMPoiDynamicData>? = null, val dynamicDataToDelete: List<String>? = null, val dynamicDataToGet: List<String>? = null)

Request for getting/changing places

data class PMPoiResponse(val correlationId: String? = null, val action: PMPoiAction, val pois: List<PMPoi>? = null, val categories: List<PMPoiCategory>? = null, val dynamicData: List<PMPoiDynamicData>? = null, val msg: PMPoiMsg? = null)

Importance level of message