ArcGIS Runtime SDK for iOS: AGSLocatorTask.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSLocatorTask.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 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/AGSLoadableRemoteResourceBase.h>
27 #import <ArcGIS/AGSAPIKeyResource.h>
28 #import <ArcGIS/AGSCancelable.h>
29 
30 
31 
32 @class AGSLocatorInfo;
36 @class AGSSuggestResult;
37 @class AGSGeocodeResult;
38 @class AGSPoint;
39  //Required for Globals API doc
41 
52 
53 #pragma mark -
54 #pragma mark initializers
55 
56 
57 
63 -(instancetype)initWithURL:(NSURL*)URL;
64 
70 +(instancetype)locatorTaskWithURL:(NSURL*)URL;
71 
77 -(instancetype)initWithName:(NSString*)name;
78 
84 +(instancetype)locatorTaskWithName:(NSString*)name;
85 
86 #pragma mark -
87 #pragma mark properties
88 
93 @property (nullable, nonatomic, strong, readonly) AGSLocatorInfo *locatorInfo;
94 
95 #pragma mark -
96 #pragma mark methods
97 
104 -(id<AGSCancelable>)geocodeWithSearchText:(NSString *)searchText
105  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
106 
114 -(id<AGSCancelable>)geocodeWithSearchText:(NSString*)searchText
115  parameters:(AGSGeocodeParameters*)parameters
116  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
117 
124 -(id<AGSCancelable>)geocodeWithSuggestResult:(AGSSuggestResult*)suggestResult
125  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
126 
134 -(id<AGSCancelable>)geocodeWithSuggestResult:(AGSSuggestResult*)suggestResult
135  parameters:(AGSGeocodeParameters*)parameters
136  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
137 
144 -(id<AGSCancelable>)geocodeWithSearchValues:(NSDictionary<NSString*, NSString*> *)searchValues
145  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
146 
154 -(id<AGSCancelable>)geocodeWithSearchValues:(NSDictionary<NSString*, NSString*> *)searchValues
155  parameters:(AGSGeocodeParameters*)parameters
156  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
157 
164 -(id<AGSCancelable>)reverseGeocodeWithLocation:(AGSPoint*)location
165  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
166 
174 -(id<AGSCancelable>)reverseGeocodeWithLocation:(AGSPoint*)location
175  parameters:(AGSReverseGeocodeParameters*)parameters
176  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
177 
190 -(id<AGSCancelable>)suggestWithSearchText:(NSString*)searchText
191  completion:(void(^)(NSArray<AGSSuggestResult*> * __nullable suggestResults, NSError * __nullable error))completion;
192 
206 -(id<AGSCancelable>)suggestWithSearchText:(NSString*)searchText
207  parameters:(AGSSuggestParameters*)parameters
208  completion:(void(^)(NSArray<AGSSuggestResult*> * __nullable suggestResults, NSError * __nullable error))completion;
209 
210 @end
211 
212 
Parameters to refine gecoding results returned by AGSLocatorTask.
Definition: AGSGeocodeParameters.h:42
A match candidate returned from an AGSLocatorTask geocode or reverse geocode operation.
Definition: AGSGeocodeResult.h:43
Definition: AGSLoadableRemoteResourceBase.h:35
Metadata about the locator service or dataset used by AGSLocatorTask.
Definition: AGSLocatorInfo.h:40
A task to geocode and reverse-geocode addresses and places.
Definition: AGSLocatorTask.h:51
AGSLocatorInfo * locatorInfo
Definition: AGSLocatorTask.h:93
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73
Parameters to refine reverse-gecoding results returned by AGSLocatorTask.
Definition: AGSReverseGeocodeParameters.h:40
Input parameters for a suggest operation on AGSLocatorTask.
Definition: AGSSuggestParameters.h:40
Result of a suggest operation on AGSLocatorTask.
Definition: AGSSuggestResult.h:37
An interface for getting and setting the API key of an object.
Definition: AGSAPIKeyResource.h:36
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38