ArcGIS Runtime SDK for iOS: AGSSuggestParameters Class Reference
ArcGIS Runtime SDK for iOS  100.11
AGSSuggestParameters Class Reference

Description

Input parameters for a suggest operation on AGSLocatorTask.

Instances of this class represent input parameters for suggestWithSearchText:parameters:completion: (AGSLocatorTask)

Since
100
Inheritance diagram for AGSSuggestParameters:
AGSObject

Class Methods

(instancetype) + suggestParameters
 

Properties

NSArray< NSString * > * categories
 
NSString * countryCode
 
NSInteger maxResults
 
AGSPointpreferredSearchLocation
 
AGSGeometrysearchArea
 

Method Documentation

◆ suggestParameters

+ (instancetype) suggestParameters

Property Documentation

◆ categories

- (NSArray<NSString*>*) categories
readwritenonatomiccopy

Categories by which to filter suggestions. Categories represent address and place types, for example "city", "school", "Ski Resort". By default no category filtering is applied.

Since
100
See also
https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm

◆ countryCode

- (NSString*) countryCode
readwritenonatomiccopy

Country by which to filter suggestions. This can speed up the operation. Acceptable values include the full country name in English or the official language of the country, the ISO 3166-1 2-digit country code, or the ISO 3166-1 3-digit country code.

Since
100
See also
https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm

◆ maxResults

- (NSInteger) maxResults
readwritenonatomicassign

The maximum number of suggestions required.

Since
100

◆ preferredSearchLocation

- (AGSPoint*) preferredSearchLocation
readwritenonatomicstrong

The location by which to prioritize/order suggestions. Suggestions that fall within a 50 KM buffer of this location are boosted in rank so that they show up higher in the list, but others further away are still included. To exclude suggestions based on a region, use searchArea instead. The preferred search location is only intended to influence the sort order so that the most locationally-relevant candidates are returned first.

Since
100

◆ searchArea

- (AGSGeometry*) searchArea
readwritenonatomicstrong

The search area used to spatially filter the suggestions. Only suggestions that lie within this area are included.

Since
100