Companion

object Companion

Functions

Link copied to clipboard
fun name(e: Int): String

Properties

Link copied to clipboard
const val EventItineraryEdit: Int = 103

Action: Navigation send this event, when an route was edited ( for example waypoint was added or skipped ) Arguments: Returns : PFCmdNavigationReport

Link copied to clipboard
const val EventItineraryETAChange: Int = 104

Action: Navigation send this event, when an ETA ( estimated tine of arrival ) was changed for the next waypoint. ( The whole itinerary is send to server ) Arguments: Returns : PFCmdNavigationReport

Link copied to clipboard
const val EventItineraryFinished: Int = 102

Action: Navigation send this event, when an route/itinerary was finished Arguments: Returns : PFCmdNavigationReport

Link copied to clipboard
const val EventItineraryStarted: Int = 101

Action: Navigation send this event, when an route/itinerary was started Arguments: Returns : PFCmdNavigationReport

Link copied to clipboard
const val EventMapUpdated: Int = 105

Action: Navigation send this event, when update of a map was finished Arguments: Returns : PFCmdMapUpdateProgress

Link copied to clipboard
const val EventWaypointVisited: Int = 100

Action: Navigation send this event, waypoint was visited Arguments: Returns : PFCmdWaypointChanged

Link copied to clipboard
Link copied to clipboard
const val NaviAddFavorite: Int = 17

Action: Request for adding favorite Arguments: locationInfo: PFLocationInfo Postcondition: Provided location will be saved to favorites

Link copied to clipboard

Action: Navigation add itinerary to the list managed by navigation Arguments: PFCmdItinerary

Link copied to clipboard
const val NaviAddWaypoint: Int = 22

Action: Request to add the provided position as a new waypoint Arguments: position: PFGeoPosition

Link copied to clipboard
const val NaviCalculateRoute: Int = 6

Action: Request for calculating route to a position Arguments: calculateRoute: PFCalculateRoute Returns calculated routes: PFCalculateRouteResult Postcondition: User will be presented with calculated routes

Link copied to clipboard
const val NaviCancel: Int = 1

UseCase: User wants to cancel the previous action Precondition: Some of the other actions happened before f.e. "NaviSearch" , "NaviNavigate" , "NaviPoiInfo" Action : Cancels the previous action Postcondition: Takes user back to the previous screen which was visible

Link copied to clipboard
const val NaviCurrentNaviStatus: Int = 2

Action: Request for getting current navigation status Returns: PFCurrentNaviStatus

Link copied to clipboard
const val NaviCurrentPosition: Int = 3

Action: Request for getting current vehicle position Returns: PFGeoPosition

Link copied to clipboard
const val NaviGetActiveMapMode: Int = 11

Action: Request for getting active map modes Returns: PFMapMode

Link copied to clipboard
const val NaviGetCategoriesList: Int = 9

Action: Request for getting categories list Returns: PFPoiCategoryResult

Link copied to clipboard
const val NaviGetFavorites: Int = 16

Action: Request for getting favorite by type Returns location info: PFLocationInfo

Link copied to clipboard
const val NaviGetItineraries: Int = 33

Action: List all itineraries managed by navigation Arguments: argBool true if detaile reports are required, if false only id and name is provided Returns : PFCmdItinerary

Link copied to clipboard

Action: Request for getting last destinations Returns list of locations: PFLocationInfo

Link copied to clipboard
const val NaviGetMapUpdateStatus: Int = 38

Action: Request to get report about download map Arguments: Returns : PFCmdMapUpdateProgress

Link copied to clipboard

Action: Request to send current route status Arguments: details : PFCmdNavigationReportRequest Returns : PFCmdNavigationReport

Link copied to clipboard
const val NaviGetTrafficInfo: Int = 115

Precondition: Navigating with visible map Action: Request for getting traffic info for the current route Returns: PFTrafficInfo

Link copied to clipboard
const val NaviGetWaypoints: Int = 21

Action: Request for getting waypoints for the current route Returns: PFGeoPosition

Link copied to clipboard
const val NaviGuidancePrompt: Int = 13

UseCase: User wants to change the guidance prompts setting Action: Changes guidance prompt setting by predefined value Arguments: guidancePrompt: PFGuidancePrompt Postcondition: Audio setting will be applied If argGuidancePrompt is PFGuidancePrompt:Unmute - Audio for route guidance will be unmuted If argGuidancePrompt is PFGuidancePrompt:Mute - Audio for route guidance will be muted

Link copied to clipboard
const val NaviLocationSet: Int = 19

UseCase: Navigate to shown location Precondition: Route is not in progress. Location is selected (Profi Navi shows POI detail) Action: Opens Profi Navi Route planner with computed route Postcondition: Profi Navi Route planner will show active route and if applicable other alternatives

Link copied to clipboard
const val NaviMapCamera: Int = 14

