Load preferences from a file

Variables
final int	MSG_RI_LOAD_PREFERENCES = 129

---

Detailed Description

Load an preferences_import.json file from an external directory

Loads a preference file from an external directory, copies it to the files directory of the Navigator (normally located under /sdcard/Android/data/com.ptv.navigation.app/files/) and imports it's values to the navigator.
A file with the same name in the files directory will be overwritten by this function.
The file name can be arbitrary.
Attention: The client software must use a FileProvider to grant access to the file.

Loading a file 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/11). The steps to grant a permission is as following:

• Create a xml file in the res/xml folder of your project and list all directories in your app namespace that should be able to be accessed from outside, see the res/xml/filepaths.xml file in this project as an example.
• Add a FileProvider to the manifest file (in the application section). Set the android:resource to above created xml file

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

• Create a file object with the file you want to transfer/share
• Create an uri for that file with FileProvider.getUriForFile()
• Grant access permissions to this file for a specific package (here we use the navigator as the receiver) with getContext().grantUriPermission(). Use FLAG_GRANT_READ_URI_PERMISSION for minimal reading permission
• If wanted, you can revoke the permission after the navigator sent back the response that the file was loaded (the navigator will copy the file to the navigator files directory (files with the same name will be overwritten) to be able to access it, and therefore it is save to revoke the permission after the navigator response).

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

Sending bundle:

Key	Value	Type	Info
FileName	The name of the preference 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_FILE_ACCESS if the file could not be loaded (either because of not granted permissions or of other load error).
RI_ERROR_NO_LICENSE if the navigator has no valid license.