Builder

class Builder

Builder for comfortable creation of SearchOptions instance.

Constructors

Link copied to clipboard
fun Builder()

Functions

Link copied to clipboard
fun boundingBox(boundingBox: BoundingBox): SearchOptions.Builder

Limit results to only those contained within the supplied bounding box. The bounding box cannot cross the 180th meridian.

Link copied to clipboard

Create SearchOptions instance from builder data.

Link copied to clipboard
fun countries(vararg countries: IsoCountryCode): SearchOptions.Builder
fun countries(countries: List<IsoCountryCode>): SearchOptions.Builder

Limit results to one or more countries.

Link copied to clipboard

Specify whether the Geocoding API should attempt approximate, as well as exact, matching when performing searches (true, default), or whether it should opt out of this behavior and only attempt exact matching (false). For example, the default setting might return Washington, DC for a query of Washington, even though the query was misspelled.

Link copied to clipboard

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

Link copied to clipboard

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
fun languages(vararg languages: IsoLanguageCode): SearchOptions.Builder
fun languages(languages: List<IsoLanguageCode>): SearchOptions.Builder

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

Specify the maximum number of results to return. The maximum supported is 10.

Link copied to clipboard

Navigation options used for proper calculation of ETA and results ranking.

Link copied to clipboard
fun origin(origin: Point): SearchOptions.Builder

Point for ETA calculation from it to search result.

Link copied to clipboard
fun proximity(proximity: Point?): SearchOptions.Builder

Bias the response to favor results that are closer to this location, provided as Point class instance.

Link copied to clipboard

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

Options to configure Route for search along the route functionality.

Link copied to clipboard

Filter results to include only a subset (one or more) of the available feature types. Options are country, region, postcode, district, place, locality, neighborhood, address, and poi.

Link copied to clipboard

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