SYSearchSession Class Reference

The Search Session class processes requests to find specific places. New request makes the currently processing request to fail with Cancelled status, however, the completion call is scheduled asynchronously, so it's possible that the completion of the previous request is called with non-Cancelled status after the new request is started. More...

#import <SYSearch.h>

Inheritance diagram for SYSearchSession:

Collaboration diagram for SYSearchSession:

Instance Methods
(void)	- autocomplete:withCompletion:
	Gets quick autocomplete results for a search query. After this request the session remains valid and can process new requests. Autocomplete result doesn't contain full information, to get the detailed result, call geocodeLocation with location ID from autocomplete result. New autocomplete request makes the currently processing request to fail with Cancelled status, however, the completion call is scheduled asynchronously, so it's possible that the completion of the previous request is called with non-Cancelled status after the new request is started. More...
(void)	- finishByRequestingGeocodeLocation:withCompletion:
	Gets geocoding result (detailed result) from a location ID. Location ID should be taken from SYSearchAutocompleteResult. After this request the session is finished and cannot process new requests. More...
(void)	- finishByRequestingGeocode:withCompletion:
	Gets geocoding results (detailed results) from a search request. After this request the session is finished and cannot process new requests. More...
(void)	- finishByRequestingPlaces:withCompletion:
	Gets nearby places of the requested categories. After this request the session is finished and cannot process new requests. More...
(nonnull instancetype)	- initWithWrapper:customData: [implementation]

Properties
BOOL	isValid
	Indicates if the session can process new requests. More...

Detailed Description

The Search Session class processes requests to find specific places. New request makes the currently processing request to fail with Cancelled status, however, the completion call is scheduled asynchronously, so it's possible that the completion of the previous request is called with non-Cancelled status after the new request is started.

Method Documentation

autocomplete:withCompletion:()

- (void) autocomplete:		(nonnull SYSearchRequest *)	request
withCompletion:		(nonnull SYSearchAutocompleteCompletionBlock)	completion

Gets quick autocomplete results for a search query. After this request the session remains valid and can process new requests. Autocomplete result doesn't contain full information, to get the detailed result, call geocodeLocation with location ID from autocomplete result. New autocomplete request makes the currently processing request to fail with Cancelled status, however, the completion call is scheduled asynchronously, so it's possible that the completion of the previous request is called with non-Cancelled status after the new request is started.

Parameters

request	search query and location
completion	is called asynchronously, after the request is processed, it provides autocomplete results or an error.

finishByRequestingGeocode:withCompletion:()

- (void) finishByRequestingGeocode:		(nonnull SYSearchRequest *)	request
withCompletion:		(nonnull SYSearchGeocodeCompletionBlock)	completion

Gets geocoding results (detailed results) from a search request. After this request the session is finished and cannot process new requests.

Parameters

request	search query and location
completion	is called asynchronously, after the request is processed, it provides an array of detailed results, or an error.

finishByRequestingGeocodeLocation:withCompletion:()

- (void) finishByRequestingGeocodeLocation:		(nonnull SYGeocodeLocationRequest *)	request
withCompletion:		(nonnull SYSearchGeocodeLocationCompletionBlock)	completion

Gets geocoding result (detailed result) from a location ID. Location ID should be taken from SYSearchAutocompleteResult. After this request the session is finished and cannot process new requests.

Parameters

request	location ID from the autocomplete result
completion	is called asynchronously, after the request is processed, it provides one detailed result or an error.

finishByRequestingPlaces:withCompletion:()

- (void) finishByRequestingPlaces:		(nonnull SYSearchPlacesRequest *)	request
withCompletion:		(nonnull SYSearchPlacesCompletionBlock)	completion

Gets nearby places of the requested categories. After this request the session is finished and cannot process new requests.

Parameters

request	wanted category tags and search location
completion	is called asynchronously, after the request is processed, it provides an array of detailed results, or an error. Also it may contain SYSearchMorePlacesSession parameter, for requesting more nearby places of the same categories.

initWithWrapper:customData:()

- (nonnull instancetype) initWithWrapper: (nonnull SYSearchSdkSessionWrapper *)  wrapper customData: (nullable SYSearchCustomDataSource *)  customData

implementation

Property Documentation

isValid

- (BOOL) isValid

readnonatomicassign

Indicates if the session can process new requests.

---

The documentation for this class was generated from the following file:

• SYSearch.h