profi-sdk-aos-model/com.sygic.profi.model.pm.cmd/PMCommandResponse

PMCommandResponse

data class PMCommandResponse(val correlationId: String? = null, val action: PMAction, val responseStatus: PMResponseStatus, val naviStatus: PMCurrentNaviStatus? = null, val positions: List<PMGeoPosition>? = null, val locationInfos: List<PMLocationInfo>? = null, val searchResults: List<PMSearchResult>? = null, val calculatedRoutes: List<PMCalculateRouteResult>? = null, val poiCategories: List<PMPoiCategoryResult>? = null, val activeMapModes: List<PMMapMode>? = null, val itineraries: List<PMCmdItinerary>? = null, val navigationReport: PMCmdNavigationReport? = null, val waypointChanged: PMCmdWaypointChanged? = null, val mapUpdateProgress: PMCmdMapUpdateProgress? = null, val trafficInfo: PMTrafficInfo? = null)

Represents converted user speech to a command containing context for Profi Navi

Constructors

PMCommandResponse

fun PMCommandResponse(correlationId: String? = null, action: PMAction, responseStatus: PMResponseStatus, naviStatus: PMCurrentNaviStatus? = null, positions: List<PMGeoPosition>? = null, locationInfos: List<PMLocationInfo>? = null, searchResults: List<PMSearchResult>? = null, calculatedRoutes: List<PMCalculateRouteResult>? = null, poiCategories: List<PMPoiCategoryResult>? = null, activeMapModes: List<PMMapMode>? = null, itineraries: List<PMCmdItinerary>? = null, navigationReport: PMCmdNavigationReport? = null, waypointChanged: PMCmdWaypointChanged? = null, mapUpdateProgress: PMCmdMapUpdateProgress? = null, trafficInfo: PMTrafficInfo? = null)

Properties

val action: PMAction

Defines action which the user wants to be triggered by Profi Navi
Default value is PMAction.NaviNoOp

val activeMapModes: List<PMMapMode>? = null

Used with action which provides active map modes

calculatedRoutes

val calculatedRoutes: List<PMCalculateRouteResult>? = null

Used with action which provides calculated routes result

val correlationId: String? = null

Defines attribute used for correlating messages within different asynchronous calls

val itineraries: List<PMCmdItinerary>? = null

Used itineraries

val locationInfos: List<PMLocationInfo>? = null

Used with action which provides location infos

mapUpdateProgress

val mapUpdateProgress: PMCmdMapUpdateProgress? = null

Map update status event

navigationReport

val navigationReport: PMCmdNavigationReport? = null

Returned navigation report

val naviStatus: PMCurrentNaviStatus? = null

Used with action which provides navigation status

val poiCategories: List<PMPoiCategoryResult>? = null

Used with action which provides poi categories

val positions: List<PMGeoPosition>? = null

Used with action which provides positions

val responseStatus: PMResponseStatus

Defines response status for action
Default value is PMResponseStatus.Success

val searchResults: List<PMSearchResult>? = null

Used with action which provides search results

val trafficInfo: PMTrafficInfo? = null

Returned traffic info

waypointChanged

val waypointChanged: PMCmdWaypointChanged? = null

Returned waypoint changed event