PTV Navigator Remote Interface Documentation
Variables

Set a preference value

Variables

final int MSG_RI_SET_PREFERENCES = 126

Detailed Description

Set preferences of the application

Sets a bundle of preferences in the application.
Attention: Some preferences like setting language or connection mode are only possible when there is currently no navigation running. Otherwise the settings will get rejected and an error is returned. In this case you first have to stop the navigation.

Sending bundle:

KeyValueType

Info

Preferences Key value pairs of the preferences to set Bundle

Example

 {.cpp}
    Bundle preferences = new Bundle();
    preferences.putString("map_day_night", "Nightly");
    preferences.putBoolean("traffic_avoid", false);
    Bundle data = new Bundle();
    data.putBundle("Preferences", preferences);

Returned error codes:

RI_ERROR_NONE in case the preference was set correctly.
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_INVALID_PARAMETER in case the preference type is not correct
RI_ERROR_NOT_DURING_NAVIGATION if the app is currently navigating.
RI_ERROR_NO_LICENSE if the navigator has no valid license.


© PTV Logistics 2024 Generated on Tue May 27 2025 16:37:35 for PTV Navigator Remote Interface Documentation by doxygen 1.7.3