Entries
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
Action: Request for getting current navigation status
Returns: PFCurrentNaviStatus
Action: Request for getting current vehicle position
Returns: PFGeoPosition
Action: Request for resolving location info from geo coordinates
Arguments:
position: PFGeoPosition
Returns location info: PFLocationInfo
Action: Search request
Arguments:
search: PFSearch
Returns search results: PFSearchResult
Action: Request for calculating route to a position
Arguments:
calculateRoute: PFCalculateRoute
Returns calculated routes: PFCalculateRouteResult
Postcondition: User will be presented with calculated routes
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
UseCase: Stop navigation
Precondition: Route is in progress
Action: Stops guidance - effectively finishing navigation
Postcondition: Free drive screen will be shown
Action: Request for getting categories list
Returns: PFPoiCategoryResult
Action: Request for placing markers
Arguments:
positions: PFGeoPosition
Action: Request for getting active map modes
Returns: PFMapMode
Action: Request for setting active map mode
Arguments:
mapMode: PFSetMapMode
Postcondition: Set map mode will be enabled/disabled
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
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
Action: Request for getting last destinations
Returns list of locations: PFLocationInfo
Action: Request for getting favorite by type
Returns location info: PFLocationInfo
Action: Request for adding favorite
Arguments:
locationInfo: PFLocationInfo
Postcondition: Provided location will be saved to favorites
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
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
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
Action: Request for getting waypoints for the current route
Returns: PFGeoPosition
Action: Request to add the provided position as a new waypoint
Arguments:
position: PFGeoPosition
Action: Request to remove waypoint on provided position, if no position is provided removes next waypoint
Arguments:
position: PFGeoPosition
Action: Navigation set received itinerary, compute route and immediately start navigation on it.
Arguments: PFCmdItinerary
Returns : PFCmdNavigationReport
Action: Navigation add itinerary to the list managed by navigation
Arguments: PFCmdItinerary
Action: Navigation starts routing on previously added / updated itinerary
Arguments:
argStr: itinerary ID
Returns : PFCmdNavigationReport
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
Action: Remove named itineraries from stored list of itineraries in navigation
Arguments: argStrs => itinerary ids
Action: Remove named itineraries from stored list of itineraries in navigation
Action: Request to send current route status
Arguments:
details : PFCmdNavigationReportRequest
Returns : PFCmdNavigationReport
Action: Request to update/download map
Arguments:
details : PFCmdMapUpdateRequest
Returns : PFCmdMapUpdateProgress
Action: Request to get report about download map
Arguments:
Returns : PFCmdMapUpdateProgress
Action: Navigation send this event, waypoint was visited
Arguments:
Returns : PFCmdWaypointChanged
Action: Navigation send this event, when an route/itinerary was started
Arguments:
Returns : PFCmdNavigationReport
Action: Navigation send this event, when an route/itinerary was finished
Arguments:
Returns : PFCmdNavigationReport
Action: Navigation send this event, when an route was edited ( for example waypoint was added or skipped )
Arguments:
Returns : PFCmdNavigationReport
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
Action: Navigation send this event, when update of a map was finished
Arguments:
Returns : PFCmdMapUpdateProgress
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
UseCase: User wants to open poi category
Precondition: User is in navigation or freedrive screen
Action : Opens poi category
Postcondition: POI Category is shown
UseCase: User wants to open settings
Precondition: User is in navigation or freedrive screen
Action : Opens settings
Postcondition: Settings is shown
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
Precondition: Navigating with visible map
Action: Last navigation prompt will be played
Action: Recent destinations will be removed
Precondition: Navigating with visible map
Action: Request for getting traffic info for the current route
Returns: PFTrafficInfo
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