sdk/com.mapbox.search/SearchNavigationOptions

SearchNavigationOptions

class SearchNavigationOptions @JvmOverloads constructor(val navigationProfile: NavigationProfile, val etaType: EtaType? = null) : Parcelable

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

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

Functions

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

Properties

Link copied to clipboard
val etaType: EtaType? = null

Indicates that the caller intends to perform a higher cost navigation ETA estimate. Please note, that 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.

Link copied to clipboard
val navigationProfile: NavigationProfile

Used to calculate ETA from SearchOptions.origin point to a search suggestion and search result or to affect search ranking logic.