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

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

Detailed Description

Represents a request to retrieve a SYPlace objects.

Method Documentation

◆ 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

◆ 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

Property Documentation

◆ maxResultsCount

- (NSUInteger) maxResultsCount
readwritenonatomicassign

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

◆ categoryTags

- (NSArray<NSString*>*) categoryTags
readwritenonatomicstrong

See Place category SYPlaceCategory for values.

◆ preferredLanguage

- (NSString*) preferredLanguage
readwritenonatomicstrong

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


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