Interface SearchManager

Type and modifiers

Method and Description

Session

submit(@NonNull java.lang.String text,
       @NonNull Geometry geometry,
       @NonNull SearchOptions searchOptions,
       @NonNull SearchListener searchListener)
Search request for searching a user query near given geometry.

Session

submit(@NonNull java.lang.String text,
       @NonNull Polyline polyline,
       @NonNull Geometry geometry,
       @NonNull SearchOptions searchOptions,
       @NonNull SearchListener searchListener)
Search request that is used to search for a user query along the given polyline inside the given window.

Session

submit(@NonNull Point point,
       @Nullable java.lang.Integer zoom,
       @NonNull SearchOptions searchOptions,
       @NonNull SearchListener searchListener)
Reverse search request (to search objects at the given coordinates)

Session

resolveURI(@NonNull java.lang.String uri,
           @NonNull SearchOptions searchOptions,
           @NonNull SearchListener searchListener)
Search request for URI resolution.

Session

searchByURI(@NonNull java.lang.String uri,
            @NonNull SearchOptions searchOptions,
            @NonNull SearchListener searchListener)
Search request with URI.

SuggestSession

createSuggestSession()
Creates session for suggest requests.

@NonNull
Session submit(@NonNull java.lang.String text,
               @NonNull Geometry geometry,
               @NonNull SearchOptions searchOptions,
               @NonNull SearchListener searchListener)

Parameters

text

User query.

geometry

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.

searchOptions

Various additional search parameters, see mapkit.search.SearchOptions definition for details.

searchListener

Listener to handle search result.

Returns

mapkit.search.Session which allows further searches, cancel and retry.

@NonNull
Session submit(@NonNull java.lang.String text,
               @NonNull Polyline polyline,
               @NonNull Geometry geometry,
               @NonNull SearchOptions searchOptions,
               @NonNull SearchListener searchListener)

Parameters

text

User query.

polyline

Polyline to search near; mapkit.search.Session#setSortByDistance(Geometry) is assumed on the first request.

geometry

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.

searchOptions

Various additional search parameters, see mapkit.search.SearchOptions definition for details.

searchListener

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.

@NonNull
Session submit(@NonNull Point point,
               @Nullable java.lang.Integer zoom,
               @NonNull SearchOptions searchOptions,
               @NonNull SearchListener searchListener)

Parameters

point

Coordinates to search at.

zoom

Current zoom level. Skips objects that are too small for a given zoom level.

searchOptions

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.

searchListener

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.

@NonNull
Session resolveURI(@NonNull java.lang.String uri,
                   @NonNull SearchOptions searchOptions,
                   @NonNull SearchListener searchListener)

Parameters

uri

Object uri.

searchOptions

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.

searchListener

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.

@NonNull
Session searchByURI(@NonNull java.lang.String uri,
                    @NonNull SearchOptions searchOptions,
                    @NonNull SearchListener searchListener)

Parameters

uri

Object uri.

searchOptions

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.

searchListener

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.

@NonNull
SuggestSession createSuggestSession()