YMKSearchManager

class YMKSearchManager : NSObject

func submit(withText text: String,
                 geometry: YMKGeometry,
            searchOptions: YMKSearchOptions,
          responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession
Search request for searching a user query near given geometry

func submit(withText text: String,
                 polyline: YMKPolyline,
                 geometry: YMKGeometry,
            searchOptions: YMKSearchOptions,
          responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession
Search request that is used to search for a user query along the given polyline inside the given window

func submit(with point: YMKPoint,
                  zoom: NSNumber?,
         searchOptions: YMKSearchOptions,
       responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession
Reverse search request (to search objects at the given coordinates)

func resolveURI(withUri uri: String,
              searchOptions: YMKSearchOptions,
            responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession
Search request for URI resolution

func searchByURI(withUri uri: String,
               searchOptions: YMKSearchOptions,
             responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession
Search request with URI

func createSuggestSession() -> YMKSearchSuggestSession
Creates session for suggest requests

func submit(withText text: String,
                 geometry: YMKGeometry,
            searchOptions: YMKSearchOptions,
          responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession

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 YMKSearchOptions definition for details.

searchListener

Listener to handle search result.

Returns

YMKSearchSession which allows further searches, cancel and
retry.

func submit(withText text: String,
                 polyline: YMKPolyline,
                 geometry: YMKGeometry,
            searchOptions: YMKSearchOptions,
          responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession

Parameters

text

User query.

polyline

Polyline to search near; YMKSearchSession::setSortByDistanceWithOrigin: 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 YMKSearchOptions definition for details.

searchListener

Listener to handle search result.

Returns

YMKSearchSession which allows further searches, cancel and
retry. Session should be stored by user or search is automatically
cancelled.

func submit(with point: YMKPoint,
                  zoom: NSNumber?,
         searchOptions: YMKSearchOptions,
       responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession

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 YMKSearchOptions definition for details. Currently the only supported options are YMKSearchOptions::origin, YMKSearchOptions::searchTypes and YMKSearchOptions::snippets. Only 'geo' and 'biz' types are supported and not at the same time.

searchListener

Listener to handle search result.

Returns

YMKSearchSession which allows further searches, cancel and
retry. Session should be stored by user or search is automatically
cancelled.

func resolveURI(withUri uri: String,
              searchOptions: YMKSearchOptions,
            responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession

Parameters

uri

Object uri.

searchOptions

Additional search parameters, see YMKSearchOptions definition for details. Currently the only supported options are YMKSearchOptions::origin and YMKSearchOptions::snippets.

searchListener

Listener to handle search result.

Returns

YMKSearchSession which allows search cancel and retry. Should
be stored by user or search is automatically cancelled.

func searchByURI(withUri uri: String,
               searchOptions: YMKSearchOptions,
             responseHandler: @escaping YMKSearchSessionResponseHandler) -> YMKSearchSession

Parameters

uri

Object uri.

searchOptions

Additional search parameters, see YMKSearchOptions definition for details. Currently the only supported options are YMKSearchOptions::origin, YMKSearchOptions::snippets and. YMKSearchOptions::resultPageSize.

searchListener

Listener to handle search result.

Returns

YMKSearchSession which allows search cancel and retry. Should
be stored by user or search is automatically cancelled.

func createSuggestSession() -> YMKSearchSuggestSession