profi-sdk-aos-ifc/com.sygic.profi.sdk.ifc.cmd/PMCmdClientIfc

PMCmdClientIfc

interface PMCmdClientIfc

Interface for sending/receiving commands to sygic profi navi

Functions

Link copied to clipboard
abstract fun intent(cmd: PMCommandRequest): PMCommandRequest

Intent @see PMCommandRequest

Link copied to clipboard
open fun naviAddFavorite(arg: PMLocationInfo): PMCommandRequest
open fun naviAddFavorite(correlationId: String, arg: PMLocationInfo): PMCommandRequest

Add new favorite

Link copied to clipboard
open fun naviAddOrUpdateItinerary(itinerary: PMCmdItinerary): PMCommandRequest
open fun naviAddOrUpdateItinerary(correlationId: String, itinerary: PMCmdItinerary): PMCommandRequest

Navigation add itinerary to the list managed by navigation

Link copied to clipboard
open fun naviAddWaypoint(arg: PMGeoPosition): PMCommandRequest
open fun naviAddWaypoint(correlationId: String, arg: PMGeoPosition): PMCommandRequest

Adds a waypoint to the active route

Link copied to clipboard
open fun naviCalculateDistance(arg: PMGeoPosition): PMCommandRequest
open fun naviCalculateDistance(correlationId: String, arg: PMGeoPosition): PMCommandRequest

User wants to calculate distance to a position

Link copied to clipboard
open fun naviCalculateDuration(arg: PMGeoPosition): PMCommandRequest
open fun naviCalculateDuration(correlationId: String, arg: PMGeoPosition): PMCommandRequest

User wants to calculate duration to a position

Link copied to clipboard
open fun naviCalculateRoute(arg: PMCalculateRoute): PMCommandRequest
open fun naviCalculateRoute(correlationId: String, arg: PMCalculateRoute): PMCommandRequest

User wants to calculate route to a position

Link copied to clipboard
open fun naviCancel(): PMCommandRequest
open fun naviCancel(correlationId: String): PMCommandRequest

User wants to cancel the previous action

Link copied to clipboard
open fun naviCurrentNaviStatus(): PMCommandRequest
open fun naviCurrentNaviStatus(correlationId: String): PMCommandRequest

Check for current navigation status

Link copied to clipboard
open fun naviCurrentPosition(): PMCommandRequest
open fun naviCurrentPosition(correlationId: String): PMCommandRequest

Get current position of the vehicle

Link copied to clipboard
open fun naviGetActiveMapMode(): PMCommandRequest
open fun naviGetActiveMapMode(correlationId: String): PMCommandRequest

Get active map modes

Link copied to clipboard
open fun naviGetCategoriesList(): PMCommandRequest
open fun naviGetCategoriesList(correlationId: String): PMCommandRequest

Get supported POI categories

Link copied to clipboard
open fun naviGetFavorites(): PMCommandRequest
open fun naviGetFavorites(correlationId: String): PMCommandRequest

Get user defined favorites

Link copied to clipboard
open fun naviGetItineraries(includeDetailedReport: Boolean): PMCommandRequest
open fun naviGetItineraries(correlationId: String, includeDetailedReport: Boolean): PMCommandRequest

List all itineraries managed by navigation

Link copied to clipboard
open fun naviGetLastDestinations(): PMCommandRequest
open fun naviGetLastDestinations(correlationId: String): PMCommandRequest

Get last searched / visited destinations

Link copied to clipboard
open fun naviGetMapUpdateStatus(): PMCommandRequest
open fun naviGetMapUpdateStatus(correlationId: String): PMCommandRequest

Request to get report about map download

Link copied to clipboard
open fun naviGetNavigationReport(): PMCommandRequest
open fun naviGetNavigationReport(correlationId: String): PMCommandRequest

Request to send current route status

Link copied to clipboard
open fun naviGetTrafficInfo(): PMCommandRequest
open fun naviGetTrafficInfo(correlationId: String): PMCommandRequest

Request for getting traffic info for the current route

Link copied to clipboard
open fun naviGetWaypoints(): PMCommandRequest
open fun naviGetWaypoints(correlationId: String): PMCommandRequest

Get list of waypoints for active route

Link copied to clipboard
open fun naviGuidancePrompt(arg: PMGuidancePrompt): PMCommandRequest
open fun naviGuidancePrompt(correlationId: String, arg: PMGuidancePrompt): PMCommandRequest

User wants to change the guidance prompts setting

Link copied to clipboard
open fun naviLocationSet(): PMCommandRequest
open fun naviLocationSet(correlationId: String): PMCommandRequest

Navigate to shown location

Link copied to clipboard
open fun naviMapUpdate(mapUpdateRequest: PMCmdMapUpdateRequest): PMCommandRequest
open fun naviMapUpdate(correlationId: String, mapUpdateRequest: PMCmdMapUpdateRequest): PMCommandRequest

Request to update/download map

Link copied to clipboard
open fun naviMapZoom(arg: PMMapCamera): PMCommandRequest
open fun naviMapZoom(correlationId: String, arg: PMMapCamera): PMCommandRequest

Update map camera setting

