search

abstract suspend fun search(query: DiscoverApiQuery, proximity: Point, options: DiscoverApiOptions = DiscoverApiOptions()): Expected<Exception, List<DiscoverApiResult>>

Search for places nearby the specified geographic point.

Return

Result of the search request, one of error or value.

Parameters

query

Search query.

proximity

Geographic point to search nearby.

options

Search options.

abstract suspend fun search(query: DiscoverApiQuery, region: BoundingBox, proximity: Point? = null, options: DiscoverApiOptions = DiscoverApiOptions()): Expected<Exception, List<DiscoverApiResult>>

Search for places inside the specified bounding box.

Return

Result of the search request, one of error or value.

Parameters

query

Search query.

region

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

proximity

Optional geographic point to search nearby. Bias the response to favor results that are closer to this location. If not specified the SDK will try to get user location from the LocationEngine that was provided in the DiscoverApi.create.

options

Search options.

abstract suspend fun search(query: DiscoverApiQuery, route: List<Point>, deviation: RouteDeviationOptions = RouteDeviationOptions.DEFAULT_DEVIATION, options: DiscoverApiOptions = DiscoverApiOptions()): Expected<Exception, List<DiscoverApiResult>>

Search for places along the road.

Return

Result of the search request, one of error or value.

Parameters

query

Search query.

route

Route to search across. At least 2 points must be provided.

deviation

Option describing maximum detour from route. Default deviation is 10 minutes.

options

Search options.