sdk/com.mapbox.search/BrandSearchOptions

BrandSearchOptions

class BrandSearchOptions @JvmOverloads constructor(val proximity: Point? = null, val boundingBox: BoundingBox? = null, val countries: List<IsoCountryCode>? = null, val language: IsoLanguageCode? = defaultLocaleLanguage(), val limit: Int? = null, val showClosedPOIs: Boolean? = null, val unsafeParameters: Map<String, String>? = null) : Parcelable

Search options, used for brand search.

Constructors

BrandSearchOptions

@JvmOverloads

fun BrandSearchOptions(proximity: Point? = null, boundingBox: BoundingBox? = null, countries: List<IsoCountryCode>? = null, language: IsoLanguageCode? = defaultLocaleLanguage(), limit: Int? = null, showClosedPOIs: Boolean? = null, unsafeParameters: Map<String, String>? = null)

Types

Builder

class Builder

Builder for comfortable creation of BrandSearchOptions instance.

Functions

copy

fun copy(proximity: Point? = this.proximity, boundingBox: BoundingBox? = this.boundingBox, countries: List<IsoCountryCode>? = this.countries, language: IsoLanguageCode? = this.language, limit: Int? = this.limit, showClosedPOIs: Boolean? = this.showClosedPOIs, unsafeParameters: Map<String, String>? = this.unsafeParameters): BrandSearchOptions

Creates new BrandSearchOptions from current instance.

describeContents

abstract fun describeContents(): Int

toBuilder

fun toBuilder(): BrandSearchOptions.Builder

Creates new BrandSearchOptions.Builder from current BrandSearchOptions instance.

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

boundingBox

val boundingBox: BoundingBox? = null

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

countries

val countries: List<IsoCountryCode>? = null

Limit results to one or more countries.

language

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.

limit

val limit: Int? = null

Specify the maximum number of results to return. The maximum number of search results is determined by server

proximity

val proximity: Point? = null

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

showClosedPOIs

val showClosedPOIs: Boolean? = null

Determines whether to return “closed” POIs.

unsafeParameters