Warning
This feature is available in the Full MapKit version
Package com.yandex.mapkit.search
Interface SearchManager
interface SearchManager
Main interface to start search.
Summary
Methods
Type and modifiers |
Method and Description |
submit(@NonNull java.lang.String text, |
|
submit(@NonNull java.lang.String text, |
|
submit(@NonNull Point point, |
|
resolveURI(@NonNull java.lang.String uri, |
|
searchByURI(@NonNull java.lang.String uri, |
|
createSuggestSession() |
Methods
submit
@NonNull |
Search request for searching a user query near given geometry.
Parameters |
|
|
User query. |
|
Geometry to search near. Supported types: point, bounding box, polyline and polygon. If the polyline is provided, setSortByDistance(polyline) is assumed on the first request. Polygon is expected to be a search window: 4 points in outer ring (or 5 if the last point is equal to the first) and no inner rings. |
|
Various additional search parameters, see mapkit.search.SearchOptions definition for details. |
|
Listener to handle search result. |
Returns |
mapkit.search.Session which allows further searches, cancel and retry. |
submit
@NonNull |
Search request that is used to search for a user query along the given polyline inside the given window.
Parameters |
|
|
User query. |
|
Polyline to search near; mapkit.search.Session#setSortByDistance(Geometry) is assumed on the first request. |
|
Geometry to search near; supported types: point, bounding box, polyline and polygon. Polygon is expected to be a search window: 4 points in outer ring (or 5 if the last point is equal to first) and no inner rings. |
|
Various additional search parameters, see mapkit.search.SearchOptions definition for details. |
|
Listener to handle search result. |
Returns |
mapkit.search.Session which allows further searches, cancel and retry. Session should be stored by user or search is automatically cancelled. |
submit
@NonNull |
Reverse search request (to search objects at the given coordinates)
Parameters |
|
|
Coordinates to search at. |
|
Current zoom level. Skips objects that are too small for a given zoom level. |
|
Additional search parameters, see mapkit.search.SearchOptions definition for details. Currently the only supported options are mapkit.search.SearchOptions#origin, mapkit.search.SearchOptions#searchTypes and mapkit.search.SearchOptions#snippets. Only 'geo' and 'biz' types are supported and not at the same time. |
|
Listener to handle search result. |
Returns |
mapkit.search.Session which allows further searches, cancel and retry. Session should be stored by user or search is automatically cancelled. |
resolveURI
@NonNull |
Search request for URI resolution.
Parameters |
|
|
Object uri. |
|
Additional search parameters, see mapkit.search.SearchOptions definition for details. Currently the only supported options are mapkit.search.SearchOptions#origin and mapkit.search.SearchOptions#snippets. |
|
Listener to handle search result. |
Returns |
mapkit.search.Session which allows search cancel and retry. Should be stored by user or search is automatically cancelled. |
searchByURI
@NonNull |
Search request with URI.
Allows multiple results in response.
Parameters |
|
|
Object uri. |
|
Additional search parameters, see mapkit.search.SearchOptions definition for details. Currently the only supported options are mapkit.search.SearchOptions#origin, mapkit.search.SearchOptions#snippets and. mapkit.search.SearchOptions#resultPageSize. |
|
Listener to handle search result. |
Returns |
mapkit.search.Session which allows search cancel and retry. Should be stored by user or search is automatically cancelled. |
createSuggestSession
@NonNull |
Creates session for suggest requests.