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

PMCommandRequest

data class PMCommandRequest(val correlationId: String? = null, val action: PMAction, val position: PMGeoPosition? = null, val positions: List<PMGeoPosition>? = null, val locationInfo: PMLocationInfo? = null, val search: PMSearch? = null, val calculateRoute: PMCalculateRoute? = null, val startGuidance: PMStartGuidance? = null, val mapMode: PMSetMapMode? = null, val guidancePrompt: PMGuidancePrompt, val mapCamera: PMMapCamera, val argStr: String? = null, val argBool: Boolean = false, val argStrs: List<String>? = null, val itinerary: PMCmdItinerary? = null, val navigationReportRequest: PMCmdNavigationReportRequest? = null, val mapUpdateRequest: PMCmdMapUpdateRequest? = null, val routeOptions: List<PMSetRouteOption>? = null)

Represents request of user speech to a command containing context for Profi Navi

Constructors

PMCommandRequest

fun PMCommandRequest(correlationId: String? = null, action: PMAction, position: PMGeoPosition? = null, positions: List<PMGeoPosition>? = null, locationInfo: PMLocationInfo? = null, search: PMSearch? = null, calculateRoute: PMCalculateRoute? = null, startGuidance: PMStartGuidance? = null, mapMode: PMSetMapMode? = null, guidancePrompt: PMGuidancePrompt, mapCamera: PMMapCamera, argStr: String? = null, argBool: Boolean = false, argStrs: List<String>? = null, itinerary: PMCmdItinerary? = null, navigationReportRequest: PMCmdNavigationReportRequest? = null, mapUpdateRequest: PMCmdMapUpdateRequest? = null, routeOptions: List<PMSetRouteOption>? = null)

Properties

val action: PMAction

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

val argBool: Boolean = false

Used to enrich action with true/false paremeter

val argStr: String? = null

Used to enrich action with custom text, f.e. recognized address by speech recognition

val argStrs: List<String>? = null

Used to enrich action with several custom texts

val calculateRoute: PMCalculateRoute? = null

Used with action which starts route calculation

val correlationId: String? = null

Defines attribute used for correlating messages within different asynchronous calls

val guidancePrompt: PMGuidancePrompt

Used with action which controls guidance prompt
Default value is PMGuidancePrompt.Unmute

val itinerary: PMCmdItinerary? = null

Itinerary to be used

val locationInfo: PMLocationInfo? = null

Used with action which provides location info

val mapCamera: PMMapCamera

Used with action which controls map camera setting
Default value is PMMapCamera.Reset

val mapMode: PMSetMapMode? = null

Used with action which sets map mode

mapUpdateRequest

val mapUpdateRequest: PMCmdMapUpdateRequest? = null

Request for map update

navigationReportRequest

val navigationReportRequest: PMCmdNavigationReportRequest? = null

request to send report about status of current route

val position: PMGeoPosition? = null

Used with action which provides position

val positions: List<PMGeoPosition>? = null

Used with action which provides array of positions

val routeOptions: List<PMSetRouteOption>? = null

Route option to be set

val search: PMSearch? = null

Used with action which starts search

val startGuidance: PMStartGuidance? = null

Used with action which starts guidance