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!
- Sets a user hint on a big sign
- Load a given BCR file and set the target stations according to the stations
- Add a buddy with a given image to the map
- Load a preference file
General commands
- Go to the main activity
- Add a key value pair for further processing
- Retrieve a value for a certain key
- Get the visible position of the currently displayed map
- Sets a user hint on a small sign
- Sets a user hint on a big sign
- Speaks a user hint via text to speech
- Show a modal dialog the next time the user is in the main activity
- Show an assistant
- Bring the Navigator to front
- Get the Id of the device
- Get the IMEI of the device
- Get the current user id, f.e. the google account that registered the navigator
- Get the version string of the navigator app
- Get the current set language
- Get a list of all currently installed features
- Get the current set speaker
- Get the current free space on the device
- Download a BCR file to the device
- If set, WLAN connections will be used for downloading content, otherwise not
- Allocate space for an external application bar
- Set Day/Night mode for all MapViews
- Get Day/Night mode of all MapViews
- Delete BCR file from navigator 'bcr' directory
Station management commands
- Add a station to the target station list
- Delete all stations in the target station list
- Skip the current target station
- Load a given BCR file and set the target stations according to the stations
- Get all stations of the current tour
Coordinate related commands
- Geocode a given address (retrieve the position)
- Inverse geocode (get the address from a position)
- Get the visible position of the currently displayed map
GPS related commands
- Let the PTV Navigator use GPS only from RI
- Send location data to the PTV Navigator
- Let the PTV Navigator use GPS from the device
Navigation related commands
- Start a navigation
- Download a BCR file from an arbitrary URL und start the navigation with it
- Disable the possibility for the driver to choose its own destination
- Stop the current running navigation
- Get the current route trace
Profile related commands
- Get all available vehicle profiles
- Get the currently active vehicle profile
- Set an existing vehicle profile as active
- Import a profile
Preference related commands
Buddy management commands
- Add a buddy with a given image to the map
- Delete a buddy with a given id from the map
- Position a buddy with a given id on the map
- Add an alert for a given buddy id
- Delete an alert for a given buddy and alert id