PTV Navigator Remote Interface Documentation
Variables

Load a given BCR file and set the target stations according to the stations

Variables

final int MSG_RI_LOAD_BCR_FROM_EXTERNAL_DIR = 303

Detailed Description

Load a BCR file from external directory

Loads a BCR file from an external directory, copies it to the temporary bcr directory of the Navigator (normally located under /sdcard/Android/data/com.ptv.navigation.app/files/bcr/) converts it to a json tour file, copies this to the tours directory, deletes the copied bcr file and fills the target station vector with the stations found in the BCR.
A file with the same name in the bcr directory and in the json directory will be overwritten by this function.
Attention: The client software must use a FileProvider to grant access to the file.

Loading a bcr is done by using the android FileProvider class to be able to grant the foreign navigator app access to files of this client (needed for Android >= 10). The steps to grant a permission is as following:

<provider android:name="androidx.core.content.FileProvider" android:authorities="com.ptvag.navigation.ritest.fileprovider" android:exported="false" android:grantUriPermissions="true"> <meta-data android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/filepaths"></meta-data> </provider> *

For more implementation details, please see the RITest demo app.

The visited flags of the target stations will also be set as found.

Sending bundle:

KeyValueType

Info

FileName The name of the BCR file with path as uri String

*

Returned error codes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_NOT_INITIALIZED if the Remote Interface service is not initialized yet.
RI_ERROR_NO_LICENSE if the navigator has no valid license.
RI_ERROR_NOT_ALLOWED if the start is not allowed in the current fragment.
RI_ERROR_FILE_ACCESS if the file could not be loaded (either because of not granted permissions or of other load error).


© PTV Group 2023 Generated on Tue Dec 5 2023 14:56:26 for PTV Navigator Remote Interface Documentation by doxygen 1.7.3