offline/com.mapbox.search.offline/OfflineSearchEngine/searchAlongRoute

searchAlongRoute

@MapboxExperimental
abstract fun searchAlongRoute(query: String, options: OfflineSearchAlongRouteOptions, executor: Executor, callback: OfflineSearchCallback): AsyncOperationTask

Performs a search along the supplied in the options route.

Return

AsyncOperationTask object which allows to cancel the request.

Parameters

query

the search query

options

the search along route options

executor

executor for dispatching event, by default events are dispatched to the main thread

callback

search result callback, delivers results on the main thread

@MapboxExperimental
open fun searchAlongRoute(query: String, options: OfflineSearchAlongRouteOptions, callback: OfflineSearchCallback): AsyncOperationTask

Performs a search along the supplied in the options route.

Return

AsyncOperationTask object which allows to cancel the request.

Parameters

query

the search query

options

the search along route options

callback

search result callback, delivers results on the main thread

abstract fun searchAlongRoute(query: String, proximity: Point, route: List<Point>, executor: Executor, callback: OfflineSearchCallback): AsyncOperationTask

Deprecated

Deprecated, use an overloading that accepts OfflineSearchAlongRouteOptions as a parameter

Replace with

searchAlongRoute(query, OfflineSearchAlongRouteOptions(route), executor, callback)
Content copied to clipboard

Deprecated: Use an overloaded function that accepts OfflineSearchAlongRouteOptions as a parameter instead. If you choose to use this function, it is recommended to set the first point of the route as the proximity for future compatibility. In upcoming SDK updates, the semantics of the proximity parameter will change.

Performs a search along the supplied route.

Return

AsyncOperationTask object which allows to cancel the request.

Parameters

query

the search query

proximity

coordinate along the route

route

list of points that make up route line

executor

executor for dispatching event, by default events are dispatched to the main thread

callback

search result callback, delivers results on the main thread

open fun searchAlongRoute(query: String, proximity: Point, route: List<Point>, callback: OfflineSearchCallback): AsyncOperationTask

Deprecated

Deprecated, use an overloading that accepts OfflineSearchAlongRouteOptions as a parameter

Replace with

searchAlongRoute(query, OfflineSearchAlongRouteOptions(route), callback)
Content copied to clipboard

Deprecated: Use an overloaded function that accepts OfflineSearchAlongRouteOptions as a parameter instead. If you choose to use this function, it is recommended to set the first point of the route as the proximity for future compatibility. In upcoming SDK updates, the semantics of the proximity parameter will change.

Performs a search along the supplied route.

Return

AsyncOperationTask object which allows to cancel the request.

Parameters

query

the search query

proximity

coordinate along the route

route

list of points that make up route line

callback

search result callback, delivers results on the main thread