Commands
What your application asks BeNav to do, grouped by what it acts on.
Application
- showAppStarts the application in the foreground
- startAppHiddenStarts the application in the background
- hideAppPuts the application in the background
- stopAppStops the application and service
- getAppInfoRetrieves version and licence information
- lockSettingsLocks/unlocks application settings
Guidance
- startGuidanceStarts navigation with specified points
- stopGuidanceStops the current navigation
- getNavigationProgressRetrieves navigation progress data
- getRouteOptionsRetrieves current route options
- setRouteOptionsSets new route options
Vehicle profiles
- editVehicleProfileCreates or modifies a vehicle profile (updated in 2.1.0 to add userPermission)
- selectVehicleProfileSelects a vehicle profile
- getVehicleProfileRetrieves details of a vehicle profile
- getVehicleProfilesListLists vehicle profiles created via RNC
- deleteVehicleProfileDeletes a vehicle profile
- displayVehicleProfileOnMapShows or hides the vehicle profile name on the map
Map
- showPoiCreates PoiStyle from given parameters if it does not exist already and display it on MapView
- hidePoiRemove specific Poi(s) from MapView, destroy their associated PoiStyle if not in use anymore
- hideAllPoisRemove all Pois from MapView and destroy their associated PoiStyle
- showPolygonCreates PolygonStyle from received parameters if it does not exist already and display it on MapView
- hidePolygonRemove specific Polygon(s) from MapView, destroy their associated PolygonStyle if not in use anymore
- zoomToCentres the map on a point at a given zoom level (2D, north-up)
- configureAlertsConfigure traffic signs and vehicle alerts
Messages and statuses
- showMessageShow one message as Notification or Popup If multiple message are sent, they are queued
- hideMessageHide message
- updateVehicleStatusesPushes the set of selectable vehicle statuses (id, localised names, icon)
- setVehicleStatusForces the current vehicle status by id