offline/com.mapbox.search.offline/OfflineSearchOptions/Builder

Builder

Builder for OfflineSearchOptions instance creation.

Constructors

Functions

fun boundingBox(boundingBox: BoundingBox): OfflineSearchOptions.Builder

Limit results to only those contained within the supplied bounding box.

fun build(): OfflineSearchOptions

Create OfflineSearchOptions instance from builder data.

evSearchOptions

fun evSearchOptions(evSearchOptions: OfflineEvSearchOptions?): OfflineSearchOptions.Builder

Optional offline EV options.

fun limit(limit: Int): OfflineSearchOptions.Builder

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

fun origin(origin: Point): OfflineSearchOptions.Builder

Search origin point, used to calculate the distance to the search result.

fun proximity(proximity: Point?): OfflineSearchOptions.Builder

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

searchPlacesOutsideBoundingBox

fun searchPlacesOutsideBoundingBox(searchPlacesOutsideBoundingBox: Boolean): OfflineSearchOptions.Builder

By default, when boundingBox is applied, all results outside the bounding box are filtered out. If searchPlacesOutsideBoundingBox is set to true, the search for places will be global, meaning results outside the boundingBox will not be filtered out, even if a boundingBox is applied. Default if false.