Link copied to clipboard
open fun naviNavigate(arg: String): PMCommandRequest
open fun naviNavigate(correlationId: String, arg: String): PMCommandRequest

User wants to navigate to an address / POI

Link copied to clipboard
open fun naviOpenFavorites(): PMCommandRequest
open fun naviOpenFavorites(correlationId: String): PMCommandRequest

User wants to open favorites

Link copied to clipboard
open fun naviOpenPoiCategory(): PMCommandRequest
open fun naviOpenPoiCategory(correlationId: String): PMCommandRequest

User wants to open poi category

Link copied to clipboard
open fun naviOpenSearch(): PMCommandRequest
open fun naviOpenSearch(correlationId: String): PMCommandRequest

User wants to open search

Link copied to clipboard
open fun naviOpenSettings(): PMCommandRequest
open fun naviOpenSettings(correlationId: String): PMCommandRequest

User wants to open settings

Link copied to clipboard
open fun naviPoiInfo(arg: String): PMCommandRequest
open fun naviPoiInfo(correlationId: String, arg: String): PMCommandRequest

User wants to see the location on map with information

Link copied to clipboard
open fun naviRemoveAllItineraries(): PMCommandRequest
open fun naviRemoveAllItineraries(correlationId: String): PMCommandRequest

Remove named itineraries from stored list of itineraries in navigation

Link copied to clipboard
open fun naviRemoveItineraries(itineraryIds: List<String>): PMCommandRequest
open fun naviRemoveItineraries(correlationId: String, itineraryIds: List<String>): PMCommandRequest

Remove named itineraries from stored list of itineraries in navigation

Link copied to clipboard
open fun naviRemoveRecents(): PMCommandRequest
open fun naviRemoveRecents(correlationId: String): PMCommandRequest

Recent destinations will be removed

Link copied to clipboard
open fun naviRemoveWaypoint(): PMCommandRequest
open fun naviRemoveWaypoint(correlationId: String): PMCommandRequest

Removes the next waypoint from the active route

open fun naviRemoveWaypoint(arg: PMGeoPosition): PMCommandRequest
open fun naviRemoveWaypoint(correlationId: String, arg: PMGeoPosition): PMCommandRequest

Removes a waypoint from the active route on specified position

Link copied to clipboard
open fun naviRepeatPrompt(): PMCommandRequest
open fun naviRepeatPrompt(correlationId: String): PMCommandRequest

Last navigation prompt will be played

Link copied to clipboard
open fun naviReplaceWaypoint(targetWaypoint: PMGeoPosition, changeWaypoint: PMGeoPosition): PMCommandRequest
open fun naviReplaceWaypoint(correlationId: String, targetWaypoint: PMGeoPosition, changeWaypoint: PMGeoPosition): PMCommandRequest

Request to replace waypoint on provided position to another

Link copied to clipboard
open fun naviResolveAddressFromCoordinates(arg: PMGeoPosition): PMCommandRequest
open fun naviResolveAddressFromCoordinates(correlationId: String, arg: PMGeoPosition): PMCommandRequest

Resolve location address from provided coordinates

Link copied to clipboard
open fun naviSearch(arg: PMSearch): PMCommandRequest
open fun naviSearch(correlationId: String, arg: PMSearch): PMCommandRequest

User wants to search for address

open fun naviSearch(arg: String): PMCommandRequest
open fun naviSearch(correlationId: String, arg: String): PMCommandRequest

User wants to search for address / POI

Link copied to clipboard
open fun naviSetActiveMapMode(arg: PMSetMapMode): PMCommandRequest
open fun naviSetActiveMapMode(correlationId: String, arg: PMSetMapMode): PMCommandRequest

Set active map modes

Link copied to clipboard
open fun naviSetItinerary(itinerary: PMCmdItinerary): PMCommandRequest
open fun naviSetItinerary(correlationId: String, itinerary: PMCmdItinerary): PMCommandRequest

Navigation set received itinerary, compute route and immediately start navigation on it

Link copied to clipboard
open fun naviSetMarkers(arg: List<PMGeoPosition>): PMCommandRequest
open fun naviSetMarkers(correlationId: String, arg: List<PMGeoPosition>): PMCommandRequest

Show details about location / locations

Link copied to clipboard
open fun naviSetRouteOption(routeOptions: List<PMSetRouteOption>): PMCommandRequest
open fun naviSetRouteOption(correlationId: String, routeOptions: List<PMSetRouteOption>): PMCommandRequest

Request to set route option

Link copied to clipboard
open fun naviStartGuidance(arg: PMStartGuidance): PMCommandRequest
open fun naviStartGuidance(correlationId: String, arg: PMStartGuidance): PMCommandRequest

User wants to start the guidance

Link copied to clipboard
open fun naviStartItinerary(itineraryId: String): PMCommandRequest
open fun naviStartItinerary(correlationId: String, itineraryId: String): PMCommandRequest

Navigation starts routing on previously added / updated itinerary

Link copied to clipboard
open fun naviStopGuidance(): PMCommandRequest
open fun naviStopGuidance(correlationId: String): PMCommandRequest

Cancels the navigation / guidance

Link copied to clipboard