Action: Updates map camera setting Arguments: mapCamera: PFMapCamera Postcondition: If argZoom is PFMapCamera:Reset - Map display will reset to default zoom level. If actual zoom level is the same as default => nothing happens If argZoom is PFMapCamera:In - Map display will be zoomed in. If maxiumum zoom in => nothing happens If argZoom is PFMapCamera:Out - Map display will be zoomed out. If maximum zoom out => nothing happens If argZoom is PFMapCamera:Auto - Auto zoom setting for map display will be enabled If argZoom is PFMapCamera:twoDimensional - Shows map in 2D If argZoom is PFMapCamera:threeDimensional - Shows map in 3D

Link copied to clipboard
const val NaviMapUpdate: Int = 37

Action: Request to update/download map Arguments: details : PFCmdMapUpdateRequest Returns : PFCmdMapUpdateProgress

Link copied to clipboard
const val NaviNavigate: Int = 18

UseCase: User wants to navigate to an address / POI Precondition: Free drive, Navigating with visible map Action : Opens Profi Navi Route planner with computed route to the chosen address / POI Arguments: argStr: string == address / POI Postcondition: Profi Navi Route planner will show active route and if applicable other alternatives Alternative: If Route cannot be computed error will be shown

Link copied to clipboard
const val NaviNoOp: Int = 0

Precondition: NONE Action : Undefined action, no reaction from application Postcondition : NONE

Link copied to clipboard
const val NaviOpenFavorites: Int = 106

UseCase: User wants to open list of favorite places Precondition: User is in navigation or freedrive screen Action : Opens favorites Postcondition: Favorite screen is shown

Link copied to clipboard
const val NaviOpenPoiCategory: Int = 107

UseCase: User wants to open poi category Precondition: User is in navigation or freedrive screen Action : Opens poi category Postcondition: POI Category is shown

Link copied to clipboard
const val NaviOpenSettings: Int = 108

UseCase: User wants to open settings Precondition: User is in navigation or freedrive screen Action : Opens settings Postcondition: Settings is shown

Link copied to clipboard
const val NaviPoiInfo: Int = 20

UseCase: User wants to see the location on map with information Precondition: Free drive, Navigating with visible map, other POI detail shown Action: Show POI detail. From here you can call "NaviLocationSet" to plan route Arguments: argStr: string == address / POI Postcondition: List of information for the POI is listed and a marker is shown on the map

Link copied to clipboard

Action: Remove named itineraries from stored list of itineraries in navigation

Link copied to clipboard
const val NaviRemoveItineraries: Int = 34

Action: Remove named itineraries from stored list of itineraries in navigation Arguments: argStrs => itinerary ids

Link copied to clipboard
const val NaviRemoveRecents: Int = 114

Action: Recent destinations will be removed

Link copied to clipboard
const val NaviRemoveWaypoint: Int = 23

Action: Request to remove waypoint on provided position, if no position is provided removes next waypoint Arguments: position: PFGeoPosition

Link copied to clipboard
const val NaviRepeatPrompt: Int = 113

Precondition: Navigating with visible map Action: Last navigation prompt will be played

Link copied to clipboard
const val NaviReplaceWaypoint: Int = 116

Precondition: Navigating with visible map Action: Request to replace waypoint on provided position to another Postcondition: Route will be updated with the replaced waypoint Arguments: positions: PFGeoPosition

Link copied to clipboard

Action: Request for resolving location info from geo coordinates Arguments: position: PFGeoPosition Returns location info: PFLocationInfo

Link copied to clipboard
const val NaviSearch: Int = 5

Action: Search request Arguments: search: PFSearch Returns search results: PFSearchResult

Link copied to clipboard
const val NaviSetActiveMapMode: Int = 12

Action: Request for setting active map mode Arguments: mapMode: PFSetMapMode Postcondition: Set map mode will be enabled/disabled

Link copied to clipboard
const val NaviSetItinerary: Int = 30

Action: Navigation set received itinerary, compute route and immediately start navigation on it. Arguments: PFCmdItinerary Returns : PFCmdNavigationReport

Link copied to clipboard
const val NaviSetMarkers: Int = 10

Action: Request for placing markers Arguments: positions: PFGeoPosition

Link copied to clipboard
const val NaviSetRouteOption: Int = 109

UseCase: User wants to update route option for the ongoing route Precondition: Navigating with visible map Action: Profi Navi will calculate new route Arguments: routeOption: PFSetRouteOption == applied route option Postcondition: Profi Navi navigates to destination with updated route option Alternative: If route cannot be computed error will be shown

Link copied to clipboard
const val NaviStartGuidance: Int = 7

UseCase: Start navigation Precondition: Calculated routes are shown Action: Request for starting guidance with specified route Arguments: startGuidance: PFStartGuidance Postcondition: Starts navigation and user will be guided to specified destination

Link copied to clipboard
const val NaviStartItinerary: Int = 32

Action: Navigation starts routing on previously added / updated itinerary Arguments: argStr: itinerary ID Returns : PFCmdNavigationReport

Link copied to clipboard
const val NaviStopGuidance: Int = 8

UseCase: Stop navigation Precondition: Route is in progress Action: Stops guidance - effectively finishing navigation Postcondition: Free drive screen will be shown