API-Reference
This is an overview of all available commands of the remote interface. In case of an error, a specific Error value will be returned.
Warning
On devices using Android 10 (API level 29) and above, be sure to set the popup permission in the application permission settings. If you don't set it, the app will not come to foreground and some API functions will not work properly.
Android >= 11 related commands
Commands listed here have to be used as described in this paragraph to work with Android 11 and above!
General commands
- Set compatibility mode
- Bring the Navigator to front
- Goto start fragment
- Get the Id of the device
- Set the connection mode (online/hybrid)
- Allow/Forbid connection mode switching
- Allow/Forbid user interaction
- Set external app resources
Stop and waypoint management commands
- Add a stop to the target stop list
- Delete all stops in the target stop list
- Get all stops of the current tour
- Load a given BCR file and set the target stops according to the stops
Coordinate related commands
Map related commands
- Add a marker to the map
- Add a polyline to the map
- Add a polygon to the map
- Remove a marker from the map
- Remove a polyline from the map
- Remove a polygon from the map
Safety warner related commands
Download related commands
Navigation related commands
- Start a navigation
- Stop the current running navigation
- Get the current route trace
- Stop map matcher after destination reached
Profile related commands
- Get all available vehicle profiles
- Get the currently active vehicle profile
- Set an existing vehicle profile as active
- Import a profile
- Import a profile from an external directory
Preference related commands
Licensing related commands
- Get the license key
- Set the license key
- Logout the navigator
- Get the device description
- Set the device description