AGSReverseGeocodeParameters Class Reference

Description

Parameters to refine reverse-gecoding results returned by AGSLocatorTask.

Instances of this class represent input parameters to refine results of reverse-geocode operations on AGSLocatorTask

Since

100

See also

AGSLocatorInfo for metadata about the locator service or dataset used by AGSLocatorTask. The metadata contains information that can be used to set up these parameters.

Inheritance diagram for AGSReverseGeocodeParameters:

Class Methods
(instancetype)	+ reverseGeocodeParameters

Properties
NSArray< NSString * > *	featureTypes
BOOL	forStorage
double	maxDistance
NSInteger	maxResults
NSString *	outputLanguageCode
AGSSpatialReference *	outputSpatialReference
NSArray< NSString * > *	resultAttributeNames

Method Documentation

reverseGeocodeParameters

+ (instancetype) reverseGeocodeParameters

Property Documentation

featureTypes

- (NSArray<NSString*>*) featureTypes

readwritenonatomiccopy

Feature types used to filter the results of the reverse geocode operation.

Note

Currently only one feature type has any effect - specifying "intersection" causes the nearest street intersection to be returned.

Since

100

forStorage

- (BOOL) forStorage

readwritenonatomicassign

Specifies whether the results of the operation should be persisted. The default value is false, which indicates the results of the operation can't be stored, but they can be temporarily displayed on a map for instance. If you store the results in a database, for example, you need to set this parameter to true.

Applications are contractually prohibited from storing the results of geocoding transactions unless they perform the operation as an authenticated user. ArcGIS Online service credits are deducted from the organization account for each geocode transaction that uses this capability.

Since

100

maxDistance

- (double) maxDistance

readwritenonatomicassign

The maximum distance (in meters) from the given location within which a matching address will be searched. Defaults to 1000 meters.

Since

100

maxResults

- (NSInteger) maxResults

readwritenonatomicassign

The maximum number of results desired.

Since

100

outputLanguageCode

- (NSString*) outputLanguageCode

readwritenonatomiccopy

The language in which results should be returned. Based on the 2-digit ISO 639-1 language code.

Since

100

outputSpatialReference

- (AGSSpatialReference*) outputSpatialReference

readwritenonatomicstrong

The spatial reference in which result geometries should be returned.

Since

100

resultAttributeNames

- (NSArray<NSString*>*) resultAttributeNames

readwritenonatomiccopy

List of attributes to be returned for each geocoded result. The attributes available are specified by AGSLocatorInfo::resultAttributes and AGSLocatorInfo::intersectionResultAttributes. Use "*" to return all attributes.

Since

100