SearchNavigationOptions

class SearchNavigationOptions @JvmOverloads() constructor(navigationProfile: NavigationProfile, etaType: EtaType?) : Parcelable
Content copied to clipboard

Additional search options to improve navigation experience.

If only navigationProfile is provided, search results will not have information about ETA, but search ranking logic will be affected: the faster you can walk/drive to the point, the higher search result rank.

If both navigationProfile and etaType are provided, it indicates that the caller intends to perform a higher cost navigation ETA estimate. Please note, either SearchOptions.origin should be specified or com.mapbox.android.core.location.LocationEngine should provide location in order to calculate ETA. Also, ETA will not be calculated, if it's impossible to build a route from provided origin point to the destination.

Constructors

SearchNavigationOptions
Link copied to clipboard
@JvmOverloads()
fun SearchNavigationOptions(navigationProfile: NavigationProfile, etaType: EtaType? = null)
Content copied to clipboard

Functions

describeContents
Link copied to clipboard
abstract fun describeContents(): Int
Content copied to clipboard
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)
Content copied to clipboard

Properties

etaType
Link copied to clipboard
val etaType: EtaType? = null
Content copied to clipboard
Indicates that the caller intends to perform a higher cost navigation ETA estimate.
navigationProfile
Link copied to clipboard
val navigationProfile: NavigationProfile
Content copied to clipboard
Used to calculate ETA from SearchOptions.origin point to a search suggestion and search result or to affect search ranking logic.