ArcGIS Runtime SDK for iOS: AGSLocatorTask.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSLocatorTask.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/AGSLoadableRemoteResourceBase.h>
27 #import <ArcGIS/AGSAPIKeyResource.h>
28 
29 
30 
31 @class AGSLocatorInfo;
35 @class AGSSuggestResult;
36 @class AGSGeocodeResult;
37 @class AGSPoint;
38 
39 @protocol AGSCancelable;
40  //Required for Globals API doc
42 
53 
54 #pragma mark -
55 #pragma mark initializers
56 
57 
58 
64 -(instancetype)initWithURL:(NSURL*)URL;
65 
71 +(instancetype)locatorTaskWithURL:(NSURL*)URL;
72 
78 -(instancetype)initWithName:(NSString*)name;
79 
85 +(instancetype)locatorTaskWithName:(NSString*)name;
86 
87 #pragma mark -
88 #pragma mark properties
89 
94 @property (nullable, nonatomic, strong, readonly) AGSLocatorInfo *locatorInfo;
95 
96 #pragma mark -
97 #pragma mark methods
98 
105 -(id<AGSCancelable>)geocodeWithSearchText:(NSString *)searchText
106  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
107 
115 -(id<AGSCancelable>)geocodeWithSearchText:(NSString*)searchText
116  parameters:(AGSGeocodeParameters*)parameters
117  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
118 
125 -(id<AGSCancelable>)geocodeWithSuggestResult:(AGSSuggestResult*)suggestResult
126  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
127 
135 -(id<AGSCancelable>)geocodeWithSuggestResult:(AGSSuggestResult*)suggestResult
136  parameters:(AGSGeocodeParameters*)parameters
137  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
138 
145 -(id<AGSCancelable>)geocodeWithSearchValues:(NSDictionary<NSString*, NSString*> *)searchValues
146  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
147 
155 -(id<AGSCancelable>)geocodeWithSearchValues:(NSDictionary<NSString*, NSString*> *)searchValues
156  parameters:(AGSGeocodeParameters*)parameters
157  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
158 
165 -(id<AGSCancelable>)reverseGeocodeWithLocation:(AGSPoint*)location
166  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
167 
175 -(id<AGSCancelable>)reverseGeocodeWithLocation:(AGSPoint*)location
176  parameters:(AGSReverseGeocodeParameters*)parameters
177  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;
178 
191 -(id<AGSCancelable>)suggestWithSearchText:(NSString*)searchText
192  completion:(void(^)(NSArray<AGSSuggestResult*> * __nullable suggestResults, NSError * __nullable error))completion;
193 
207 -(id<AGSCancelable>)suggestWithSearchText:(NSString*)searchText
208  parameters:(AGSSuggestParameters*)parameters
209  completion:(void(^)(NSArray<AGSSuggestResult*> * __nullable suggestResults, NSError * __nullable error))completion;
210 
211 @end
212 
213 
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:52
AGSLocatorInfo * locatorInfo
Definition: AGSLocatorTask.h:94
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