Warning
This feature is available in the Full MapKit SDK version
YMKSearchSession
|
@interface YMKSearchSession : NSObject |
Interface denoting ongoing search session. Allows search cancellation and retry. For many request types allows further searches.
Summary
Instance methods
|
- (void)cancel; |
|
- (void)retryWithResponseHandler: |
|
- (BOOL)hasNextPage; |
|
- (void)fetchNextPageWithResponseHandler: |
|
- (void)setFiltersWithFilters: |
|
- (void)setSortByDistanceWithOrigin:(nonnull YMKGeometry *)origin; |
|
- (void)resetSort; |
|
- (void)setSearchAreaWithArea:(nonnull YMKGeometry *)area; |
|
- (void)setSearchOptionsWithSearchOptions: |
|
- (void)resubmitWithResponseHandler: |
Instance methods
cancel
|
- (void)cancel; |
Cancels the current request.
retryWithResponseHandler:
|
- (void)retryWithResponseHandler: |
Retries the last request. If there is an active request, it is cancelled.
|
Parameters |
|
|
searchListener |
Listener to handle search result. |
hasNextPage
|
- (BOOL)hasNextPage; |
Check the availability of the next result page.
|
Returns |
|
True if there are more search results and one can call |
fetchNextPageWithResponseHandler:
|
- (void)fetchNextPageWithResponseHandler: |
Request the next page of search results. Ignored if the current request isn't ready. Will throw if called when YMKSearchSession::hasNextPage is false.
|
Parameters |
|
|
searchListener |
Listener to handle search result. |
setFiltersWithFilters:
|
- (void)setFiltersWithFilters: |
Undocumented
Alert
Use {@link SearchOptions#filters} instead.
setSortByDistanceWithOrigin:
|
- (void)setSortByDistanceWithOrigin:(nonnull YMKGeometry *)origin; |
Requests sorting by distance for future resubmits. Supported geometry types: point, polyline.
|
Parameters |
|
|
origin |
Origin to sort by distance from. |
resetSort
|
- (void)resetSort; |
Resets the sort if it was previously set (for example by YMKSearchSession::setSortByDistanceWithOrigin:) for future resubmits.
setSearchAreaWithArea:
|
- (void)setSearchAreaWithArea:(nonnull YMKGeometry *)area; |
Sets the search area for future resubmits. Supported geometry types: bounding box, polyline, polygon. Polygon is expected to be a search window: 4 points in outer ring (or 5 if last point is equal to first) and no inner rings.
|
Parameters |
|
|
area |
Search area for future resubmits. |
setSearchOptionsWithSearchOptions:
|
- (void)setSearchOptionsWithSearchOptions: |
Set searchOptions for future resubmits.
|
Parameters |
|
|
searchOptions |
Additional search parameters, see YMKSearchOptions. Supported options: YMKSearchOptions::origin, YMKSearchOptions::userPosition. |
resubmitWithResponseHandler:
|
- (void)resubmitWithResponseHandler: |
Redo the last search with currently set values of search area, search options, filters, sort type and sort origin. Isn't applicable to reverse geosearch and URI resolving. Ignored it the current request is the first one; cancels current request otherwise.
|
Parameters |
|
|
searchListener |
Listener to handle search result. |