Builder

class Builder

Builder for comfortable creation of CategorySearchOptions instance.

Constructors

Builder
Link copied to clipboard
fun Builder()

Functions

boundingBox
Link copied to clipboard
fun boundingBox(boundingBox: BoundingBox): CategorySearchOptions.Builder
Limit results to only those contained within the supplied bounding box.
build
Link copied to clipboard
fun build(): CategorySearchOptions
Create CategorySearchOptions instance from builder data.
countries
Link copied to clipboard
fun countries(vararg countries: IsoCountryCode): CategorySearchOptions.Builder
Limit results to one or more countries.
fun countries(countries: List<IsoCountryCode>): CategorySearchOptions.Builder
Limit results to one or more countries.
fuzzyMatch
Link copied to clipboard
fun fuzzyMatch(fuzzyMatch: Boolean): CategorySearchOptions.Builder
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).
ignoreIndexableRecords
Link copied to clipboard
fun ignoreIndexableRecords(ignoreIndexableRecords: Boolean): CategorySearchOptions.Builder
Specify whether to ignore com.mapbox.search.record.IndexableRecord results or not, default is false.
indexableRecordsDistanceThresholdMeters
Link copied to clipboard
Allows to look up for indexable records only within specified distance threshold, i.e.
languages
Link copied to clipboard
fun languages(vararg languages: IsoLanguageCode): CategorySearchOptions.Builder
Specify the user’s language.
fun languages(languages: List<IsoLanguageCode>): CategorySearchOptions.Builder
Specify the user’s language.
limit
Link copied to clipboard
fun limit(limit: Int): CategorySearchOptions.Builder
Specify the maximum number of results to return.
navigationProfile
Link copied to clipboard
fun navigationProfile(navigationProfile: NavigationProfile): CategorySearchOptions.Builder
Type of movement.
origin
Link copied to clipboard
fun origin(origin: Point): CategorySearchOptions.Builder
Point for alternative search ranking logic, that is turned on if navigationProfile is specified.
proximity
Link copied to clipboard
fun proximity(proximity: Point?): CategorySearchOptions.Builder
Bias the response to favor results that are closer to this location, provided as Point.
requestDebounce
Link copied to clipboard
fun requestDebounce(debounce: Int): CategorySearchOptions.Builder
Request debounce value in milliseconds.
routeOptions
Link copied to clipboard
fun routeOptions(routeOptions: RouteOptions): CategorySearchOptions.Builder
Options to configure Route for search along the route functionality.
unsafeParameters
Link copied to clipboard
fun unsafeParameters(unsafeParameters: Map<String, String>): CategorySearchOptions.Builder
Non-verified query parameters, that will be added to the server API request.