Represents an interface for a search request. More...

#import <SYSearch.h>

Inheritance diagram for SYSearchRequest:

Collaboration diagram for SYSearchRequest:

Instance Methods
(nonnull instancetype)	- initWithQuery:location:
	Creates a geocoder request that resolves a free text query. More...

(nonnull instancetype)	- initWithQuery:location:filter:
	Creates a geocoder request that resolves a free text query. More...

(void)	- fillSdkRequest:isoVector: `[implementation]`

Properties
NSUInteger	maxResultsCount
	The maximum number of items in the response. Default value is 10. More...

NSString *	preferredLanguage
	NSString representing the preferred language for request responses. Default value is [[NSLocale preferredLanguages] objectAtIndex:0]. More...

SYSearchResultTypeFilter	resultTypeFilter
	Only results of types included in filter will be returned in completion block. Default value is SYSearchResultFilterAll, means searching all result types. More...

NSArray< NSString * > *	countryFilter
	Array of country ISO codes. If set, only results from specified countries will be returned. Default value is nil, means searching in all countries. More...

SYGeoBoundingBox *	box `[implementation]`

SYGeoCoordinate *	coordinate `[implementation]`

NSString *	query `[implementation]`

Detailed Description

Represents an interface for a search request.

Method Documentation

◆ fillSdkRequest:isoVector:()

- (void) fillSdkRequest:	(sysearch_search_request_t &)	sdkRequest
isoVector:	(std::vector< const char * > &)	isoVector

implementation

◆ initWithQuery:location:()

- (nonnull instancetype) initWithQuery:	(nonnull NSString *)	query
location:	(nullable SYGeoCoordinate *)	coordinate

Creates a geocoder request that resolves a free text query.

Parameters

query	search query
coordinate	position to start search from

◆ initWithQuery:location:filter:()

- (nonnull instancetype) initWithQuery:	(nonnull NSString *)	query
location:	(nullable SYGeoCoordinate *)	coordinate
filter:	(nonnull SYGeoBoundingBox *)	box

Creates a geocoder request that resolves a free text query.

Parameters

query	search query
coordinate	position to start search from
box	geo bondary for filtering search results

Property Documentation

◆ box

- (SYGeoBoundingBox*) box

readwritenonatomicstrongimplementation

◆ coordinate

- (SYGeoCoordinate*) coordinate

readwritenonatomicstrongimplementation

◆ countryFilter

- (NSArray<NSString*>*) countryFilter

readwritenonatomicstrong

Array of country ISO codes. If set, only results from specified countries will be returned. Default value is nil, means searching in all countries.

◆ maxResultsCount

- (NSUInteger) maxResultsCount

readwritenonatomicassign

The maximum number of items in the response. Default value is 10.

◆ preferredLanguage

- (NSString*) preferredLanguage

readwritenonatomicstrong

NSString representing the preferred language for request responses. Default value is [[NSLocale preferredLanguages] objectAtIndex:0].

◆ query

- (NSString*) query

readwritenonatomiccopyimplementation

◆ resultTypeFilter

- (SYSearchResultTypeFilter) resultTypeFilter