ArcGIS Runtime SDK for iOS: AGSGeocodeParameters.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSGeocodeParameters.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSObject.h>
27 
28 @class AGSSpatialReference;
29 @class AGSPoint;
30 @class AGSGeometry;
31  //Required for Globals API doc
33 
42 
43 
44 #pragma mark -
45 #pragma mark initializers
46 
47 +(instancetype)geocodeParameters;
48 
49 #pragma mark -
50 #pragma mark properties
51 
56 @property (nonatomic, copy, readwrite) NSArray<NSString*> *resultAttributeNames;
57 
62 @property (nonatomic, copy, readwrite) NSArray<NSString*> *categories;
63 
69 @property (nonatomic, copy, readwrite) NSString *countryCode;
70 
76 @property (nonatomic, assign, readwrite) BOOL forStorage;
77 
82 @property (nonatomic, assign, readwrite) NSInteger maxResults;
83 
88 @property (nonatomic, assign, readwrite) double minScore;
89 
94 @property (nonatomic, copy, readwrite) NSString *outputLanguageCode;
95 
99 @property (nullable, nonatomic, strong, readwrite) AGSSpatialReference *outputSpatialReference;
100 
104 @property (nullable, nonatomic, strong, readwrite) AGSPoint *preferredSearchLocation;
105 
109 @property (nullable, nonatomic, strong, readwrite) AGSGeometry *searchArea;
110 
111 
112 @end
Parameters to refine gecoding results returned by AGSLocatorTask.
Definition: AGSGeocodeParameters.h:42
NSString * countryCode
Definition: AGSGeocodeParameters.h:69
AGSSpatialReference * outputSpatialReference
Definition: AGSGeocodeParameters.h:99
NSInteger maxResults
Definition: AGSGeocodeParameters.h:82
NSString * outputLanguageCode
Definition: AGSGeocodeParameters.h:94
double minScore
Definition: AGSGeocodeParameters.h:88
AGSGeometry * searchArea
Definition: AGSGeocodeParameters.h:109
AGSPoint * preferredSearchLocation
Definition: AGSGeocodeParameters.h:104
NSArray< NSString * > * categories
Definition: AGSGeocodeParameters.h:62
BOOL forStorage
Definition: AGSGeocodeParameters.h:76
instancetype geocodeParameters()
NSArray< NSString * > * resultAttributeNames
Definition: AGSGeocodeParameters.h:56
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
Definition: AGSObject.h:28
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:46