Builder

class Builder

Builder for comfortable creation of BrandSearchOptions instance.

Constructors

Link copied to clipboard
fun Builder()

Functions

Link copied to clipboard
fun boundingBox(boundingBox: BoundingBox): BrandSearchOptions.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 BrandSearchOptions instance from builder data.

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

Limit results to one or more countries.

Link copied to clipboard
fun language(language: IsoLanguageCode): BrandSearchOptions.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, including results from com.mapbox.search.record.IndexableDataProvider. The maximum number of search results is determined by server.

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

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

Link copied to clipboard

Denotes whether to return closed POIs

Link copied to clipboard

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