sdk/com.mapbox.search/ForwardSearchOptions

ForwardSearchOptions

class ForwardSearchOptions : Parcelable

Search options, used for the "Text Search".

See also

Types

Link copied to clipboard
class Builder

Builder for comfortable creation of ForwardSearchOptions instance.

Functions

Link copied to clipboard
fun copy(proximity: Point? = this.proximity, boundingBox: BoundingBox? = this.boundingBox, countries: List<IsoCountryCode>? = this.countries, language: IsoLanguageCode? = this.language, limit: Int? = this.limit, types: List<QueryType>? = this.types, requestDebounce: Int? = this.requestDebounce, origin: Point? = this.origin, navigationOptions: SearchNavigationOptions? = this.navigationOptions, unsafeParameters: Map<String, String>? = this.unsafeParameters, ignoreIndexableRecords: Boolean = this.ignoreIndexableRecords, indexableRecordsDistanceThresholdMeters: Double? = this.indexableRecordsDistanceThresholdMeters): ForwardSearchOptions

Creates new ForwardSearchOptions from current instance.

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

Properties

Link copied to clipboard
val boundingBox: BoundingBox? = null

Limit results to only those contained within the supplied bounding box. The bounding box cannot cross the 180th meridian (longitude +/-180.0 deg.) and North or South pole (latitude +/- 90.0 deg.).

Link copied to clipboard
val countries: List<IsoCountryCode>? = null

Limit results to one or more countries.

Link copied to clipboard
val ignoreIndexableRecords: Boolean = false

Specify whether to ignore com.mapbox.search.record.IndexableRecord results or not, default is false. When search by com.mapbox.search.record.IndexableRecord is enabled, the results can be matched only by query string, while other parameters like countries, language, unsafeParameters (and some others) can be ignored.

Link copied to clipboard
val indexableRecordsDistanceThresholdMeters: Double? = null

Allows to look up for indexable records only within specified distance threshold, i.e. within a circle with this radius. Threshold specified in meters.

Link copied to clipboard
val language: IsoLanguageCode?

Specify the user’s language. This parameter controls the language of the text supplied in responses, and also affects result scoring, with results matching the user’s query in the requested language being preferred over results that match in another language. For example, an autocomplete query for things that start with Frank might return Frankfurt as the first result with an English (en) language parameter, but Frankreich (“France”) with a German (de) language parameter. If language is not set explicitly, then language from default system locale will be used.

Link copied to clipboard
val limit: Int? = null

Specify the maximum number of results to return, including results from com.mapbox.search.record.IndexableDataProvider. The maximum number of search results returned from the server is 10.

Link copied to clipboard
val navigationOptions: SearchNavigationOptions? = null

Navigation options used for Estimate Time Arrival (ETA) calculation in the response. When this parameters is specified, either origin or proximity is also should be provided.

Link copied to clipboard
val origin: Point? = null

When ETA calculation is enabled, location from which to calculate distance. When both proximity and origin are provided, origin is interpreted as the target of a route, while proximity indicates the current user location.

Link copied to clipboard
val proximity: Point? = null

Bias the response to favor results that are closer to a specific location. If not provided, the SDK will try to get current location from the SearchEngineSettings.locationProvider. If location is not available, the server we use IP as a proximity.

Link copied to clipboard
val requestDebounce: Int? = null

Request debounce value in milliseconds. Previous request will be cancelled if the new one made within specified by requestDebounce time interval.

Link copied to clipboard
val types: List<QueryType>? = null

Filter results to include only a subset (one or more) of the available feature types. See the Administrative unit types section for details about the types.

Link copied to clipboard
val unsafeParameters: Map<String, String>? = null

Non-verified query parameters, that will be added to the server API request.