Base/com.mapbox.navigation.base.options/NavigationOptions/Builder/nativeRouteObject

nativeRouteObject

fun nativeRouteObject(value: Boolean): NavigationOptions.Builder

Defines whether to use native route object.

This is an early preview feature. When this option is enabled, some functionality is disabled or not fully supported:

  • Traffic override is not supported. Navigator instantiation throws an exception when both nativeRouteObject and TrafficOverrideOptions.isEnabled are set to true.

  • Subtypes of DirectionsJsonObject (for example, com.mapbox.api.directions.v5.models.DirectionsResponse) do not support the toBuilder() function.

  • The contract of equals() / hashCode() is not met for subtypes of DirectionsJsonObject.

  • Route refresh is not supported.

  • A route parsed using the native route object may not fully match the same route parsed with nativeRouteObject set to false.