SYSearchPlacesRequest Class Reference

Represents a request to retrieve a SYPlace objects. More...

#import <SYSearch.h>

Inheritance diagram for SYSearchPlacesRequest:
Collaboration diagram for SYSearchPlacesRequest:

Instance Methods

(nonnull instancetype) - initWithLocation:radius:tags:
 Creates a geocoder request. More...
 
(nonnull instancetype) - initWithBoundingBox:tags:
 Creates a geocoder request. More...
 
(void) - fillSdkRequest:tagsVector: [implementation]
 
(NSString *) - debugDescription [implementation]
 

Properties

NSUInteger maxResultsCount
 The maximum number of items in the response. Default value is 10. More...
 
NSArray< NSString * > * categoryTags
 See Place category SYPlaceCategory for values. More...
 
NSString * preferredLanguage
 NSString representing the preferred language for request responses. Default Value is [[NSLocale preferredLanguages] objectAtIndex:0]. More...
 
SYGeoCoordinatecoordinate [implementation]
 
SYGeoBoundingBoxbox [implementation]
 
SYDistance radius [implementation]
 

Detailed Description

Represents a request to retrieve a SYPlace objects.

Method Documentation

◆ debugDescription()

- (NSString*) debugDescription
implementation

◆ fillSdkRequest:tagsVector:()

- (void) fillSdkRequest: (sysearch_category_request_t &)  sdkRequest
tagsVector: (std::vector< const char * > &)  tagsVector 
implementation

◆ initWithBoundingBox:tags:()

- (nonnull instancetype) initWithBoundingBox: (nonnull SYGeoBoundingBox *)  box
tags: (nonnull NSArray< NSString * > *)  categoryTags 

Creates a geocoder request.

Parameters
boxwhere to search
categoryTagsSee Place category SYPlaceCategory for values

◆ initWithLocation:radius:tags:()

- (nonnull instancetype) initWithLocation: (nonnull SYGeoCoordinate *)  coordinate
radius: (SYDistance)  radius
tags: (nonnull NSArray< NSString * > *)  categoryTags 

Creates a geocoder request.

Parameters
coordinateposition to start search from
radiusmax search radius in meters
categoryTagsSee Place category SYPlaceCategory for values

Property Documentation

◆ box

- (SYGeoBoundingBox*) box
readwritenonatomicstrongimplementation

◆ categoryTags

- (NSArray<NSString*>*) categoryTags
readwritenonatomicstrong

See Place category SYPlaceCategory for values.

◆ coordinate

- (SYGeoCoordinate*) coordinate
readwritenonatomicstrongimplementation

◆ 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].

◆ radius

- (SYDistance) radius
readwritenonatomicassignimplementation

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