Builder

class Builder
Content copied to clipboard

Builder for comfortable creation of SearchOptions instance.

Constructors

Builder
Link copied to clipboard
fun Builder()
Content copied to clipboard

Functions

boundingBox
Link copied to clipboard
fun boundingBox(boundingBox: BoundingBox): SearchOptions.Builder
Content copied to clipboard
Limit results to only those contained within the supplied bounding box.
build
Link copied to clipboard
fun build(): SearchOptions
Content copied to clipboard
Create SearchOptions instance from builder data.
countries
Link copied to clipboard
fun countries(vararg countries: IsoCountryCode): SearchOptions.Builder
Content copied to clipboard
Limit results to one or more countries.
fun countries(countries: List<IsoCountryCode>): SearchOptions.Builder
Content copied to clipboard
Limit results to one or more countries.
fuzzyMatch
Link copied to clipboard
fun fuzzyMatch(fuzzyMatch: Boolean): SearchOptions.Builder
Content 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).
ignoreIndexableRecords
Link copied to clipboard
fun ignoreIndexableRecords(ignoreIndexableRecords: Boolean): SearchOptions.Builder
Content copied to clipboard
Non-verified query parameters, that will be added to the server API request.
indexableRecordsDistanceThresholdMeters
Link copied to clipboard
fun indexableRecordsDistanceThresholdMeters(threshold: Double?): SearchOptions.Builder
Content 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): SearchOptions.Builder
Content copied to clipboard
Specify the user’s language.
fun languages(languages: List<IsoLanguageCode>): SearchOptions.Builder
Content copied to clipboard
Specify the user’s language.
limit
Link copied to clipboard
fun limit(limit: Int): SearchOptions.Builder
Content copied to clipboard
Specify the maximum number of results to return.
navigationOptions
Link copied to clipboard
fun navigationOptions(navigationOptions: SearchNavigationOptions): SearchOptions.Builder
Content copied to clipboard
Navigation options used for proper calculation of ETA and results ranking.
origin
Link copied to clipboard
fun origin(origin: Point): SearchOptions.Builder
Content copied to clipboard
Point for ETA calculation from it to search result.
proximity
Link copied to clipboard
fun proximity(proximity: Point?): SearchOptions.Builder
Content copied to clipboard
Bias the response to favor results that are closer to this location, provided as Point class instance.
requestDebounce
Link copied to clipboard
fun requestDebounce(debounce: Int): SearchOptions.Builder
Content copied to clipboard
Request debounce value in milliseconds.
routeOptions
Link copied to clipboard
fun routeOptions(routeOptions: RouteOptions): SearchOptions.Builder
Content copied to clipboard
Options to configure Route for search along the route functionality.
types
Link copied to clipboard
fun types(vararg types: QueryType): SearchOptions.Builder
Content copied to clipboard
Filter results to include only a subset (one or more) of the available feature types.
fun types(types: List<QueryType>): SearchOptions.Builder
Content copied to clipboard
Filter results to include only a subset (one or more) of the available feature types.
unsafeParameters
Link copied to clipboard
fun unsafeParameters(unsafeParameters: Map<String, String>): SearchOptions.Builder
Content copied to clipboard
Non-verified query parameters, that will be added to the server API request.